Heaps of docs :D

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@2101 e016b1c5-ed68-44aa-a2f7-31cac88cffde

docs/README.xml

@@ -60,6 +60,9 @@
       <li>
         <a href="maneuvers.xml">Special maneuvers</a> - Special gameplay maneuvers, such as: rifle jump, rifle sprint, etc.
       </li>
+      <li>
+        <a href="commonfaqs.xml">Common F.A.Q's</a> - Answers to some common questions not covered else-where in this readme.
+      </li>
     </ul>
 
     <h2>Advanced</h2>

docs/basics.xml

@@ -164,7 +164,7 @@
     </h2>
     <p>
       Most important setting changes can actually be changed from within the menus. So, press <b>ESC</b> and then <b>settings</b>. 
-      There are many settings in this menu that can be changed, look in there for what you need.
+      There are many important settings in this menu that can be changed, including changing your name and team. Look in there for what you need.
     </p>
     <p>
       There are of course other settings which can't be found inside the menu. These settings can be changed via the console. Check out
@@ -199,6 +199,91 @@
       Note for linux users: Config files get saved in the hidden directory <i>.assaultcube/config</i> 
       in your users home directory.
     </p>
+    <h2>
+      Choosing a weapon
+    </h2>
+    <p>
+      <img style="float:right;margin-left:10px;" src="pics/weaponselect.jpg" />
+      To select a primary weapon, press B to show the weapon menu (you can also find this menu inside of the 
+      settings menu).<br />
+      This menu will give you the option to pick any of the four primary weapons (Assault rifle, Sniper
+      rifle, Sub-machine gun, Shotgun).
+    </p>
+    <p>
+      The next time respawn, you will start with the weapon that you selected from this menu.
+    </p>
+    <p>
+      You can also select between your primary weapon, pistol/akimbo, grenade or knife by selecting them 
+      using the keys 1-4, or by scrolling through them with your mouse. Also, G will throw a grenade.
+    </p>
+    <p>
+      <b>Quick nade throw</b>: If you want to throw a grenade and then quickly switch back to your normal weapon,
+      press and hold the right mouse button and then let go to throw the grenade. After throwing the grenade (if you clicked and
+      held it) then it will switch back to your normal weapon.
+    </p>
+    <p>
+      You can find out more about the weapons <a href="introduction.xml#weapons">here</a>.
+    </p>
+      <img style="float:right;margin-left:10px;" src="pics/smallminimap.jpg" />
+    <h2 style="margin-top:30px;">
+      Orientation
+    </h2>
+    <p>
+      If you can't find your way around the map, you can use the mini-map in the top-right corner of your screen (see right).
+      Also, a bigger version of the map can be shown by pressing <b>ALT</b>.
+    </p>
+    <p>
+      To learn more about the mini-map, see <a href="interface.xml#minimap">here</a>.
+    </p>
+    <h2 style="margin-top:25px;">
+      Talking/Chatting
+    </h2>
+    <p>
+      If you want to say something to other players, it's very simple. Just press <b>T</b> to bring up the console
+      where you can type what you would like to the other players.
+    </p>
+    <p>
+      If you want to make sure what you say is said only to the players on your team (if in a team mode), then press <b>U</b>.
+      This will bring up the console with a <i>%</i> sign in-front of it. The <i>%</i> sign is what is needed infront of <i>ANYTHING</i>
+      you say to make it be seen <i>ONLY</i> by your team.
+    </p>
+    <h2 >Gibs</h2>
+    <p>
+      <i>Gibs</i> are a great way of defeating another player. If you want to gain a lot of points fast, this is the way to do it, because
+      gibs count for <b>2</b> points!
+    </p>
+    <p>
+      Gibs are created by: Headshots from sniper rifles, deaths from knifing &amp; deaths from grenade blasts.
+    </p>
     <h2>TO BE CONTINUED...</h2>
+    
+    <!-- TO DO!
+    resetbinds, resetcfg
+    <h2>
+      Console
+    </h2>
+    <h2>
+      Voting
+    </h2>
+    <p>Include choosing a map, etc</p>
+    <h2>
+      Screenshots &amp; demos
+    </h2>
+    <h2>
+      Voice-com
+    </h2>
+    <h2>
+      Crouching &amp; jumping
+    </h2>
+    <h2>
+      Scoreboard
+    </h2>
+    <h2>
+      In-game reference
+    </h2>
+    <p>f1=disable doc reference; F2=more; F3=Less</p>
+    <p>Add link for special manuevers</p> -->
+   
+    
   </body>
 </html>

docs/commonfaqs.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<?xml-stylesheet type="text/xsl" href="transformations/cubedoc2xhtml.xslt"?>
+
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" lang="en" xml:lang="en">
+  <head>
+    <title>Common F.A.Q's</title>
+  </head>
+  <body>
+  <h1>Common F.A.Q's</h1>
+  <p style="margin-bottom:20px;">
+    <i>This section of the ReadMe covers some common questions asked by players.</i>
+  </p>
+  <ul>
+    <li>
+      <b>What is ping/packet jump?</b>
+    </li>
+  </ul>
+  <p style="margin-left:20px;">
+    This is covered in the interface part of the readme. Check <a href="interface.xml#scoreboard">here</a>.
+  </p>
+  <ul>
+    <li>
+      <b>Why do some players become transparent and salute?</b>
+    </li>
+  </ul>
+  <p style="margin-left:20px;">
+    This is because of lag. The server has not had a response from this player for too long and so they have 
+    temporarally been turned into a "ghost" that cannot be shot (but don't worry, they can't shoot you either).
+  </p>
+  </body>
+</html>
+  

docs/interface.xml

@@ -39,6 +39,9 @@
       As an example, in multiplayer you can use the <a href="introduction.xml#gamemodes">vote</a> submenu to vote on a 
       new mode/map. Further customizations and actions can be done to these menus using CubeScript.
     </p>
+    <p>
+      In some circumstances, there may be more on a menu than what can be held. Pressing page-up/page-down on it will show the 
+      next page of the menu. You can tell if there is another page by the arrow at the bottom of the screen.</p>
 
     <h2 id="hud">The HUD</h2>
     <p>
@@ -49,15 +52,16 @@
       <img src="pics/hud.jpg" alt="The HUD"/>
     </p>
     <p>
-    A new feature implemented in AssaultCube 0.94 shows the direction of where damage inflicted upon you originated from
+    A new feature implemented in AssaultCube 1.00 shows the direction of where damage inflicted upon you originated from
     by using small red markers at the edge of the screen.
     </p>
     <p>
       The capture-the-flag HUD is slightly different to the normal one, as can be seen <a href="pics/ctf-hud.jpg">here</a>.
     </p>
-    <h2>The scoreboard</h2>
+    <h2 id="scoreboard">The scoreboard</h2>
     <p>
       The scoreboard will tell you (horizontally in this order):
+    </p>
       <ul>
         <li>          
           CTF flags captured (if playing capture the flag).
@@ -87,6 +91,11 @@
     <p style="text-align:center">
       <img src="pics/scoreboard.jpg" alt="The scoreboard"/>
     </p>
+    <p>
+      Pressing page-up/page-down on the scoreboard will show the next page on the scoreboard. You can tell if there is another page
+      (this happens when there are many people on the server) by the arrow at the bottom of the screen.
+    </p>
+    <p>
       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
@@ -108,7 +117,7 @@
     <p>
       Players names that are in grey, are currently in dead/spectate mode.
     </p>
-    <h2>Mini-map</h2>
+    <h2 id="minimap">Mini-map</h2>
     <p>
       The mini-map shows your location in the map. To activate it, hold down <i>ALT</i>.
     </p>

docs/knownissues.xml

@@ -9,9 +9,11 @@
   <body>
     <h1>Known Issues</h1>
     <ul>
-      <li>AC might crash on linux/mac because of bugged nvidia drivers</li>
-      <li>the bots need improvements</li>
-      <li>the documentation/reference is incomplete</li>
+      <li>AC might crash on linux/mac because of bugged nVidia drivers.</li>
+      <li>The bots need improvements.</li>
+      <li>The documentation/reference is incomplete.</li>
+      <li>On the very first time that AssaultCube is loaded, it takes a bit longer than normal, due to shadows.dat files being created.
+          <b>Note: This ONLY happens on the first ever load of AC</b></li>
     </ul>
   </body>
 </html>