.. Minescript HUD Addon documentation master file, created by
   sphinx-quickstart on Tue Mar 10 17:21:13 2026.

Home
====

Minescript HUD Addon documentation
----------------------------------
.. warning::
   This wiki is still under development!

   If you find anything unclear, please create an `issue <https://github.com/maksymiblue12/Minescript-Hud-Addon/issues>`_ on github.

| **Minescript HUD Addon** is a Minecraft mod that enables scripts to render custom elements on the Minecraft HUD.
| It extends `Minescript <https://modrinth.com/mod/minescript>`_ by providing additional functions for drawing **text**, **rectangles**, **items** and even **custom textures** directly on the screen.
|
| You can find the source code on `github <https://github.com/maksymiblue12/Minescript-Hud-Addon>`_.
| If you find any bugs, please report them on the `issue tracker <https://github.com/maksymiblue12/Minescript-Hud-Addon/issues>`_.


Contents
--------

.. toctree::
   :maxdepth: 2

   self
   installation
   custom_textures
   api/index.rst