Mapping-Setup.md

   1 Mapping - Setup
   2 ===============
   3
   4 How to get your system all set up to start mapping
   5 --------------------------------------------------
   6
   7 ### Step 1 (optional): Obtain the mapping support
   8
   9 If you didn’t already, download the [mapping support zip](http://dl.xonotic.org/xonotic-0.8.5-mappingsupport.zip).
  10 This is only needed if you use an old version of NetRadiant or another map editor (including NetRadiant-custom, which is a fork of NetRadiant).
  11 If you download NetRadiant from the [NetRadiant website](https://netradiant.gitlab.io) or compile it from source, you can ignore the following steps and proceed to step 5 directly.
  12
  13 ### Step 2 (optional): Extract the zip
  14
  15 Extract the zip archive using your favorite archiving tool
  16
  17 ### Step 3 (optional): Locate the folder for userdata
  18
  19 Locate your userdata folder, note that this is **NOT** the install location. This is the place where Xonotic saves your userdata.
  20
  21 -   **Windows**: `C:\users\user\saved games\xonotic\data`
  22 -   **Linux**: `~/.xonotic/data`
  23 -   **Mac**: `~/Library/Application Support/xonotic/data`
  24
  25 This folder has a similar layout as the game folder. Game wise these data folders are treated similarly, however, it is best to save your work in the userdata folder so that you don’t accidentally mess up your Xonotic install, or so that your work doesn’t get lost in an update.
  26
  27 ### Step 4 (optional): Move the mapping support pk3
  28
  29 The mapping support zip contains a file called `xonotic-<timestamp>-maps-mapping.pk3`. Move this file to the userdata folder (see step 3), **NOT** `data/data`.
  30 This folder should also contain your `config.cfg`.
  31
  32 ### Step 5: Get NetRadiant working
  33
  34 -   **Windows**: Windows users can download a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/).
  35 The mapping support zip also contains a compiled version of NetRadiant in the `mapping` folder but while it may works, it is fairly outdated and lacks a lot of updates.
  36 -   **Linux**: Linux users can use a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/).
  37 (_NOTE: Archlinux users can also use the [netradiant-git](https://aur.archlinux.org/packages/netradiant-git/) PKGBUILD_)
  38 -   **macOS**: macOS users can use a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/).
  39 -   **FreeBSD**: FreeBSD users can use a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/).
  40
  41 People wanting to compile NetRadiant themselves can look at the [NetRadiant Repository](https://gitlab.com/xonotic/netradiant).
  42
  43 ### Step 6: Set up NetRadiant
  44
  45 When you first start up radiant it may ask where the engine path is. Simply point it to the Xonotic install location. Then NetRadiant should start and the lower right pane should have a list of texture packs. If there are no texture packs, then you may need the mapping support, please refer back to step 4.
  46
  47 \<\< [Introduction](mapping-Introduction) | [NetRadiant](mapping-NetRadiant) \>\>
  48
  49 … [Creating_Maps](Creating-Maps) …