Finished world converter documentation

Amulet-Team · Aug 20, 2020 · cfcd316 · cfcd316
1 parent 09e3159
commit cfcd316
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/docs/_static/images/conversion_finished.png b/docs/_static/images/conversion_finished.png
diff --git a/docs/_static/images/world_screen_converter.png b/docs/_static/images/world_screen_converter.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,7 +22,7 @@
 author = "The Amulet Map Editor Team"
 
 # The full version, including alpha/beta/rc tags
-release = "0.7.0.1"
+release = "v0.7.0.1"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/world_converter.rst b/docs/world_converter.rst
@@ -1,6 +1,28 @@
 World Converter Tutorial
 ========================
 
-Converting a world
-------------------
+Things you will need:
+
+* Amulet
+* The world you want to convert (referred to as ``source world``)
+* A world from the same Minecraft platform and version you want the world to be converted to (referred to as ``destination world``)
+
+1. Load the ``source world`` into Amulet
+2. Once the world has been loaded, launch the ``Convert`` sub-program
+
+.. figure:: _static/images/world_screen_converter.png
+    :scale: 75 %
+    :align: center
+
+    The ``Convert`` sub-program can be found on the left side of the world screen
+
+3. Click the ``Select Output World`` button and follow the same world loading process and select your desired ``destination world``
+4. Once the ``destination world`` has been loaded, click the ``Convert`` button
+5. The progress bar should update with the progress of the conversion and the following dialog should pop-up once it reaches the end:
+
+.. figure:: _static/images/conversion_finished.png
+    :scale: 75 %
+    :align: center
+
+6. Once the conversion finishes, you can close Amulet and open the ``destination world`` in the desired/target Minecraft version/platform