Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
path: root/base/help
diff options
context:
space:
mode:
Diffstat (limited to 'base/help')
-rw-r--r--base/help/about.txt20
-rw-r--r--base/help/client.txt27
-rw-r--r--base/help/engine.txt16
-rw-r--r--base/help/help.txt13
-rw-r--r--base/help/stats.txt13
5 files changed, 89 insertions, 0 deletions
diff --git a/base/help/about.txt b/base/help/about.txt
new file mode 100644
index 0000000..5eeef4c
--- /dev/null
+++ b/base/help/about.txt
@@ -0,0 +1,20 @@
+
+^BAbout
+
+ This is The Osirion Project.
+
+ Programming and game content:
+ ^BIngar ^N<^Bingar@telenet.be^N>
+
+ Contributions:
+ ^BThorn ^BJosky
+
+ Thanks to:
+ ^BGareth Minisori DVSoftware
+
+ This game is released under the terms and conditions
+ of the General Public license version 2.
+
+ Visit the Osirion IRC channel
+ ^B#osirion irc.soliter.org
+
diff --git a/base/help/client.txt b/base/help/client.txt
new file mode 100644
index 0000000..0d99387
--- /dev/null
+++ b/base/help/client.txt
@@ -0,0 +1,27 @@
+
+^BHelp - Client configuration
+
+ The client configuration can be done through a number of variables.
+
+ r_width and r_height control the video resolution. To apply the new
+ settings, you will have to restart the renderer with the r_restart
+ command. Fullscreen mode can be set through the r_fullscreen variable:
+
+ ^Br_fullscreen 1
+ ^Br_width 1024
+ ^Br_height 768
+ ^Br_restart
+
+ The maximum client framerate can be set with the cl_framerate variable.
+ To draw the current framerate and a few other statistics, set the
+ draw_stats variable to 1.
+
+ ^Bcl_framerate 125
+ ^Bdraw_stats 1
+
+ A few render options are available as well, mostly for debugging purposes:
+
+ ^Br_bbox^N Draw model bounding boxes
+ ^Br_radius^N Draw a globe around each entity, representing its radius
+ ^Br_wireframe^N Draw wireframe models
+
diff --git a/base/help/engine.txt b/base/help/engine.txt
new file mode 100644
index 0000000..bfd7a48
--- /dev/null
+++ b/base/help/engine.txt
@@ -0,0 +1,16 @@
+
+^BHelp - Engine features
+
+ You can explore the available features using the following commands:
+
+ ^Blist_func^N Lists available engine functions
+ ^Blist_var^N Lists available configuration variables
+
+ Most of the functions and variables have a short description of
+ their own.
+
+ You can also get some information on the internal state:
+
+ ^Blist_ent^N List entities
+ ^Blist_model^N List models
+
diff --git a/base/help/help.txt b/base/help/help.txt
new file mode 100644
index 0000000..8c578ef
--- /dev/null
+++ b/base/help/help.txt
@@ -0,0 +1,13 @@
+
+^BHelp
+
+ This is the build-in help for the Osirion Project.
+ Available topics:
+
+ ^Bhelp engine^N Engine features
+ ^Bhelp client^N Client configuration
+ ^Bhelp stats^N Statistics
+ ^Bhelp server^N Server configuration
+
+ ^Bhelp about^N About the project
+
diff --git a/base/help/stats.txt b/base/help/stats.txt
new file mode 100644
index 0000000..11b4762
--- /dev/null
+++ b/base/help/stats.txt
@@ -0,0 +1,13 @@
+
+^BHelp - Statistics
+
+Setting the draw_stats variable to 1 will draw a few statistics
+on the right side of the screen.
+
+ ^Bfps^N Current framerate, in frames per second
+ ^Btris^N The number oftriangles curently beeing drawn
+ ^Bquads^N The number of rectangles currently beeing drawn
+
+ ^Btx^N Total network upload, in kilobytes
+ ^Brx^N Total network download, in kilobytes
+