editing guide
[xonotic/xonotic.wiki.git] / Mapping / Old_Creating_Maps.md
1 Old Creating Maps
2 =================
3
4 **!! this page has been replaced … I left this hear for archival purposes … and if my page ins’t good enough for you  
5 — hutty —**
6
7 Introduction
8 ------------
9
10 Creating maps requires the [Netradiant](Netradiant), a gtkradiant based mapping program that generates .bsp files compiled by q3map2. It helps to have a [well packaged map](well packaged map) while reading through this article.
11
12 Using Netradiant
13 ----------------
14
15 NetRadiant is a fork of the popular Quake-based game editor, GtkRadiant, if you have familiarity with that software or another derivative of it, this For more information and more in-depth specifics, refer to the [Netradiant](Netradiant) page.
16
17 ### Compiling from Source
18
19 NetRadiant is included with the git checkout from the [repository](Repository_Access). On a Linux/UNIX system, the basic technique for building is to change to your **./xonotic/netradiant** directory and use ‘make’ to compile it. Resolve any dependencies. The binary file is located in **./xonotic/netradiant/install**, ‘radiant.x86’.
20
21 *directions to compile on windows (TODO?)*
22
23 ### Builds
24
25 http://www.icculus.org/netradiant/files/
26
27 Map Packages
28 ------------
29
30 Maps are packaged as a .zip file with a .pk3 extension. They can be opened with any program that opens zip files. The pk3 gets loaded when you start the game, [Xonotic](Xonotic). The engine, [Darkplaces](Darkplaces) reads pk3 files as it would a normal files system. You can thus create a pk3 package with any files that the engine can normally read. (needs well packaged map example pk3)
31
32 ### Package Design
33
34 #### Naming Conventions
35
36 `<mapname>` should be alpha-numeric, lowercase with dashes, periods and underscores only, `([a-z0-9-_.]+).pk3` -- preferably they are suffixed with a version and revision. Following this convention will yield better results from scripts that use this format to help distribute your map.
37
38 #### Required Files
39
40 `maps/<mapname>.bsp` - This is your compiled map file  
41 `maps/<mapname>.map` - This is an open-source game, help others learn. This file is required to be in the game.  
42 `maps/<mapname>.mapinfo` - This file has the meta information, global music track, gametype(s) and game settings  
43 `maps/<mapname>.tga|png|jpg` - This file is a screenshot of your map. If you don’t include this, you map doesn’t have a picture in the menu or the voting screen for servers and angels cry.  
44 `maps/<mapname>.waypoints` - This is required to be added to the game, it’s for bot [waypoints](adding_waypoints)  
45 `maps/gfx/<mapname>_mini.tga|png|jpg` - This is required to be added to the game, it’s a radar of the map. These can be generated with the command `<`.  
46
47 #### Optional/Suggested Files
48
49 This is not an exhaustive list, remember, you can include almost any file that loads with a map. (needs list of files)
50
51 #### Files You Should Never Include
52
53 csprogs.dat  
54 progs.dat  
55 effectsinfo.txt  
56
57 By including any of the files above, you could cause undesired results. Try and use common sense about how you’re adding dimension to your map, if you have questions, ask for help.
58
59 Examples
60 --------
61
62     maps/tutorial-world-v1_r2.bsp
63     maps/tutorial-world-v1_r2.map
64     maps/tutorial-world-v1_r2.mapinfo
65     maps/tutorial-world-v1_r2.png
66     maps/tutorial-world-v1_r2.waypoints
67     maps/gfx/tutorial-world-v1_r2_mini.png
68     maps/models/tutorial-world/crate.md3
69     maps/models/tutorial-world/jumppad.md3
70     scripts/tutorial-world/map-tutorial-world.shader
71     maps/sound/cdtracks/tutorial-world/main-room.ogg
72     maps/sound/tutorial-world/jumppad.ogg
73     maps/sound/tutorial-world/wind.ogg
74     maps/textures/tutorial-world/base_1.tga
75     maps/textures/tutorial-world/floor_1.tga
76     maps/textures/tutorial-world/floor_2.tga
77     maps/textures/tutorial-world/floor_1.tga
78     maps/textures/tutorial-world/wall_1.tga
79     maps/textures/tutorial-world/wall_2.tga
80
81 *add a well packaged map*
82
83 Testing Maps
84 ------------
85
86 You can compile your map locally or on the build server. The build server (requires [Repository Access](Repository_Access)) requires a `<mapname>.mapoptions` file. For more info check ask in \#xonotic.editing on irc.quakenet.org
87
88 Maps on Servers
89 ---------------
90
91 Find a server admin to add your map. (this section needs work)
92
93 Map Repositories
94 ----------------
95
96 ***Maps must be properly packaged to be included in a repository***
97
98 An official map repository is in the planning stages, please check back later or find help on IRC.
99
100 Help
101 ----
102
103 \#xonotic.editing on irc.quakenet.org  
104 http://forums.xonotic.org  
105
106 [Creation_de_cartes](Creation_de_cartes)
107
108 [Creating_Maps](Creating_Maps)