-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Installation and official links added
- Loading branch information
Showing
3 changed files
with
46 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |