From f59d953072af87b20af2605c2798dfc7c0455054 Mon Sep 17 00:00:00 2001 From: Mata Date: Wed, 16 May 2018 23:27:08 +0200 Subject: [PATCH] Installation and official links added --- docs/source/getting-started.rst | 28 ++++++++++++++++++++++++++++ docs/source/index.rst | 11 ++--------- docs/source/links.rst | 17 ++++++++++++++++- 3 files changed, 46 insertions(+), 10 deletions(-) create mode 100644 docs/source/getting-started.rst diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst new file mode 100644 index 0000000..c39bafc --- /dev/null +++ b/docs/source/getting-started.rst @@ -0,0 +1,28 @@ +Getting Started +============= + +Welcome to MacroKey, getting started is easy! This doc will show you how to get up and running with it. + +Installation +------- + +Install Forge +^^^^^^^ +To install Forge, head to the `Minecraft Forge download site`_, here you can download forge for the Minecraft version you wish to use. After downloading, run the `.jar` file. Make sure `Install Client` is checked, and press `OK`. + +**Note:** Older versions of Minecraft may require you to have run a vanilla installation at least once + +Install MacroKey +^^^^^^^ +You can download the mod through one of the :doc:`official mirrors `. When downloading, take note of the Minecraft version that the mod supports. The mod will not load on a game version it does not support. + +.. note:: | When supporting multiple versions, the patch field will contain an `x`. + | *i.e.* when `1.12`, `1.12.1` & `1.12.2` are supported, the version in the title will be `1.12.x` + +After downloading MacroKey, open the `.minecraft` directory (`Win + R` -> `%appdata%/.minecraft`). If a mods directory does not already exist, you can create one here. After that, you can drag the downloaded `MacroKey .jar` file into it. + +Verifying Installation +^^^^^^^ +To verify everything is installed correctly, start Minecraft, making sure that you are starting up the Forge instance. Once Minecraft has started, click on the Mods button. Here `MacroKey` should be listed. + +.. _Minecraft Forge download site: https://files.minecraftforge.net \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 6aa4a96..1d7ff16 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,14 +7,7 @@ What if there was a mod that makes your life easier by allowing you to connect a .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: Documentation: + getting-started links - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/source/links.rst b/docs/source/links.rst index 49e0f6d..d8e02f3 100644 --- a/docs/source/links.rst +++ b/docs/source/links.rst @@ -1,4 +1,19 @@ Official Links =============== -* https://minecraft.curseforge.com/projects/macrokey-keybinding \ No newline at end of file +Endorsed Posts +^^^^^^ +* `MacroKey on CurseForge`_ +* `MacroKey on Curse`_ +* `MacroKey on MCF`_ +* `MacroKey on PMC`_ + +Download Mirrors +^^^^^^ +* `CurseForge Project Files`_ + +.. _MacroKey on CurseForge: http://www.curseforge.com/projects/243479/ +.. _MacroKey on Curse: http://curse.com/project/243479 +.. _MacroKey on MCF: http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/2698256-forge-macrokey-keybinding-for-minecraft-1-8-1-8-8 +.. _MacroKey on PMC: https://www.planetminecraft.com/mod/forge-macrokey-19/ +.. _CurseForge Project Files: https://minecraft.curseforge.com/projects/macrokey-keybinding/files \ No newline at end of file