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-02-06 20:05:10 +0000
committerStijn Buys <ingar@osirion.org>2008-02-06 20:05:10 +0000
commit884667848ecf043dd2d8c5421250c88931151bd1 (patch)
tree711544a3d4a9e16ae260b4131b6da1c9f0fdb7c2
parent15ca94f41b77cdf439774fe1e6502979be9d3f8e (diff)
Documentation updates
-rw-r--r--INSTALL83
-rw-r--r--README61
-rw-r--r--ROADMAP9
-rw-r--r--TODO5
4 files changed, 126 insertions, 32 deletions
diff --git a/INSTALL b/INSTALL
index 1ee3364..62061b3 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,29 +1,76 @@
-Basic Installation
-==================
-To build the Osirion Project from source you will need
-the SDL and OpenGL library and header files.
+Installation
-In theory, it should compile on any platform supported by SDL.
-I have succesfully compiled it on the following platforms:
- linux-x86_64, gcc 4.1.2, SDL 1.2.11
- mingw-win32 (client only!)
+ To build the Osirion Project from source code you will need
+ the SDL and OpenGL library and header files.
-Compile the source by executing the following commands:
+ In theory, it should compile on any platform supported by SDL,
+ but at the time of writing only linux is supported.
- autoreconf -fi
- ./configure
- make
+ I have succesfully compiled it on the following platforms:
+ linux-x86_64, gcc 4.1.2, SDL 1.2.11
-To run the client program, execute:
+Obtaining the source code
- src/osirion
+ Get the latest version of the source code from svn:
-To run the dedicated server, execute:
+ svn checkout svn://intranifty.no-ip.org/osirion
- src/osiriond
+ This command will create a new subdirectory 'osirion'
+ and download the source code into it.
-The game data files should be located in the subdirectory
-data/base of the main distribution.
+Compilint the source code
+ Enter the new directory and compile the source code:
+
+ cd osirion/
+ autoreconf -fi
+ ./configure
+ make
+
+ At present, 'make install' is neither tested nor supported
+
+Game Data
+
+ The game data should be located in the 'data'
+ subdirectory of the main distribution.
+
+ Get the latest version of the game data from svn:
+ Run the following command from within the main
+ distribution directory:
+
+ svn checkout svn://intranifty.no-ip.org/osirion-data data
+
+Executing
+
+ To run the client program, execute:
+
+ src/osirion
+
+ To run the dedicated server, execute:
+
+ src/osiriond
+
+Updating
+
+ If you downloaded and compiled the game before,
+ there is no need to re-download the entire distribution.
+
+ Update the game source code with the following commands:
+
+ cd osirion/
+ make distclean
+ svn update
+
+ Rebuild the game:
+
+ autoreconf -fi
+ ./configure
+ make
+
+ Update the game data:
+
+ cd data/
+ svn update
+ cd ..
diff --git a/README b/README
index 0b6a919..764118b 100644
--- a/README
+++ b/README
@@ -1,34 +1,75 @@
-Project::OSiRiON
+The Osirion Project
- This is the Osirion project. I wrote it to get a better grasp on OpenGL
- and to get some C++ practice. Maybe someday, it will be a real game.
+ 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 Installation instructions.
+ Read INSTALL for instructions on building and installation.
+
+Dedicated server
+
+ The dedicated server can be started, but it does not yet
+ support network connections or local input.
+
+Client
+
+ Starting the client will show the loader screen.
+ To start the game, open the client console and type 'connect'.
+ Type 'disconnect' to return to the loader screen.
Controls
- space bar: switch camera between free mode and tracking mode
+ ~: toggle client console visibility
+ 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 thrust
+Console functions
+
+ The following commands are available on the console:
+
+ connect connect the client to the game module
+ disconnect disconnect the client from the game module
+ list_func lists registered functions
+ list_var lists registered variables
+ quit exit the application
+ r_restart restart the video subsystem
+
+ 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:
+
+ r_width 1024
+ r_height 768
+ r_restart
+
+ To switch to windowed mode, set the r_fullscreen
+ variable to 0:
+
+ r_fullscreen 0
+ r_restart
+
Organization of the distribution
src/ C++ source code
math\ mathematical classes
sys\ low-level system functions
- filesystem\ virtual filesystem
- core\ game-independent core classes
+ filesystem\ virtual filesystem library
+ core\ game-independent core library
game\ game-specific functions
server\ osiriond dedicated server
- gl\ OpenGL wrapper library
+ render\ render library
client\ osirion client
data/ Data files
- base\ main data files
-
+ base\ base data files
+
+ The game data can be obtained as a seperate distribution.
+ Refer to the file INSTALLATION for more information.
+
License
The program is distributed under the terms and conditions of the
diff --git a/ROADMAP b/ROADMAP
index 49e560f..8855011 100644
--- a/ROADMAP
+++ b/ROADMAP
@@ -1,11 +1,16 @@
SUBSYSTEMS
-
+
+filesystem::
+ write vfile and vpath implementation
+ handles file reading/loading
+
core::
Cvar
Func
CommandBuffer
Entity
seperate client:: and game::
+ Cvar/Func info text
network::
connections
@@ -49,4 +54,4 @@ Requires:
* VERSION 0.5
- The game is ready to add data. \ No newline at end of file
+ The game is ready to add data.
diff --git a/TODO b/TODO
index 0f09bb0..c62f1df 100644
--- a/TODO
+++ b/TODO
@@ -1,4 +1,5 @@
-
* Fix win32 issues
server/timer.h
- server/tmer.cc \ No newline at end of file
+ server/tmer.cc
+ sys/sys.cc
+