From cef60ad247a3edec4aacd45016f35530c4132759 Mon Sep 17 00:00:00 2001
From: rubenwardy <rw@rubenwardy.com>
Date: Wed, 27 Dec 2017 17:36:45 +0000
Subject: [PATCH] Add documentation to ctf_map

---
 mods/ctf_map/README.md | 56 ++++++++++++++++++++++++++++++++++++------
 1 file changed, 48 insertions(+), 8 deletions(-)

diff --git a/mods/ctf_map/README.md b/mods/ctf_map/README.md
index 5d630aa..7767c3f 100644
--- a/mods/ctf_map/README.md
+++ b/mods/ctf_map/README.md
@@ -1,11 +1,51 @@
 # CTF Map
 
-## Creating a new map
+This mod handles multiple maps.
 
-* Find an area you like. It should be around 220x220 in surface area, but this
-  can vary. Feel free to modify the area to your needs.
-* Using worldedit, select the area and save it to a schematic.
-* Create a new world with singlenode and the capturetheflag_mapedit subgame.
-* Enter and run type /loads to load the WIP schematic.
-* Type /pb to place barriers.
-* Export as a schematic again.
+# Creating a new map
+
+## 1. Dependencies
+
+* Minetest 0.4.16 or later.
+* Mods
+    * ctf_map (by copying the folder from this game to `minetest/mods`)
+    * worldedit and worldedit_commands.
+
+## 2. Find an area
+
+* Can use Minetest Game and any mapgen.
+* It must be a cube, and the barrier will be in the exact center.
+* It should be around 230x230 in surface area, but this can vary.
+* Feel free to modify the area to your needs.
+
+## 3. Select the area
+
+There are multiple ways do this, this is the simplist in most cases.
+
+* If you haven't modified the map at all, do the following to speed up barrier placement:
+    * Stop Minetest.
+    * Open up the world's world.mt
+    * Set backend to "dummy".
+    * Save.
+* Using worldedit, select the area.
+* Type /gui, and click "From WE" then "To WE".
+* Check that the center location is the right place for the barrier to go.
+* Check that the bounds extend far enough.
+
+## 4. Place barriers
+
+* Set the middle barrier direction. The barrier is a plane defined by a co-ordinate = 0.
+  If the barrier is X=0, then it will placed with every node of the barrier having X=0.
+  If the barrier is Z=0, then it will placed with every node of the barrier having Z=0.
+* Click "place barrier". Note that this command does not have an undo.
+
+## 5. Meta data
+
+* Set the meta data
+
+## 6. Export
+
+* Click export, and wait until completion.
+* Copy the two files from `worlddir/schemes/` to `ctf_map/maps/`.
+* Rename the files so the two prefixed numbers are consistent to existing maps.
+* Profit!