]> git.xonotic.org Git - xonotic/xonotic.wiki.git/blobdiff - Mapping-Setup.md
Update Compiling: add libtool dependency
[xonotic/xonotic.wiki.git] / Mapping-Setup.md
index 4249a41f60f3546be8151f4419d8622aa68e2ad6..7069c7dc17fc3d06dd28b2c71869a2c1eb6cdbf0 100644 (file)
@@ -1,51 +1,49 @@
-Mapping-Setup
-=============
+Mapping - Setup
+===============
 
 How to get your system all set up to start mapping
 --------------------------------------------------
 
-### Step 1 — Obtain mapping support
+### Step 1 (optional): Obtain the mapping support
 
-If you didn’t already, download this … http://dl.xonotic.org/xonotic-0.6.0-mappingsupport.zip
+If you didn’t already, download the [mapping support zip](http://dl.xonotic.org/xonotic-0.8.5-mappingsupport.zip).  
+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).  
+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.
 
-### Step 2 — Extract zip
+### Step 2 (optional): Extract the zip
 
-Extract the .zip archive using your favorite archiving tool
+Extract the zip archive using your favorite archiving tool
 
-### Step 3 — Find the magic folders
+### Step 3 (optional): Locate the folder for userdata
 
-Locate your .xonotic folder, note that this is NOT the install location. This is the place xonotic saves your config.
+Locate your userdata folder, note that this is **NOT** the install location. This is the place where Xonotic saves your userdata.
 
--   on linux this should be in `~/.xonotic`
--   on windows (7) its in `\users\user\saved games\xonotic`
--   on mac … its in `~/libraries/appdata` ?? maybe ??
+-   **Windows**: `C:\users\user\saved games\xonotic\data`
+-   **Linux**: `~/.xonotic/data`
+-   **Mac**: `~/Library/Application Support/xonotic/data`
 
-### Step 4 — Understand the magic folders
+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.
 
-if/when you find both of these folders, you will see that both of them contain a data folder. Game wise these data folders are treated the same, however, it is best to save your work in the .xonotic folder so that you don’t accidentally mess up your xonotic install, or so that your work doesn’t get lost in an update.
+### Step 4 (optional): Move the mapping support pk3
 
-### Step 5 — Moving stuff
+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`.
+This folder should also contain your `config.cfg`.
 
-remember that zip we extracted? There should be 2 folders in it.
+### Step 5: Get NetRadiant working
 
--   data (yes … another data folder)
--   mapping
+-   **Windows**: Windows users can download a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/).  
+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.
+-   **Linux**: Linux users can use a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/).  
+(_NOTE: Archlinux users can also use the [netradiant-git](https://aur.archlinux.org/packages/netradiant-git/) PKGBUILD_)
+-   **macOS**: macOS users can use a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/). 
+-   **FreeBSD**: FreeBSD users can use a precompiled version downloadable from the [NetRadiant website](https://netradiant.gitlab.io/page/download/). 
 
-First open up the data folder and find the .pk3 file. (may look similar to xonotic-maps-mapping.pk3)Then take the pk3 and copy it to xonotic/data Note, .pk3 is really a renamed .zip. DONT extract it.
+People wanting to compile NetRadiant themselves can look at the [NetRadiant Repository](https://gitlab.com/xonotic/netradiant).
 
-editors note :: is this step required … im not sure —\> Now take the mapping folder and move it to the root of .xonotic (dont put it in any of the data folders)
+### Step 6: Set up NetRadiant
 
-### Step 6 — Get net-radaint working
+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.
 
--   WINDOWS, you are ready to go just double click on radiant.exe
--   LINUX users may have to compile theirs, don’t worry, netradaint is rather easy to compile. If you need help ask on the forums, or irc
--   MAC … um … its possible … but complicated … someone who knows how should edit this… and you will probably need OSX 10.5 or greater
-
-### Step 7 — Setting up netradiant
-
-When you first start up radiant it may ask where the install location is. Simply, point it to the install location. Then net radaint should start,and the lower right pane should have lists of texture packs. If there are no texture packs, then refer back to step 5.
-
-\<\< [mapping-Introduction](mapping-Introduction) 1 [mapping-NetRadiant](mapping-NetRadiant) \>\>
-
-… [Creating_Maps](Creating_Maps) …
+\<\< [Introduction](mapping-Introduction) | [NetRadiant](mapping-NetRadiant) \>\>
 
+… [Creating_Maps](Creating-Maps) …
\ No newline at end of file