diff options
| -rw-r--r-- | INSTALL | 39 | ||||
| -rw-r--r-- | README | 72 | ||||
| -rw-r--r-- | README-FOR-THE-LAZY | 82 |
3 files changed, 185 insertions, 8 deletions
@@ -1,4 +1,10 @@ +The Osirion Project - INSTALL + + These are the installation instructions for the Osirion Project. + A description of theproject and general usage information can be + found in the README file. + Installation To build the Osirion Project from source code you will need @@ -43,6 +49,39 @@ Installing game data svn checkout svn://intranifty.no-ip.org/osirion-data data +Installing gtkradiant 1.5.0 support files (optional) + + You only need to install these files if you want to create models + with gtkradiant. Note that these files where made for + gtkradiant 1.5.0, I have not tested the with any other version. + You can find precompiled gtkradiant 1.5.0 binaries for linux at + http://ingar.soliter.org. + + These instructions assume gtkradiant is installed in the directory + '/usr/local/games/gtkradiant-1.5.0'. If it is installed in a different + directory on your system, edit these instructions accordingly. + + Copy the support files to the gtkradiant folder: + + cd data + cd gtkradiant + cp -vr * /usr/local/games/gtkradiant-1.5.0 + + Open the file '/usr/local/games/gtkradiant-1.5.0/games/osirion.game' in + your favourite editor. Look for a line that begins with: + + enginepath_linux=" + + Make sure it points to your osirion data directory. For example, + if you checked out the source code in '/home/user/games/osirion', + then the data will be in '/home/user/games/osirion/data' and + the line should look like this: + + enginepath_linux="/home/user/games/osirion/data" + + Save the changes. + + Executing To run the client program, execute: @@ -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> - diff --git a/README-FOR-THE-LAZY b/README-FOR-THE-LAZY new file mode 100644 index 0000000..9238510 --- /dev/null +++ b/README-FOR-THE-LAZY @@ -0,0 +1,82 @@ + +The Osirion Project - README FOR THE LAZY + + So? You're the lazy type? + I'll just assume you know what a directory is. + +HOW TO install the game: + + OSIRION="`pwd`/osirion" + + svn checkout svn://intranifty.no-ip.org/osirion + cd osirion/ + autoreconf -fi + ./configure + make + + svn checkout svn://intranifty.no-ip.org/osirion-data data + +HOW TO run the game: + + cd $OSIRION + src/osrion + +** The console keys is ~ or `. Keyboard is probably broken on + non-qwerty layouts. + + cl_name SpaceCowboy + cl_color 1 1 0 + connect + join + spectate + buy + buy sharkan + +** Numeric keypad keys steer left or right, keypad + and - + change thrust. Spacebar changes camera mode. Cursors keys + change the camera view. + + quit + +HOW TO run a dedicated server: + + cd $OSIRION + src/osiriond + +HOW TO connect to a dedicated server: + + cl_name SpaceCowboy + cl_color 1 1 0 + connect remote.server.net + say Hi, I am connected to the server! + +** The 'T' button opens the chat window, no need to type 'say' + in the console all the time + +HOW TO go fullscreen or change resolution: + + r_width 1280 + r_height 960 + r_fullscreen 1 + r_restart + +HOW TO find more information without reading the documentation: + + list_ent + list_func + list_var + list_model + list_ship + + ls $OSIRION/data/base + vim $OSIRION/data/base/ini/world.ini + vim $OSIRION/data/base/ini/ships.ini + +It fails! + + rm -rf $OSIRION + goto 10 + +It still fails! + + Seriously, read the README and INSTALL files. |