diff --git a/docs/README.xml b/docs/README.xml index 454fe67b..c852768e 100644 --- a/docs/README.xml +++ b/docs/README.xml @@ -51,6 +51,9 @@
  • Introduction - Basic information about the game including gameplay, modes, weapons.
    • +
  • + The interface - What AssaultCube looks and works like. Read this before you read "The basics". +
  • The basics - Learn how to play AssaultCube, by learning the basics.
    • diff --git a/docs/basics.xml b/docs/basics.xml index 891d66d2..0c66be41 100644 --- a/docs/basics.xml +++ b/docs/basics.xml @@ -1,4 +1,4 @@ - + @@ -7,98 +7,6 @@ The basics -

    The basics

    - -

    The interface

    -

    Menus

    -

    - In game, press ESC to access the main menu. From there you can access almost anything and use all sorts of actions, - like joining multiplayer games and changing settings. As example, in multiplayer you can use the - vote submenu to vote on a new mode/map. Further customizations and - actions can be done to these menus using CubeScript. -

    -

    The console

    -

    - Many actions in AssaultCube can be done in a console. Although not entirely neccesary to use it (the menu can - be used to do most important commands) it can be very useful and often easier/faster to use it. - To get a console press T to open the chat prompt. You can use it as console if you put a - “/” (slash) at its beginning followed by a command. As example, - type this command into the console: -

    -
    - /crosshairsize 25 -
    -

    - This will increase the size of your crosshair. Check the - reference - to see all gameplay relevant commands you can use - through CubeScript. -

    -

    - Hint: Press F11 to get a bigger console history. -

    -

    The HUD

    -

    - HUD stands for Head-up display and is a common term in video gaming. The HUD is used to indicate things such as health, - armour, etc when playing the game. -

    -

    - The HUD -

    -

    - A new feature implemented in AssaultCube 0.94 shows the direction of where damage inflicted upon you originated from - by using small red markers at the edge of the screen. -

    -

    The scoreboard

    -

    - The scoreboard will tell you (horizontally in this order): -

    -

    - The scoreboard -

    - Packet jump (PJ) is the amount of milliseconds that have passed since you have received updates from players. - A high (for example: 950) or variable (for example: The PJ is at 40 then jumps to 1000 and then 300 then 550) packet - jump is bad for game play, because these players may become difficult targets and "warp" around the map (warp means - they disappear/reappear out of nowhere). If someone's packet jump is bad enough, their PJ number will turn into the - word LAG and they'll stand still and start saluting because they are lagging so badly. Special note: You cannot see - your own packet jump. -

    -

    - Ping is the amount of time in milliseconds that it takes for your packets of data to get back and forth from the - server. A lower ping is a better ping. -

    -

    - Client number is a number that is given out automatically by the server. There is nothing particularly special about it - other than allowing people to identify players easier. -

    -

    - If someones name turns up in red, then they are an administrator of that server and have full control over it. -

    -

    - Players names that are in grey, are currently in dead/spectate mode. -

    How settings are saved

    @@ -160,6 +68,5 @@

    Where N is a valid IP or FQDN and P a password (optional).

    - \ No newline at end of file diff --git a/docs/interface.xml b/docs/interface.xml new file mode 100644 index 00000000..7377bd82 --- /dev/null +++ b/docs/interface.xml @@ -0,0 +1,119 @@ + + + + + + + The interface + + +

    The interface

    + +

    Menus

    +

    + In game, press ESC to access the main menu. From there you can access almost anything and use all sorts of actions, + like joining multiplayer games and changing settings. As example, in multiplayer you can use the + vote submenu to vote on a new mode/map. Further customizations and + actions can be done to these menus using CubeScript. +

    +

    The console

    +

    + Many actions in AssaultCube can be done in a console. Although not entirely neccesary to use it (the menu can + be used to do most important commands) it can be very useful and often easier/faster to use it. + To get a console press T to open the chat prompt. You can use it as console if you put a + “/” (slash) at its beginning followed by a command. As example, + type this command into the console: +

    +
    + /crosshairsize 25 +
    +

    + This will increase the size of your crosshair. Check the + reference + to see all gameplay relevant commands you can use + through CubeScript. +

    +

    + Hint: Press F11 to get a bigger console history. +

    +

    The HUD

    +

    + HUD stands for Head-up display and is a common term in video gaming. The HUD is used to indicate things such as health, + armour, etc when playing the game. +

    +

    + The HUD +

    +

    + A new feature implemented in AssaultCube 0.94 shows the direction of where damage inflicted upon you originated from + by using small red markers at the edge of the screen. +

    +

    The scoreboard

    +

    + The scoreboard will tell you (horizontally in this order): +

    +

    + The scoreboard +

    + Packet jump (PJ) is the amount of milliseconds that have passed since you have received updates from players. + A high (for example: 950) or variable (for example: The PJ is at 40 then jumps to 1000 and then 300 then 550) packet + jump is bad for game play, because these players may become difficult targets and "warp" around the map (warp means + they disappear/reappear out of nowhere). If someone's packet jump is bad enough, their PJ number will turn into the + word LAG and they'll stand still and start saluting because they are lagging so badly. Special note: You cannot see + your own packet jump. +

    +

    + Ping is the amount of time in milliseconds that it takes for your packets of data to get back and forth from the + server. A lower ping is a better ping. +

    +

    + Client number is a number that is given out automatically by the server. There is nothing particularly special about it + other than allowing people to identify players easier. +

    +

    + If someones name turns up in red, then they are an administrator of that server and have full control over it. +

    +

    + Players names that are in grey, are currently in dead/spectate mode. +

    +

    Mini-map

    +

    + The mini-map shows your location in the map. To activate it, hold down ALT. +

    +

    + You can find yourself on the mini-map by looking for the symbol in green. + As well as showing your location on the map, it will also show your team-mates locations (if you're playing a team-based game). + X's mark dead team-mates, pulsating icons show team-mates that are attacking. +

    +

    + Mini-map +

    +

    + If you're playing CTF, then red and blue flags will show up in their respective locations on the mini-map, + unless the enemy has your flag (then you won't be able to see it) OR if your team has the enemies flag (It will show + which team-member is carrying the flag). +

    + + \ No newline at end of file diff --git a/docs/pics/minimap.jpg b/docs/pics/minimap.jpg new file mode 100644 index 00000000..69de895e Binary files /dev/null and b/docs/pics/minimap.jpg differ