User Tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
usermanual:running [2008-08-05 11:19] Joern Updated text to conform with release 8.08 |
usermanual:running [2013-01-07 12:07] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Running Ca3DE ====== | + | ====== Running Cafu ====== |
| - | In order to start Ca3DE, simply double-click on the ''Ca3DE.exe'' executable file. | + | In order to start Cafu, simply double-click on the ''Cafu.exe'' executable file. |
| - | This file is in the ''Ca3D-Engine'' folder that was created during installation. | + | This file is in the ''Cafu-x.y'' folder that was created during installation. |
| ===== The Main Menu ===== | ===== The Main Menu ===== | ||
| - | {{:usermanual:mainmenu.jpg?320}} | + | {{ :usermanual:mainmenu.jpg?320}} |
| After starting, the //Main Menu// appears as shown in the figure. | After starting, the //Main Menu// appears as shown in the figure. | ||
| - | From here you can configure Ca3DE's graphic, audio and control options, start new games, join multiplayer games and even host you own multiplayer server. //To start playing immediately just click ''New Game'', select a map to play and click ''Go!'' to play this map on your local machine.// | + | From here you can configure Cafu's graphic, audio and control options, start new games, join multiplayer games and even host your own multiplayer server. //To start playing immediately just click// <color #0040B3>New Game</color>//, select a map to play and click// <color #0040B3>Go!</color> //to play this map on your local machine.// |
| For hosting multiplayer games or joining them please read the following sections. | For hosting multiplayer games or joining them please read the following sections. | ||
| + | <clear> | ||
| ==== New Game ==== | ==== New Game ==== | ||
| - | {{:usermanual:newgame.jpg?320}} | + | {{ :usermanual:newgame.jpg?320}} |
| This dialog allows you to quickly start a new game. | This dialog allows you to quickly start a new game. | ||
| You can choose a map from the list on the left side of the screen. If available a preview screenshot of the map is shown on the right side. | You can choose a map from the list on the left side of the screen. If available a preview screenshot of the map is shown on the right side. | ||
| - | To start the game you just have to click on ''Go!'' and the the engine will automatically host a local game server with the chosen map and connect you as a client to it. | + | To start the game you just have to click on <color #0040B3>Go!</color> and the the engine will automatically host a local game server with the chosen map and connect you as a client to it. |
| + | <clear> | ||
| ==== Join Online Game ==== | ==== Join Online Game ==== | ||
| {{ :usermanual:joingame.jpg?320}} | {{ :usermanual:joingame.jpg?320}} | ||
| + | |||
| This dialog lets you join a multiplayer game using the given parameters: | This dialog lets you join a multiplayer game using the given parameters: | ||
| - | * [Player name] Your player name. Other players see this name when you talk to them. | + | * <color #0040B3>Player name</color> Your player name. Other players see this name when you talk to them. |
| - | * [Model] Your appearance in the game world. Clicking on this control cycles through all available player models (the currently chosen model is shown in the preview windows to the right) | + | * <color #0040B3>Model</color> Your appearance in the game world. Clicking on this control cycles through all available player models (the currently chosen model is shown in the preview windows to the right) |
| - | * [Remote Host Name] The name or the IP of the server that you wish to connect to. | + | * <color #0040B3>Remote Host Name</color> The name or the IP of the server that you wish to connect to. |
| - | * [Remote Port] The port number at which the server is listening on the remote host. | + | * <color #0040B3>Remote Port</color> The port number at which the server is listening on the remote host. |
| - | Clicking ''Connect'' will attempt to connect you to the chosen server and the game will start if connecting was successful. | + | Clicking <color #0040B3>Connect</color> will attempt to connect you to the chosen server and the game will start if connecting was successful. |
| + | <clear> | ||
| ==== Host Game Server ==== | ==== Host Game Server ==== | ||
| {{ :usermanual:hostgame.jpg?320}} | {{ :usermanual:hostgame.jpg?320}} | ||
| This dialog lets you start and configure a multiplayer server. | This dialog lets you start and configure a multiplayer server. | ||
| - | * [Map Name] The map hosted on the server. Clicking on this box cycles through all available maps (a preview of the currently chosen map is shown on the right). | + | * <color #0040B3>Map Name</color> The map hosted on the server. Clicking on this box cycles through all available maps (a preview of the currently chosen map is shown on the right). |
| - | * [Local Server Port] The port number at which your server will listening for incoming connections. | + | * <color #0040B3>Local Server Port</color> The port number at which your server will listening for incoming connections. |
| - | * [Play on this machine] This box lets you choose whether you want to play on the server yourself or just start a stand alone server. | + | * <color #0040B3>Play on this machine</color> This box lets you choose whether you want to play on the server yourself or just start a stand alone server. |
| - | The following two options are only relevant if you have chosen ''Yes'' in ''Play on this machine''. | + | The following two options are only relevant if you have chosen <color #0040B3>Yes</color> in <color #0040B3>Play on this machine</color>. |
| - | * [Player Name] Your player name. Other players see this name when you talk to them. | + | * <color #0040B3>Player Name</color> Your player name. Other players see this name when you talk to them. |
| - | * [Model] Your appearance in the game world. Clicking on this control cycles through all available player models (the currently chosen model is shown in the preview windows to the right). | + | * <color #0040B3>Model</color> Your appearance in the game world. Clicking on this control cycles through all available player models (the currently chosen model is shown in the preview windows to the right). |
| - | Clicking ''Go!'' will start the game server and optionally connect you to it. | + | Clicking <color #0040B3>Go!</color> will start the game server and optionally connect you to it. |
| Line 80: | Line 81: | ||
| In order to activate or deactivate the in-game console, press the ''F1'' key. | In order to activate or deactivate the in-game console, press the ''F1'' key. | ||
| - | The large upper area of the window shows the console output of any component or subsystem of the Ca3D-Engine. | + | The large upper area of the window shows the console output of any component or subsystem of Cafu. |
| The "Close" button in the lower right corner closes the console window again, bringing you back to the game. Other options to close the console window include pressing the ''F1'' or ''ESC'' key. | The "Close" button in the lower right corner closes the console window again, bringing you back to the game. Other options to close the console window include pressing the ''F1'' or ''ESC'' key. | ||
| The "Clear" button clears the contents of the console output window. | The "Clear" button clears the contents of the console output window. | ||
| + | |||
| The text input field in the lower left is used for entering console commands. | The text input field in the lower left is used for entering console commands. | ||
| Note that the ''TAB'' key command-completion feature is available to facilitate text entry. | Note that the ''TAB'' key command-completion feature is available to facilitate text entry. | ||
| + | The up and down arrow keys navigate through the command history for repeating previously entered commands. | ||
| - | Technically, the console interpreter is actually an instance of a [[http://www.lua.org/|Lua]] program in interactive mode. The Ca3D-Engine binds its console variables and functions to that program so that they can be accessed like any other native Lua value. You may want to refer to the [[http://www.lua.org/docs.html|Lua documentation]] to learn more about the language Lua and its possibilities. The fact that you can write entire Lua programs at the Ca3DE in-game console provides great customizability and flexibility for both game developers and users. | + | Technically, the console interpreter is actually an instance of a [[http://www.lua.org/|Lua]] program in interactive mode. The Cafu engine binds its console variables and functions to that program so that they can be accessed like any other native Lua value. You may want to refer to the [[http://www.lua.org/docs.html|Lua documentation]] to learn more about the language Lua and its possibilities. The fact that you can write entire Lua programs at the Cafu in-game console provides great customizability and flexibility for both game developers and users. |
| - | Nonetheless, the Ca3DE console can also be used without any prior Lua knowledge, or any programming knowledge at all. | + | Nonetheless, the Cafu console can also be used without any prior Lua knowledge, or any programming knowledge at all. |
| Here are some getting-started examples that demonstrate the basic usage: | Here are some getting-started examples that demonstrate the basic usage: | ||
| Line 100: | Line 103: | ||
| list() | list() | ||
| </code> | </code> | ||
| - | lists all available Ca3DE console functions, console variables, and global Lua values. As such, the ''list()'' function is useful to look-up the available commands. Note that the ''TAB'' key for command-completion serves a similar purpose, but the ''list()'' function provides more information about the values and the output is formatted. | + | lists all available Cafu console functions, console variables, and global Lua values. As such, the ''list()'' function is useful to look-up the available commands. Note that the ''TAB'' key for command-completion serves a similar purpose, but the ''list()'' function provides more information about the values and the output is formatted. |
| <code lua> | <code lua> | ||
| Line 115: | Line 118: | ||
| <code lua> | <code lua> | ||
| - | rc("passwd ca3d") | + | rcon("changeLevel('filename')") |
| - | rc("cl <filename>") | + | |
| </code> | </code> | ||
| - | ''rc'' is the abbreviation for "remote console". | + | ''rcon'' is the abbreviation for "remote console". |
| It means that the rest of the line is not processed by the local client, but rather sent to the remote server console. | It means that the rest of the line is not processed by the local client, but rather sent to the remote server console. | ||
| - | ''cl'' is the short form for "change level". | + | Therefore, this line instructs the server to initiate a level (world) change. |
| - | Therefore, the first line introduces you as the super-user at the server. | + | |
| - | The second line instructs it to initiate a level (world) change. | + | |
| Pressing the ''F1'' key deactivates the console and brings you back to the game. | Pressing the ''F1'' key deactivates the console and brings you back to the game. | ||
| Line 129: | Line 129: | ||
| ==== The config.lua File ==== | ==== The config.lua File ==== | ||
| - | When the Ca3D-Engine starts up, it automatically processes the ''config.lua'' file. | + | When ''Cafu.exe'' starts up, it automatically processes the ''config.lua'' file. |
| - | The ''config.lua'' file is located in the Ca3DE base directory. | + | The ''config.lua'' file is located in the Cafu base directory. |
| It is run in the context of the in-game console and can therefore contain any statement that you could also enter interactively as described above. | It is run in the context of the in-game console and can therefore contain any statement that you could also enter interactively as described above. | ||
| Because the ''config.lua'' file is processed early during engine initialization, it is the ideal place to | Because the ''config.lua'' file is processed early during engine initialization, it is the ideal place to | ||
| set default values and to keep any console statements that you find yourself entering over and over again. | set default values and to keep any console statements that you find yourself entering over and over again. | ||
| You can also define new functions or convenient abbreviations, and in fact, a complete, full-featured Lua program can be written into this file, either by the user, the game developer, or both. | You can also define new functions or convenient abbreviations, and in fact, a complete, full-featured Lua program can be written into this file, either by the user, the game developer, or both. | ||
| - | Just have a look into the ''config.lua'' file in the Ca3DE base directory to see some examples. | + | Just have a look into the ''config.lua'' file in the Cafu base directory to see some examples. |
usermanual/running.1217927943.txt.gz · Last modified: 2013-01-07 12:07 (external edit)