Update Programming Tips
[xonotic/xonotic.wiki.git] / Mapping-packaging.md
1 Mapping - Packaging
2 ===================
3
4 pk3 packages
5 ------------
6
7 `.pk3` files are basically just renamed `.zip` archives. The content needs to follow a certain folder structure.
8 Map related files go into `maps/`, sounds go into `sounds`, etc. If you followed the suggestion from [First Map](mapping-FirstMap)
9 creating a `.pk3` package only consists of removing build artifacts, adding the map files to a `.zip` archive and renaming it.
10
11 Required files
12 --------------
13
14 While technically only the `.bsp` file generated by the map compiler and all used assets that are not part of the game are needed,
15 some other files are needed so that the map works properly.
16
17 `maps/<mapname>.bsp` - This is your compiled map file  
18 `maps/<mapname>.mapinfo` - This file has the meta information, artist, global music track, gametype(s) and game settings  
19 `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.  
20 `maps/<mapname>.waypoints` - [Waypoints](mapping-Waypoints) for bots  
21 `maps/gfx/<mapname>_mini.tga|png|jpg` - Minimap, will be generated by the map compiler.  
22
23 ###Example mapinfo file
24
25 ```
26 title My First Map
27 description Mapping tutorial map
28 author MyName
29 cdtrack 6
30 gametype dm
31 gametype tdm
32 ```
33
34 Recommended files
35 -----------------
36
37 Adding these files is **strongly recommended**:
38
39 `maps/<mapname>.map` - This is an open-source game. Gives other the ability to learn and fix broken maps/extend maps.  
40 `License` - The license for the map. An open-source license like `GPL` is recommended.