Skip to content

Commit

Permalink
Installation and official links added
Browse files Browse the repository at this point in the history
  • Loading branch information
Matts committed May 16, 2018
1 parent 6ccaabf commit f59d953
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 10 deletions.
28 changes: 28 additions & 0 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
@@ -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 <links>`. 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
11 changes: 2 additions & 9 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
17 changes: 16 additions & 1 deletion docs/source/links.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
Official Links
===============

* https://minecraft.curseforge.com/projects/macrokey-keybinding
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

0 comments on commit f59d953

Please sign in to comment.