Installation
============

Requirements
------------

- Minecraft 1.21.11
- Fabric mod loader
- Minescript (dependency)

1. Install the Mod Loader
-------------------------

Download and install the Fabric mod loader:

https://fabricmc.net

Run the installer and start Minecraft once. This will create the ``mods`` folder
inside your Minecraft directory.

2. Install Dependencies
-----------------------

| Download a `supported version <https://modrinth.com/mod/minescript/version/5.0b11-fabric-1.21.11>`_ of Minescript and place it in the ``mods`` folder.
| Also download the `Fabric API <https://modrinth.com/mod/fabric-api>`_ and place it in the ``mods`` folder.

3. Install the Mod
------------------

Download the latest version of `Minescript HUD Addon <https://modrinth.com/mod/minescript-hud-addon/versions>`_ and place the ``.jar`` file
into the same ``mods`` folder.

4. Launch Minecraft
-------------------

Start Minecraft using the Fabric profile in the launcher.
If the installation was successful, the mod will load automatically.

.. note::
   Make sure all mods use the same Minecraft version.

.. warning::
   Installing incompatible versions of Minescript may cause Minecraft
   to fail during startup.