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-29 11:23:16 +0000
committerStijn Buys <ingar@osirion.org>2008-03-29 11:23:16 +0000
commit49e268d1b4244948e49a11612501a743e311fbaf (patch)
tree58280d24af8d2f385bdc6819f185fda0a0496e94
parentec749a67a8dac87dc01421fc74fa9ee8ec6a6164 (diff)
documentation updates
-rw-r--r--INSTALL26
-rw-r--r--README18
2 files changed, 36 insertions, 8 deletions
diff --git a/INSTALL b/INSTALL
index bb14b1c..a459df3 100644
--- a/INSTALL
+++ b/INSTALL
@@ -10,15 +10,33 @@ Installation
To build the Osirion Project from source code you will need
the SDL and OpenGL library and header files.
- In theory, it should compile on any POSIX-compatible platform
- supported by SDL, but at the time of writing only linux is
- supported. Support for the win32 platform is under development.
-
I have succesfully compiled it on the following platforms:
linux-x86_64 gcc 4.1.2
linux-i686 gcc 4.1.2
mingw32 gcc 4.2.2
+ In theory, it should compile on any POSIX-compatible platform
+ supported by SDL, reports for other platforms (working or not)
+ are welcome.
+
+Compilation on windows32
+
+ If you downloaded the zip file containing the windows32
+ exe files, all the hard work has already been done and the
+ game is ready to run. If you want to build your own exe files,
+ keep on reading.
+
+ You can use maci's excellent mingw/msys package to install
+ a development environment on windows. You can find the
+ installer here:
+
+ http://satgnu.net/maci/files/q2wdevenv.exe
+
+ You can use the Turtoisesvn SubVersion client to access the
+ SVN repositories. You can download it from
+
+ http://tortoisesvn.tigris.org/
+
Obtaining the source code
Get the latest version of the source code from svn:
diff --git a/README b/README
index e19101a..f167aa8 100644
--- a/README
+++ b/README
@@ -3,9 +3,9 @@ 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.
+ Maybe someday it will be a real game.
- Read INSTALL for instructions on building, installing and udpating.
+ Read INSTALL for instructions on building, installing and updating.
Client
@@ -73,8 +73,8 @@ Console functions
r_restart
You can set your name and player color through the cl_color
- and cl_name variables. Note that the color if your ship
- won't change until you buy a new one.
+ and cl_name variables. Note that your ship's colour won't
+ change until you buy a new one.
cl_name SpaceCowboy
cl_color 1.0 1.0 0.0
@@ -97,6 +97,16 @@ Dedicated server
the server's actual IP address. The default listening port can
be altered by changing the net_port setting.
+Note for windows32 users
+
+ On windows32, the game uses the 'home' subdirectory as your personal
+ directory. For example, the client.ini can be found in
+ home\base\client.ini.
+
+ There is also a problem that prevents the game from creating directories.
+ If you need any subdirectories in your personal folder, like 'screenshots',
+ you will have to create it manually.
+
Organization of the distribution
C++ source code