Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README45
1 files changed, 29 insertions, 16 deletions
diff --git a/README b/README
index 570daa5..6610a90 100644
--- a/README
+++ b/README
@@ -2,15 +2,15 @@
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.
+ game design with OpenGL and to get some C++ practice.
Maybe someday, it will be a real game.
Read INSTALL for instructions on building, installing and udpating.
Dedicated server
- The dedicated server will accept incoming connections on port 8042.
- There is no server console.
+ By default, the dedicated server will accept incoming connections
+ on UDP port 8042. There is no server console.
Client
@@ -79,7 +79,12 @@ Console functions
cl_color 1.0 1.0 0.0
connect
- Settings are saved when you quit the application.
+Configuration
+
+ Variables marked with the 'A' flag will be archived, their value
+ will be written to the configuration file on exit. The dedicated
+ server reads its configuration from server.ini, the client
+ will use client.ini.
Organization of the distribution
@@ -103,6 +108,7 @@ Organization of the distribution
/bitmaps essential bitmaps
/ini ini files
/maps .map models
+ /satellites sattelites
/ships spaceships
/stations space stations
/textures textures
@@ -111,24 +117,24 @@ Organization of the distribution
The game data can be obtained as a seperate distribution.
Refer to the file INSTALLATION for more information.
-Editing game parameters
+Editing game data
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.
+ that makes it very easy to adapt and extend the game world.
+ At the 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.
+ I recommend you do not edit the original game data, but to make a copy
+ into your personal osirion folder '~/.osirion'. This directory mimics
+ the directory structure of the 'data' directory and any file found
+ there 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
+ necessary, the engine reads the .map 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
@@ -141,7 +147,7 @@ Adding models
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.
+ Add an info_engine entity to add an engine exhaust to a ship model.
Notes
@@ -153,12 +159,19 @@ Notes
Project contributors
- Thorn[mDc] - Ship models
+ Thorn[mDc] - Canasta and Sharkan ship models
+ Alpha testing
+ Josky=KCT= - Shuttle ship model
IRC
The official Osirion IRC channel is #osirion on irc.soliter.org
+Web
+
+ Screenshots can be found at
+ http://ingar.soliter.org/screenshots/osirion
+
Acknowledgements
This project could not have been possible without the work of others: