Creating_Maps.textile

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