Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual.html')
-rw-r--r--doc/manual.html97
1 files changed, 92 insertions, 5 deletions
diff --git a/doc/manual.html b/doc/manual.html
index f89cdca..df74842 100644
--- a/doc/manual.html
+++ b/doc/manual.html
@@ -85,18 +85,102 @@
sv_name osirion server [string] server name
</pre>
<p>
- TODO: variable flags A=Archive G=Game R=ReadOnly
+ To change the value of a variable, type its name and the new value on the console
+ followed by <b>enter</b>. The console will show the new value:
</p>
+<pre class="code">
+>sv_name My Osirion Server
+ sv_name My Osirion Server [string] server name
+</pre>
+<p>
+ Some variables have special flags, as shown in the first column of the output
+ of the <span class="fixed">list_var</span> function.
+ <dl>
+ <dt>Archive</dt>
+ <dd>The value of this variable will automaticly be saved on exit</dd>
+ <dt>Game</dt>
+ <dd>This variable is a game setting</dd>
+ <dt>ReadOnly<dt>
+ <dd>The value of this variable can not be changed</dd>
+ </dl>
+</p><p>
+ On exit, both the client and the server will save variables with
+ the Archive flag to their config file, <span class="fixed">client.cfg</span> or <span class="fixed">server.cfg</span>.
+ Variables with the Game flag set will be saved to the file <span class="fixed">game.cfg</span>.
+ If you run into trouble, you can delete these files to restore the default values.
+<p>
+ On Linux and other UNIX-like systems you can find these files in the directory <span class="fixed">~/.osirion/base</span>.
+</p><p>
+ On windows you can find these files in <span class="fixed">My Documents/My Games/Osirion/base</span>.
<p>
- TODO: changing variable value
-</p>
</div>
<div class="subtitle">
Functions
</div>
<div class="text">
- TODO Concerning commands
+<p>
+ Besides variables, the engine also support functions that can be executed. These are commands
+ that can be typed into the console that will trigger some kind of response.
+</p><p>
+ In the previous section we had already met the <span class="fixed">list_var</span> function,
+ which will print a list of available variables to the console. Similar, the
+ <span class="fixed">list_var</span> function, wich will print a list of available functions:
+</p>
+<pre class="code">
+>list_func
+ bind [key] [str] bind a command to a key
+ connect [ip] without ip, create a game
+ disconnect leave the current game
+ G intro [int] view specified introduction
+ .
+ .
+ .
+ view_next switch to next view
+ view_prev switch to previous view
+ S who get a list of connected players
+Flags: G=Game S=Shared
+ 61 registered functions
+</pre>
+<p>
+ Type a function's name into the console followed by <b>enter</b> to execute it. Some functions
+ require aditional parameters to work currectly.
+</p><p>
+
+ Like variables, functions can have special flags that indicates their type:
+ <dl>
+ <dt>Game</dt>
+ <dd>This is a game function and can only be executed by players. These functions
+ are used to interact with the game and includes commands like
+ <span class="fixed">buy</span> and <span class="fixed">trade</span>.
+ </dd>
+ <dt>Shared</dt>
+ <dd>These functions can be executed by both players and server administrators.</dd>
+ </dl><dl>
+ <dt></dt>
+ <dd>Functions without flags can only be executed through the local console.</dd>
+ </dl>
+</p><p>
+ To understand the flow of commands we illustrate three different situations:
+ <dl>
+ <dt>Playing a local game</dt>
+ <dd>In this case you're not connected to a remote server but are, in fact,
+ running your own, private server. You're both the player and the server administrator
+ and you'll be able to execute any function.</dd>
+ <dt>Playing on a remote server</dt>
+ <dd>If you're connected to a remote server and you execute a function, the engine will
+ first check if the function exists locally. The function you want to execute
+ could be client releated, like <span class="fixed">screenshot</span>. Only functions
+ without flags can be executed this way. If the function does not exist, the engine will
+ send the command to the remote server. The remote server will check if the functions
+ exists and has the game flag set. If this is the case, the function will get executed
+ on the server.</dd>
+ <dt>Running a dedicated server</dt>
+ <dd>If you're using the dedicated server's command console, you can only execute
+ functions with the Shared flag set, and functions without the Game flag set. It doesn't
+ make sense or administrators to execute game functions, since they do not participate
+ as players in the game.</dd>
+</p>
</div>
<div class="subtitle">
@@ -111,7 +195,10 @@
Client
</div>
<div class="text">
- <div class="rfloater"><img src="images/client_console.png" alt=""></div>
+ <div class="rfloater">
+ <img src="images/client_console.png" alt=""><br>
+ Client console
+ </div>
<p>
Starting the client will show the loader screen and open
the client console. The console will stay open until you are connected