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. Using Netradiant
   8
   9 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]] page.
  10
  11 h3. Compiling from Source
  12
  13 NetRadiant is included with the git checkout from the [[Repository Access|repository]]. 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'.
  14
  15 _directions to compile on windows (TODO?)_
  16
  17 h3. Builds
  18
  19 http://www.icculus.org/netradiant/files/
  20
  21 h2. Map Packages
  22
  23 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)
  24
  25 h3. Package Design
  26
  27 h4. Naming Conventions
  28
  29 <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.
  30
  31 h4. Required Files
  32
  33 maps/<mapname>.bsp - This is your compiled map file
  34 maps/<mapname>.map - This is an open-source game, help others learn.  This file is required to be in the game.
  35 maps/<mapname>.mapinfo - This file has the meta information, global music track, gametype(s) and game settings
  36 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.
  37 maps/<mapname>.waypoints - This is required to be added to the game, it's for bot [[adding waypoints|waypoints]
  38 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 "<".
  39
  40 h4. Optional/Suggested Files
  41
  42 This is not an exhaustive list, remember, you can include almost any file that loads with a map. (needs list of files)
  43
  44 h4. Files You Should Never Include
  45
  46 csprogs.dat
  47 progs.dat
  48 effectsinfo.txt
  49
  50 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.
  51
  52 h2. Examples
  53
  54 maps/tutorial-world-v1_r2.bsp
  55 maps/tutorial-world-v1_r2.map
  56 maps/tutorial-world-v1_r2.mapinfo
  57 maps/tutorial-world-v1_r2.png
  58 maps/tutorial-world-v1_r2.waypoints
  59 maps/gfx/tutorial-world-v1_r2_mini.png
  60 maps/models/tutorial-world/crate.md3
  61 maps/models/tutorial-world/jumppad.md3
  62 scripts/tutorial-world/map-tutorial-world.shader
  63 maps/sound/cdtracks/tutorial-world/main-room.ogg
  64 maps/sound/tutorial-world/jumppad.ogg
  65 maps/sound/tutorial-world/wind.ogg
  66 maps/textures/tutorial-world/base_1.tga
  67 maps/textures/tutorial-world/floor_1.tga
  68 maps/textures/tutorial-world/floor_2.tga
  69 maps/textures/tutorial-world/floor_1.tga
  70 maps/textures/tutorial-world/wall_1.tga
  71 maps/textures/tutorial-world/wall_2.tga
  72
  73 _add a well packaged map_
  74
  75 h2. Testing Maps
  76
  77 You can compile your map locally or on the build server.  The build server (requires [[Repository Access]]) requires a <mapname>.mapoptions file. For more info check ask in #xonotic.editing on irc.quakenet.org
  78
  79 h2. Maps on Servers
  80
  81 Find a server admin to add your map.  (this section needs work)
  82
  83 h2. Map Repositories
  84
  85 _*Maps must be properly packaged to be included in a repository*_
  86
  87 An official map repository is in the planning stages, please check back later or find help on IRC.
  88
  89
  90 h2. Help
  91
  92 #xonotic.editing on irc.quakenet.org
  93 http://forums.xonotic.org
  94
  95 [[Création de cartes|Français]]