From 072ca3b59474a5a923009168be0d854fe8afd3ae Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Sun, 7 Nov 2010 16:58:46 +0000 Subject: updated documentation, expanded user manual removed unnecessary subdirectories --- doc/manual.html | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 92 insertions(+), 5 deletions(-) (limited to 'doc/manual.html') 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

- 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 enter. The console will show the new value:

+
+>sv_name My Osirion Server
+  sv_name My Osirion Server [string] server name
+
+

+ Some variables have special flags, as shown in the first column of the output + of the list_var function. +

+
Archive
+
The value of this variable will automaticly be saved on exit
+
Game
+
This variable is a game setting
+
ReadOnly
+
The value of this variable can not be changed
+
+

+ On exit, both the client and the server will save variables with + the Archive flag to their config file, client.cfg or server.cfg. + Variables with the Game flag set will be saved to the file game.cfg. + If you run into trouble, you can delete these files to restore the default values. +

+ On Linux and other UNIX-like systems you can find these files in the directory ~/.osirion/base. +

+ On windows you can find these files in My Documents/My Games/Osirion/base.

- TODO: changing variable value -

Functions
- TODO Concerning commands +

+ 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. +

+ In the previous section we had already met the list_var function, + which will print a list of available variables to the console. Similar, the + list_var function, wich will print a list of available functions: +

+
+>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
+
+

+ Type a function's name into the console followed by enter to execute it. Some functions + require aditional parameters to work currectly. +

+ + Like variables, functions can have special flags that indicates their type: +

+
Game
+
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 + buy and trade. +
+
Shared
+
These functions can be executed by both players and server administrators.
+
+
+
Functions without flags can only be executed through the local console.
+
+

+ To understand the flow of commands we illustrate three different situations: +

+
Playing a local game
+
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.
+
Playing on a remote server
+
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 screenshot. 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.
+
Running a dedicated server
+
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.
+

@@ -111,7 +195,10 @@ Client
-
+
+
+ Client console +

Starting the client will show the loader screen and open the client console. The console will stay open until you are connected -- cgit v1.2.3