Continue usage documentation

Amulet-Team · Aug 18, 2020 · bfbaa67 · bfbaa67
1 parent 006c24a
commit bfbaa67
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 1 deletion.
diff --git a/docs/_static/images/world_screen.png b/docs/_static/images/world_screen.png
diff --git a/docs/_static/images/world_select.png b/docs/_static/images/world_select.png
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -1,6 +1,8 @@
 Getting Started
 ===============
 
+.. _installing-amulet-ref:
+
 Installing Amulet
 -----------------
 
@@ -26,9 +28,14 @@ file into a directory. Once finished, run the appropriate executable for your op
 * OSX: ``amulet_app.app``
 * Linux: *TODO*
 
+.. _opening-a-world-ref:
+
 Opening a World
 ---------------
 
+:emphasis:`Note: We recommend that any world that is to be opened by Amulet is backed up to
+avoid any loss of data`
+
 When starting Amulet, you should be presented with a screen similar to
 the following:
 
@@ -38,6 +45,39 @@ the following:
 
     The start screen of Amulet
 
+After clicking the ``Open World`` button, you will be presented with the following pop-up dialog:
+
+.. figure:: _static/images/world_select.png
+    :scale: 75 %
+    :align: center
+
+    The world select pop-up dialog
+
+The worlds on the right side of the dialog will be worlds that have previously been opened by Amulet
+and clicking the ``Open other world`` button will show a directory choosing dialog. Using this dialog,
+select the world directory that you wish to open and then select ``Select folder``
+
+Once the world has successfully been loaded by Amulet, the following be be displayed:
+
+.. figure:: _static/images/world_screen.png
+    :scale: 75 %
+    :align: center
+
+    The world screen
+
+From this screen, a summary of information about the world is displayed such as the world name, the
+last version and platform of Minecraft the world was opened in, and the ending of the file path where
+the world is located.
+
+On the left side there are 3 tabs, with the current being the ``About`` tab, where various sub-programs
+of Amulet can be accessed and used.
+
+As of v0.7.0.1, these tabs are:
+
+* ``About`` - Summary of the opened world's information
+* ``Convert`` - The Amulet world converter, see the :doc:`/world_converter`
+* ``3D Editor`` - The Amulet 3D editor, see the :doc:`/world_editor`
+
 
 .. _README: https://github.com/Amulet-Team/Amulet-Map-Editor#running-from-source
 .. _Github Releases: https://github.com/Amulet-Team/Amulet-Map-Editor/releases
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,14 +3,23 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+=============================================
 Welcome to Amulet-Map-Editor's documentation!
 =============================================
 
+User Guide
+==========
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
    getting_started
+   world_converter
+   world_editor
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Operation Development
 
 
 

diff --git a/docs/world_converter.rst b/docs/world_converter.rst
@@ -0,0 +1,6 @@
+World Converter Tutorial
+========================
+
+Converting a world
+------------------
+
diff --git a/docs/world_editor.rst b/docs/world_editor.rst
@@ -0,0 +1,3 @@
+World Editor Tutorial
+=====================
+