Skip to content

Commit

Permalink
Expanded Getting Started
Browse files Browse the repository at this point in the history
getting started now has 2 new sections:
- MacroKey Rundown
- Setting up your first Macro
  • Loading branch information
Matts committed May 18, 2018
1 parent f59d953 commit 62b20a8
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 7 deletions.
43 changes: 41 additions & 2 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Getting Started

Welcome to MacroKey, getting started is easy! This doc will show you how to get up and running with it.

-------------------

Installation
-------

Expand All @@ -18,11 +20,48 @@ You can download the mod through one of the :doc:`official mirrors <links>`. Whe

.. 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
--------------------

MacroKey Rundown
----------

MacroKey adds a few concepts into Minecraft, these concepts are Macro's & Layers.

**Macro's** are the main concept of the mod, they add an idea of connecting a chat message to a key press.

**Layers** allow you to group Macro's together that you use frequently on different occasions. This is, for example, useful if you want to use the same key for different commands, when on different servers.

MacroKey tries to add as much functionality, all while keeping it as logical and user-friendly as possible, this statement is mainly reflected in GUI's.
The mod adds various screens to make the management of your settings easy.

---------------------

Setting up your first Macro
----------

Open the Management GUI, for this you have two options:
- Go to Settings -> MacroKey Keybinding
- Press the MacroKey Management key while ingame (default: `k`)

Within Management, at the right bottom you can see the Create Macro button. Clicking this button will open the screen for adding macros to your configuration. When creating a new Macro, you will have to specify:

- The chat message you want to send
When specifying a command, you will have to prefix it with a slash (`/`), this is to keep support for sending normal chat messages with MacroKey.
- The trigger (key) that should be pressed to activate the Macro
The trigger can be any key on your keyboard, with exception to special macro buttons your keyboard may have. In theory, the trigger is optional. The Macro will, however, never be activated without a trigger.
- If the command should repeat
When enabling this setting, the command will repeat as long as you are pressing the specified key. The delay can be configured.
- Should the macro be active
Disabling the Macro has the same effect as not specifying a trigger. This setting allows you to keep your current trigger, and just ignore it.

After adding all information requested, you can press save. You will be redirected to the Management screen, here the macro you just added will be shown. At this point you can confirm that the Macro is saved, and it is usable in-game.


.. _Minecraft Forge download site: https://files.minecraftforge.net
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ What if there was a mod that makes your life easier by allowing you to connect a
.. toctree::
:maxdepth: 2
:caption: Documentation:

getting-started
links
8 changes: 4 additions & 4 deletions docs/source/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@ Official Links
===============

Endorsed Posts
^^^^^^
* `MacroKey on CurseForge`_
^^^^^^^^^
* `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
.. _CurseForge Project Files: https://minecraft.curseforge.com/projects/macrokey-keybinding/files

0 comments on commit 62b20a8

Please sign in to comment.