diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 72 |
1 files changed, 64 insertions, 8 deletions
@@ -1,11 +1,11 @@ -The Osirion Project +The Osirion Project - README This is the Osirion project. I wrote it to get a better grasp on game design with opengl and to get some C++ practice. Maybe someday, it will be a real game. - Read INSTALL for instructions on building and installing. + Read INSTALL for instructions on building, installing and udpating. Dedicated server @@ -20,19 +20,23 @@ 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'. + This wil allow remote players to connect to your client. + + To connect to a dedicated server, type 'connect address', where + adress is the hostname of IP address of the remote server. + + In-game, you can purchase a new ship with the 'buy' command. -Controls +Keyboard ~: toggle console space bar: switch camera mode left/right/up/down arrow keys: rotate camera in free mode keypad left/right: turn the ship left/right keypad +/-: increase/decrease forward thruster + T: open the chat window Console functions @@ -51,7 +55,7 @@ Console functions join join the game spectate spectate - buy switch your ship for a new one + buy purchase a new ship To change the video resolution, set the r_width and r_height variables and execute r_restart. @@ -97,13 +101,64 @@ Organization of the distribution /data /base game data files /bitmaps essential bitmaps + /ini ini files /maps .map models + /ships spaceships + /stations space stations /textures textures /gtkradiant gtkradiant support files The game data can be obtained as a seperate distribution. Refer to the file INSTALLATION for more information. +Editing game parameters + + One of the goals of the Osirion Project, is to create an engine + that makes it very easy to extend the game. At this moment, the + game reads the world description from ini/world.ini and a list of + buyable ships from ini/ships.ini. + + I recommend not to edit the original game data, but to make a copy + in your personal osirion folder '~/.osirion'. This directory mimics + the directory structure of the 'data' directory but any file found + in the personal diretory will get precedence over the corresponding + file in the game data directory. + +Adding models + + The models are basic Quake2 style .map files with custom entities + and can be created with a program like gtkradiant. No map compiler is + necessary, the engine reads the files directly. Refer to the file + INSTALL on how to install the support files for gtkradiant 1.5.0. + + The textures in the textures/colors/ directory are mapped to RGB colors + when the models are loaded, any real texturing information is ignored. + Unknown textures will be colored hot pink in-game. + + Two special textures are supported: any brush faces textures with + common/caulk will be ignored by the engine, similar to the caulk + feature in quake-like engines. Brush faces with the common/entity + texture will get the current game entity color. This makes it possible + to use the current player color on ship models. + + Add an info_engine entity to add an engine exhaust to the ship model. + +Notes + + The built-in TGA reader is rather limited. When saving TGA files with + the Gimp, make sure to disable the option "origion at bottom left". + + At the moment, the only TGA files in the game are bitmaps/conchars.tga + and bitmaps/loader.tga + +Project contributors + + Thorn[mDc] - Ship models + +IRC + + The official Osirion irc channel is #osirion on irc.soliter.org + Acknowledgements This project could not have been possible without the work of others: @@ -118,6 +173,8 @@ Acknowledgements The Satgnu crew Thanks to bobke, blaze-x and Thorn[mDc] + + DVSoftware for bandwidth, diskpace and CPU power A special thanks to all =KCT= members @@ -128,4 +185,3 @@ License Copyright 2007-2008 Ingar=KCT= <ingar@telenet.be> - |