Creating_Maps.textile

   1 h1. Creating Maps
   2
   3 h2. Introduction
   4
   5 Creating maps requires the [[Netradiant]], a gtkradiant based mapping program that generates .bsp files compiled by q3map2.  It helps to have a [[well packaged map]] while reading through this article.
   6
   7 h2. Map Packages
   8
   9 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]].  The engine, [[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)
  10
  11 h3. Package Design
  12
  13 h4. Naming Conventions
  14
  15 <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.
  16
  17 h4. Required Files
  18
  19 maps/<mapname>.bsp - This is your compiled map file
  20 maps/<mapname>.map - This is an open-source game, help others learn.  This file is required to be in the game.
  21 maps/<mapname>.mapinfo - This file has the meta information, global music track, gametype(s) and game settings
  22 maps/<mapname>.jpg|png|tga - 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.
  23 maps/<mapname>.waypoints - This is required to be added to the game, it's a [[adding waypoints]]
  24
  25 h4. Optional/Suggested Files
  26
  27 This is not an exhaustive list, remember, you can include almost any file that loads with a map. (needs list of files)
  28
  29 h4. Files You Should Never Include
  30
  31 csprogs.dat
  32 progs.dat
  33 effectsinfo.txt
  34
  35 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.
  36
  37 h2. Testing Maps
  38
  39 You can compile your map locally or on the build server.  The build server (requires [[Respository_Access]]) requires a <mapname>.mapoptions file. For more info check ask in #xonotic.editing on irc.quakenet.org
  40
  41 h2. Maps on Servers
  42
  43 Find a server admin to add your map.  (this section needs work)
  44
  45 h2. Map Repositories
  46
  47 _*Maps must be properly packaged to be included in a repository*_
  48
  49 An official map repository is in the planning stages, please check back later or find help on IRC.
  50
  51
  52 h2. Help
  53
  54 #xonotic.editing on irc.quakenet.org
  55 http://forums.xonotic.org