CTF caplimit

[divverent/nexuiz.git] / Docs / mapping.txt

==============\r
=Mapping Help=\r
==============\r
\r
While I can't help you make a map, I can help you get it listed in the menu and\r
working in the maplist. :p  The central object is the .mapinfo file, but\r
there's much more available.\r
\r
Table of Contents\r
-----------------\r
I        Map Lists & Scripts\r
         (get your map listed and working)\r
  i.     mapinfo\r
  ii.    mapname.cfg\r
\r
II       Map Image\r
\r
III      Domination\r
\r
IV       CTF\r
\r
V        Rune Match\r
\r
VI       Assault\r
\r
VII      Onslaught\r
\r
Appendix A - Advanced mapinfo\r
\r
Appendix B - Helpful extras\r
  i.     Team Colors\r
  ii.    Text Colors\r

Appendix C - Advanced Darkplaces shaders\r
\r
========================\r
=I. Map Lists & Scripts=\r
========================\r
\r
There are actually 2 script/cfg options available to you, each serving a\r
different purpose and being executed at a different time during the map's life\r
cycle:\r
\r
1. mapname.mapinfo\r
2. mapname.cfg\r
\r
Of these, the mapinfo is the only one that's truely required - and the game is\r
even so nice that it 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
stored into data/data/mapname.mapinfo.\r
\r
As an example, let's say I make a map called "wazat1.bsp". As long as I'm\r
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
\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
\r
    title Wazat's Great Map\r
    description Bleh.\r
    author Unknown\r
    _diameter 1966.839355\r
    _spawnpoints 5\r
    has weapons\r
    type dm 30 20\r
    type dom 200 20\r
    type rune 200 20\r
    type lms 9 20\r
    type arena 10 20\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 "type" lines to:\r
\r
    type dom 100 15\r
    type rune 1000 25\r
    type dm 40 15\r
    type tdm 50 0 2\r
\r
Also, while I am at it, I should fix the placeholders in the map description lines:\r
\r
    title Wibble\r
    description A large multi level arena map\r
    author Wazat\r
\r
Although not entirely necessary, I will now move the .mapinfo file from\r
data/data/maps/wazat1.mapinfo to data/maps/wazat1.mapinfo, so it is at the same\r
place as my map. Next time I start the game, my map will be shown supporting\r
the right game modes and with the right description in the menu.\r
\r
Also, note the "has weapons" line. If this line is not there (which happens if\r
the map contains no weapon entities other than the Nex), the map will run in\r
MinstaGib only and not be shown in the menu normally. So if you look for your\r
map and don't find it, add "has weapons" to the mapinfo file, and make sure you\r
have weapon entities placed.\r
\r
There's much more power in a mapinfo file. See Appendix A for more details.\r
\r
By the way: the Domination and Keyhunt types allow a third number to specify\r
the number of teams; the CTF type allows a third number to specify a capture\r
limit (if g_ctf_win_mode is 0 or 1).\r
\r
\r
-------------\r
-mapname.cfg-\r
-------------\r
\r
Unlike the mapinfo, which is processed by the server, the mapname.cfg file is\r
processed by the client, and therefore is used for client settings like fog or\r
the music to play.\r
\r
To make the mapname.cfg, make a file with the same name as your map's .bsp\r
file, except with a .cfg extension instead of .bsp. For example, my\r
"wazat1.bsp" map would use "wazat1.cfg". It uses the same name as your map,\r
thus the term mapname.cfg. It will typically only contain a single line:\r
\r
    cd loop 6\r
\r
where 6 is the number or name of a track in sound/cdtracks/\r
\r
\r
===============\r
=II. Map Image=\r
===============\r
\r
So, you've got your map listed in the menu and it plays properly, but the menu\r
isn't showing your picture! Or the picture is scaled badly! What manner of man\r
would create such an accursed abomination?!\r
\r
Well... That sounds like something I'd do. :D\r
\r
And it is really easy: just make a screenshot of the map in action (preferably\r
with crosshair and HUD switched off), and place it next to the map as\r
mapname.jpg. For best rendering and file size, make the image in 4:3 aspect\r
ratio, but scale it to the resolution 256x256 or possibly 512x512. It will look\r
skewed in your image editing app, but the menu will show it right, and your\r
graphics card LOVES images of such dimension.\r
\r
\r
=================\r
=III. Domination=\r
=================\r
\r
In order to get Domination working well in your map, you need to place dom_team\r
and dom_controlpoint entites. You *must* have at least 3 dom_team entities - 2\r
minimum teams and one blank one (empty netname and no team). You can have up\r
to 4 teams (5 dom_team entities).\r
\r
Dom Team\r
--------\r
classname  dom_team\r
netname    name of team (Red Team). Set to "" or don't define for the required\r
           blank team.\r
cnt        color of the team. See the "Helpful Extras" section for info.\r
model      When this team captures control points, the points turn to this\r
           model. If this is the neutral team, points start out as this model.\r
noise      Sound to be played on the control point when it's captured. Only\r
           players nearby will hear it.\r
noise1     Sound to be played to all players when the control point is\r
           captured. Also good for an annoncer voice ("Red Team has captured a\r
           control point")\r
\r
Control Points\r
--------------\r
classname  dom_controlpoint\r
message    message to be displayed to all players when this point is captured,\r
           preceded by the team's name. This defaults to " has captured a control point".\r
           You can specify different names for each point, for example " has captured the\r
           Lava Room".\r
origin     where in the map this point is\r
wait       How often this point gives its controlling team frags.\r
frags      How many frags this point gives each wait cycle.\r
\r
Here is an example entry in a .ent file that includes colored text and 3 teams:\r
\r
{\r
"classname" "dom_team"\r
"netname" ""\r
"model" "models/domination/dom_unclaimed.md3"\r
}\r
{\r
"classname" "dom_team"\r
"netname" "^4Blue Team"\r
"cnt" "13"\r
"noise" ""\r
"noise1" "domination/claim.wav"\r
"model" "models/domination/dom_blue.md3"\r
}\r
{\r
"classname" "dom_team"\r
"netname" "^1Red Team"\r
"cnt" "4"\r
"noise" ""\r
"noise1" "domination/claim.wav"\r
"model" "models/domination/dom_red.md3"\r
}\r
{\r
"classname" "dom_team"\r
"netname" "^6Pink Team"\r
"cnt" "9"\r
"noise" ""\r
"noise1" "domination/claim.wav"\r
"model" "models/domination/dom_pink.md3"\r
}\r
{\r
"classname" "dom_team"\r
"netname" "^3Yellow Team"\r
"cnt" "12"\r
"noise" ""\r
"noise1" "domination/claim.wav"\r
"model" "models/domination/dom_yellow.md3"\r
}\r
{\r
"classname" "dom_controlpoint"\r
"message" " ^3has captured the ^1Hallways"\r
"origin" "-206.0 -488.8 -150.0"\r
"frags" "3"\r
"wait" "5"\r
"scale" "1.3"\r
}\r
{\r
"classname" "dom_controlpoint"\r
"message" " ^3has captured the ^1Lavaroom"\r
"origin" "1457.1  19.9 -110.0"\r
"frags" "1"\r
"wait" "5"\r
}\r
{\r
"classname" "dom_controlpoint"\r
"message" " ^3controls the ^1Nex & Strength"\r
"origin" "-259.8 299.3  5"\r
"frags" "1"\r
"wait" "5"\r
}\r
{\r
"classname" "dom_controlpoint"\r
"message" " ^3has captured the ^1Upper Platform"\r
"origin" "539.7 1206.0 182.0"\r
"frags" "1"\r
"wait" "5"\r
}\r
{\r
"classname" "dom_controlpoint"\r
"message" " ^3has captured the ^1Teleport Room"\r
"origin" "-1000.0 636.2 -16.0"\r
"frags" "1"\r
"wait" "5"\r
}\r
\r
\r
As you can see in the example, there are 5 dom_team ents: one blank, Red, Blue,\r
Pink and Yellow. Each control point has a different message (giving it a\r
special name), and the one in the hallways gives 3 frags every 5 seconds\r
instead of just one, making it more valuable.\r
\r
If your map contains the required entities for Domination, the menu will\r
automatically detect it for supporting Domination. To force the map to get\r
re-detected after you add such entities, delete the data/data/mapname.mapinfo\r
file - or simply edit it to add the "type dom" line.\r
\r
\r
==========\r
=III. CTF=\r
==========\r
\r
Capture the flag needs at least 1 CTF flag per team, and can also make use of\r
team spawnpoints.\r
\r
CTF Flags\r
---------\r
classname  item_flag_team1 or item_flag_team2\r
angle      direction the flag will point\r
model      model of the flag (default: models/ctf/flag_red.md3 or\r
           models/ctf/flag_blue.md3)\r
noise      sound played when flag is stolen (default: "ctf/take.wav")\r
noise1     sound played when flag is returned by a teammate (default:\r
           "ctf/return.wav")\r
noise2     sound played when flag is captured (default: "ctf/capture.wav")\r
noise3     sound played when flag returns itself (default: "ctf/respawn.wav")\r
\r
Team Spawnpoints\r
----------------\r
classname  info_player_team1 or info_player_team2\r
*note: These function just like info_player_deathmatch, but for one team only.\r
If you don't make team spawnpoints, info_player_deathmatch is used instead.\r
\r
If your map contains the required entities for CTF, the menu will automatically\r
detect it for supporting CTF. 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 "type ctf" line.\r
\r
================\r
=III. 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 "type rune" line.\r
\r
\r
===============================\r
=Appendix A - Advanced mapinfo=\r
===============================\r
\r
You now know how to make a basic, bare-bones mapinfo to set up a couple options\r
and load your map. However, there's much more you can do!  Consider these\r
senarios:\r
\r
1. The laser has too high of a force for laser jumps and ruins CTF\r
2. I don't want players to start out with the shotgun, but with the machinegun\r
   instead\r
3. The map takes so much server CPU performance that the anti-wallhack can't be\r
   made active\r
\r
Each of these situations can be resolved with ease with a little work in the\r
mapinfo file.\r
\r
To do this, I can add the following lines to my mapinfo file:\r
\r
    settemp_for_type ctf g_balance_laser_primary_force 200\r
    settemp_for_type all g_start_weapon_shotgun 0\r
    settemp_for_type all g_start_weapon_uzi 1\r
    settemp_for_type all sv_cullentities_trace 0\r
\r
These "settemp" settings are automatically removed when the map is left and\r
another is loaded. As you can see, it is possible to make per-mode temporary\r
settings, and global ones.\r
\r
\r
=============================\r
=Appendix B - Helpful Extras=\r
=============================\r
\r
----------------\r
-i. Team Colors-\r
----------------\r
When you need to set an entity's color or team, use these values:\r
\r
Red\r
---\r
Team:      5\r
Color:     4\r
\r
Blue\r
----\r
Team:      14\r
Color:     13\r
\r
Yellow\r
------\r
Team:      13\r
Color:     12\r
\r
Pink\r
-----\r
Team:      10\r
Color:     9\r
\r
\r
----------------\r
-i. Text Colors-\r
----------------\r
Occasionally you may want to print text in color, such as team names. Here are your options:\r
\r
1  Red\r
2  Green\r
3  Yellow\r
4  Blue\r
5  Cyan\r
6  Magenta\r
7  White\r
8  Grey (transparent)\r
9  Grey (solid)\r
0  Black\r

==========================================\r
=Appendix C - Advanced Darkplaces shaders=\r
==========================================

Shader parameters for DP's own features:
- dp_reflect <distort> <r> <g> <b> <a>
  Makes surfaces of this shader reflective with r_water. The reflection is
  alpha blended on the texture with the given alpha, and modulated by the given
  color. distort is used in conjunction with the normalmap to simulate a
  nonplanar water surface.
- dp_refract <distort> <r> <g> <b>
  Makes surfaces of this shader refractive with r_water. The refraction
  replaces the transparency of the texture. distort is used in conjunction with
  the normalmap to simulate a nonplanar water surface.
- dp_water <reflectmin> <reflectmax> <refractdistort> <reflectdistort> <refractr> <refractg> <refractb> <reflectr> <reflectg> <reflectb> <alpha>
  This combines the effects of dp_reflect and dp_refract to simulate a water
  surface. However, the refraction and the reflection are mixed using a Fresnel
  equation that makes the amount of reflection slide from reflectmin when
  looking parallel to the water to reflectmax when looking directly into the
  water. The result of this reflection/refraction mix is then layered BELOW the
  texture of the shader, so basically, it "fills up" the alpha values of the
  water. The alpha value is a multiplicator for the alpha value on the texture
  - set this to a small value like 0.1 to emphasize the reflection and make
  the water transparent; but if r_water is 0, alpha isn't used, so the water can
  be very visible then too.