Update Programming Tips
[xonotic/xonotic.wiki.git] / Mapping-Setup.md
index 14359d5..84852a2 100644 (file)
@@ -1,51 +1,43 @@
-Mapping-Setup
-=============
+Mapping - Setup
+===============
 
 How to get your system all set up to start mapping
 --------------------------------------------------
 
-### Step 1 — Obtain mapping support
+### Step 1: Obtain mapping support
 
-If you didn’t already, download this … http://dl.xonotic.org/xonotic-0.8.1-mappingsupport.zip
+If you didn’t already, download the [mapping support zip](http://dl.xonotic.org/xonotic-0.8.2-mappingsupport.zip)
 
-### Step 2 — Extract zip
+### Step 2: Extract 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: 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 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: Moving 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**: The mapping support zip contains a compiled version of NetRadiant in the `mapping` folder
+-   **Linux**: Linux users need to compile NetRadiant themselves (see [NetRadiant Repo](https://gitlab.com/xonotic/netradiant)) or can download a compiled version [here](http://ingar.intranifty.net/gtkradiant/index.html)
+-   **Mac**: Current versions of MacOS/OSX don't seem to work because of gtkglext, compiled versions from [here](http://ingar.intranifty.net/gtkradiant/index.html) might work
 
-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.
+### Step 6: Setting up 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)
+When you first start up radiant it may ask where the engine path is. Simply, point it to the xonotic install location. Then NetRadaint should start,and the lower right pane should have lists of texture packs. If there are no texture packs, then refer back to step 4.
 
-### Step 6 — Get net-radaint working
-
--   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) \>\>
+\<\< [Introduction](mapping-Introduction) | [NetRadiant](mapping-NetRadiant) \>\>
 
 … [Creating_Maps](Creating-Maps) …