| 1 | This is a guide on what is an acceptable map and what is unacceptable. |
1 | This is a guide on what is an acceptable map and what is unacceptable. |
| 2 | Only acceptable maps will be put in the official Crossfire map distribution |
2 | Only acceptable maps will be put in the official Crossfire map distribution |
|
|
3 | |
|
|
4 | ------------------------------------------------------------------------------ |
|
|
5 | |
|
|
6 | Map Naming/Directory Scheme: |
|
|
7 | |
|
|
8 | Note that these rules are ordered in importance, eg, if a rule conflicts, |
|
|
9 | the lower number rule takes precedence. |
|
|
10 | |
|
|
11 | 1) Each city should have its' own top level directory (eg, scorn, navar_city, |
|
|
12 | santo_dominion) and be accessible on a world map. All buildings in the |
|
|
13 | city and located nearby or related to it are in the respective city |
|
|
14 | directory. City/town names are also used for nearby regions. If one |
|
|
15 | desires to create a new city then create a new top level directory with |
|
|
16 | the city name and use the new city name for the region in the maps that |
|
|
17 | are associated with the new city. |
|
|
18 | |
|
|
19 | 2) If the map is part of a larger quest, a /quests/name_of_quest/ directory |
|
|
20 | should be made, and all the maps for the quest placed in there (also see |
|
|
21 | NOTE below about number of maps per directory). If some portions of the |
|
|
22 | quest has maps in cities or other places, a README should be included |
|
|
23 | explaining this. Note in general, having README's for all quests |
|
|
24 | explaining the flow probably isn't a bad idea in the case someone else |
|
|
25 | needs to work on it. |
|
|
26 | |
|
|
27 | 3) If a map is independent (eg, the map is one you just go there, kill and |
|
|
28 | get exp), it should be in the /dungeons/ directory. If the dungeon is |
|
|
29 | comprised of several maps (eg, multilevel dungeon), a subdirectory |
|
|
30 | should be made to hold all of these maps (also see NOTE below about number |
|
|
31 | of maps per directory). |
|
|
32 | |
|
|
33 | 4) Maps should fall into one of the categories above - if it does not, and |
|
|
34 | you are not sure, send a message to crossfire-devel@lists.real-time.com. |
|
|
35 | |
|
|
36 | NOTE: If a map or set of maps is near a particular city then place the proper |
|
|
37 | region in the map header. Use of the map maker's name as part of the |
|
|
38 | directory structure or map name is not encouraged and may result in maps |
|
|
39 | being excluded from CVS. While this type of directory scheme was done in the |
|
|
40 | past it is now deprecated. Attempt to use a logical tree structure for maps |
|
|
41 | and try to avoid dumping more than 15 to 20 maps in a single directory (this |
|
|
42 | does not apply to /world/). Dumping a massive number of maps in a single |
|
|
43 | directory is highly discouraged, Just Say No. |
|
|
44 | |
|
|
45 | ------------------------------------------------------------------------------ |
| 3 | |
46 | |
| 4 | 1) Check that all exits lead where they are supposed to. Unless there is |
47 | 1) Check that all exits lead where they are supposed to. Unless there is |
| 5 | a specific reason an exit leads only one direction (like a trap door or |
48 | a specific reason an exit leads only one direction (like a trap door or |
| 6 | perhaps a teleporter), players should be able to exit back from where they |
49 | perhaps a teleporter), players should be able to exit back from where they |
| 7 | came from right when they enter the map. |
50 | came from right when they enter the map. |
