Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStijn Buys <ingar@osirion.org>2008-03-03 17:49:49 +0000
committerStijn Buys <ingar@osirion.org>2008-03-03 17:49:49 +0000
commit75e52044c47d39d20c98e2cdc284a41d1974346a (patch)
tree51ec1af1821d50be399fe1e5c4a527178b738f5a
parentb0af6f8e14449e8bd49efe94da1041628a549120 (diff)
documentation update
-rw-r--r--README51
1 files changed, 34 insertions, 17 deletions
diff --git a/README b/README
index 7364de7..c948b13 100644
--- a/README
+++ b/README
@@ -10,8 +10,8 @@ The Osirion Project
Dedicated server
The dedicated server will accept incoming connections on port 8042.
+ There is no server console.
-
Client
Starting the client will show the loader screen.
@@ -20,9 +20,11 @@ Client
to join the game. Type 'spectate' to spectate again.
Type 'disconnect' to return to the loader screen.
+ While joined, you can exchange your ship for a new one with
+ the 'buy' command.
+
The client is capable of acting as a networked server. You can enable
- the private server by setting 'sv_private 1' before you 'connect'. If
- you telnet to the private server and type 'join' new ship will appear.
+ the private server by setting 'sv_private 1' before you 'connect'.
Controls
@@ -31,7 +33,7 @@ Controls
left/right/up/down arrow keys: rotate camera in free mode
keypad left/right: turn the ship left/right
keypad +/-: increase/decrease forward thruster
-
+
Console functions
The following commands are available on the console:
@@ -40,10 +42,17 @@ Console functions
disconnect disconnect the client from the game module
list_ent list registered entities
list_func list registered functions
+ list_model list regsitered models
list_var list registered variables
quit exit the application
r_restart restart the video subsystem
+ The following commands are available when connected to a game:
+
+ join join the game
+ spectate spectate
+ buy switch your ship for a new one
+
To change the video resolution, set the r_width and
r_height variables and execute r_restart.
e.g.: to set the video mode to 1024x768 type:
@@ -66,23 +75,31 @@ Console functions
cl_color 1.0 1.0 0.0
connect
- When you quit the application. all custom settings are.
-
+ Settings are saved when you quit the application.
+
Organization of the distribution
- src/ C++ source code
+ C++ source code
+
+ /src
+
+ /math mathematical classes
+ /sys low-level system functions
+ /filesystem virtual filesystem library
+ /core game-independent core library
+ /game game-specific functions
+ /server osiriond dedicated server
+ /render render library
+ /client osirion client
- math\ mathematical classes
- sys\ low-level system functions
- filesystem\ virtual filesystem library
- core\ game-independent core library
- game\ game-specific functions
- server\ osiriond dedicated server
- render\ render library
- client\ osirion client
+ Data files
- data/ Data files
- base\ base data files
+ /data
+ /base game data files
+ /bitmaps essential bitmaps
+ /maps .map models
+ /textures textures
+ /gtkradiant gtkradiant support files
The game data can be obtained as a seperate distribution.
Refer to the file INSTALLATION for more information.