Merge remote-tracking branch 'origin/terencehill/docs_update'

# By terencehill
# Via terencehill
* origin/terencehill/docs_update:
  Remove runes/curses bit mask specifications from eventlog.txt
  Update and simplify beginning of section I of mapping.txt
  Remove references to Runematch in mapping.txt
  Document that currently CA can have a more than 2 teams

diff --git a/Docs/eventlog.txt b/Docs/eventlog.txt
index 13b1bbf53f93ea85c0c179d9747b2f6c0a3762b1..57a2cdd2ccce564ac1404fc6634f3057b8dc8784 100644 (file)
--- a/Docs/eventlog.txt
+++ b/Docs/eventlog.txt
@@ -124,18 +124,6 @@ itemstring:
         13 = Heavy Laser Assault Cannon\r
         14 = T.A.G. Seeker\r
 \r
-   runes/curses are stored as a bit mask with the following values:\r
-         1 = Strength\r
-         2 = Defense\r
-         4 = Regeneration\r
-         8 = Speed\r
-        16 = Vampire\r
-      8192 = Weakness\r
-     16384 = Vulnerability\r
-     32768 = Venom\r
-     65536 = Slow\r
-    131072 = Empathy\r
-\r
 death type:\r
    either a weapon ID ORed with weapon death flags, or one of\r
    the notifications in common/deathtypes.qh in the form of a string.\r

diff --git a/Docs/mapping.txt b/Docs/mapping.txt
index 6b20652f7ce1b3b9978d98c4eebf10c28df73004..edfb0ef81c6213702a9f5b52ffed10a2bf7a5366 100644 (file)
--- a/Docs/mapping.txt
+++ b/Docs/mapping.txt
@@ -8,10 +8,8 @@ there's much more available.
 \r
 Table of Contents\r
 -----------------\r
-I        Map Lists & Scripts\r
+I        Map Settings\r
          (get your map listed and working)\r
-  i.     mapinfo\r
-  ii.    mapname.cfg\r
 \r
 II       Map Image\r
 \r
@@ -19,11 +17,9 @@ III      Domination
 \r
 IV       CTF\r
 \r
-V        Rune Match\r
+V        Race/CTS\r
 \r
-VI       Race/CTS\r
-\r
-VII      Nexball\r
+VI       Nexball\r
 \r
 Appendix A - Advanced mapinfo\r
 \r
@@ -33,24 +29,14 @@ Appendix B - Helpful extras
 \r
 Appendix C - Advanced Darkplaces shaders\r
 \r
-========================\r
-=I. Map Lists & Scripts=\r
-========================\r
+=================\r
+=I. Map Settings=\r
+=================\r
 \r
-There now is just a single script/cfg file available to you, containing all map\r
-specific settings:\r
+All map specific settings goes in a single file:\r
 \r
 mapname.mapinfo\r
 \r
-The mapinfo is actually required - however, the game is so nice that it\r
-automatically generates a draft of it for you.\r
-\r
-------------------\r
--The mapinfo file-\r
-------------------\r
-\r
-*cue even more scary music*\r
-\r
 The mapinfo file is basically what gets your map listed in the menu, and sets\r
 up the options needed to change to it. If no mapinfo file exists, the menu\r
 will automatically generate a rough draft for you on game startup. It will get\r
@@ -60,7 +46,7 @@ As an example, let's say I make a map called "wazat1.bsp". As long as I'm
 fantasizing, I might as well say this map is so well done I'm actually willing\r
 to release it for friends, neighbors, fellow forum visitors and other people\r
 who like me to judge me by. Let's also assume that I want domination,\r
-deathmatch/team deathmatch and runematch to all be playable on my map.\r
+deathmatch/team deathmatch to all be playable on my map.\r
 \r
 This is very easy. First, I start the game and exit it again so the game writes\r
 data/data/wazat1.mapinfo for me. The file may look like:\r
@@ -74,17 +60,15 @@ data/data/wazat1.mapinfo for me. The file may look like:
        cdtrack 5\r
     gametype dm // defaults: timelimit=20 pointlimit=30 leadlimit=0\r
     gametype dom // defaults: timelimit=20 pointlimit=200 teams=2 leadlimit=0\r
-    gametype rune // defaults: timelimit=20 pointlimit=200 leadlimit=0\r
     gametype lms // defaults: timelimit=20 lives=9 leadlimit=0\r
     gametype arena // defaults: timelimit=20 pointlimit=10 leadlimit=0\r
 \r
 As I see, the menu autodetected that my map may be suitable for deathmatch,\r
-domination, runematch, last man standing and arena. But I want the map to be\r
-played in domination, deathmatch, team deathmatch, runematch only, and I also\r
-want different timelimits/fraglimits, so I will change the "gametype" lines to:\r
+domination, last man standing and arena. But I want the map to be played in\r
+domination, deathmatch, team deathmatch only, and I also want different\r
+timelimits/fraglimits, so I will change the "gametype" lines to:\r
 \r
     gametype dom pointlimit=100 timelimit=15\r
-    gametype rune pointlimit=1000 timelimit=25\r
     gametype dm pointlimit=40 timelimit=15\r
     gametype tdm pointlimit=50 timelimit=0 teams=2\r
 \r
@@ -113,7 +97,6 @@ Deathmatch      | gametype dm [timelimit=...] [pointlimit=...] [leadlimit=...]
 Team Deathmatch | gametype tdm [timelimit=...] [pointlimit=...] [teams=...] [leadlimit=...]                                | 2, 3, or 4 teams\r
 Domination      | gametype dom [timelimit=...] [pointlimit=...] [teams=...] [leadlimit=...]                                | 2, 3, or 4 teams, only if map has no dom_team ents\r
 CTF             | gametype ctf [timelimit=...] [caplimit=...] [leadlimit=...]                                              |\r
-Runematch       | gametype rune [timelimit=...] [pointlimit=...] [leadlimit=...]                                           |\r
 LMS             | gametype lms [timelimit=...] [lives=...] [leadlimit=...]                                                 |\r
 Arena           | gametype arena [timelimit=...] [pointlinit=...] [leadlimit=...]                                          |\r
 Key Hunt        | gametype kh [timelimit=...] [pointlimit=...] [teams=...] [leadlimit=...]                                 | 2, 3, or 4 teams\r
@@ -121,9 +104,9 @@ Assault         | gametype as [timelimit=...]
 Onslaught       | gametype ons [timelimit=...]                                                                             | never uses points\r
 Race            | gametype rc [timelimit=...] [qualifying_timelimit=...] [laplimit=...] [teamlaplimit=...] [leadlimit=...] | g_race_teams: teamlaplimit is used instead of laplimit\r
 CTS             | gametype cts [timelimit=...] [skill=...]                                                                 | never uses points\r
-CA              | gametype ca [timelimit=...] [pointlimit=...] [leadlimit=...]                                             |\r
+CA              | gametype ca [timelimit=...] [pointlimit=...] [teams=...] [leadlimit=...]                                 | 2, 3, or 4 teams\r
 Nexball         | gametype nb [timelimit=...] [pointlimit=...] [leadlimit=...]                                             |\r
-Freeze Tag      | gametype ft [timelimit=...] [pointlimit=...] [teams=...] [leadlimit=...]                                 |\r
+Freeze Tag      | gametype ft [timelimit=...] [pointlimit=...] [teams=...] [leadlimit=...]                                 | 2, 3, or 4 teams\r
 Keepaway        | gametype ka [timelimit=...] [pointlimit=...]                                                             |\r
 \r
 \r
@@ -298,27 +281,9 @@ detect it for supporting CTF. To force the map to get re-detected after you add
 such entities, delete the data/data/mapname.mapinfo file - or simply edit it to\r
 add the "gametype ctf" line.\r
 \r
-==============\r
-=V. Runematch=\r
-==============\r
-\r
-Runematch needs only one type of entity to work: rune spawn points. You will\r
-need at least one for each rune (5 minimum at the time of this writing), though\r
-you should probably have more than that in the map. Just give the points a\r
-classname and origin.\r
-\r
-Rune Spawnpoints\r
-----------------\r
-classname  runematch_spawn_point\r
-\r
-If your map contains the required entities for Runematch, the menu will automatically\r
-detect it for supporting Runematch. To force the map to get re-detected after you add\r
-such entities, delete the data/data/mapname.mapinfo file - or simply edit it to\r
-add the "gametype rune" line.\r
-\r
-==============\r
-=VI. Race/CTS=\r
-==============\r
+=============\r
+=V. Race/CTS=\r
+=============\r
 \r
 Making a race map is not hard: you need some special spawnpoints, and some checkpoints.\r
 \r