Back to mods
Minescript HUD Addon project artwork

Modrinth · Minecraft mod

Minescript HUD Addon

This mod adds the ability to draw custom HUD elements in Minescript.

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Minescript HUD Addon release should I use?

Updated 3 months ago
Latest stable file 1.3.0
Game version 1.21.10, 1.21.11
Loader Fabric

Minescript HUD Addon 1.3.0 targets 1.21.10, 1.21.11 with Fabric. It must be installed on the client. Do not install it on the dedicated server. All 2 required mods have matching files.

Where it goes

Is Minescript HUD Addon required on the client, server, or both?

It must be installed on the client. Do not install it on the dedicated server.

Client Required
Dedicated server Not supported
Loader for this release Fabric
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This file is marked client-only.

What else does Minescript HUD Addon 1.3.0 need?

1.3.0. Change the file and its required mods may change too.

All 2 required mods have matching files

Install Fabric API, Minescript first. We found matching files for this game-version and loader setup.

Fabric API Needed by Minescript HUD Addon 1.3.0
required
Matching file found Matched file: 0.141.6+1.21.11
Minescript Needed by Minescript HUD Addon 1.3.0
required
Matching file found Matched file: 5.0-fabric-1.21.11

We only count dependency files that match this setup. A file for another loader does not fill the gap.

Before you install it

Add Minescript HUD Addon without breaking your instance.

Built for Minescript HUD Addon 1.3.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.3.0. It targets 1.21.10, 1.21.11 with Fabric; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    Install Fabric API, Minescript first. We found matching files for this game-version and loader setup.

  3. 03

    Put it on the correct side

    It must be installed on the client. Do not install it on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.3.0. It opens that exact file at the source.

About this project

What does Minescript HUD Addon add?

Minescript HUD Addon

This mod adds the ability to draw custom HUD elements in Minescript.

For rendering objects in the world, I will be making a seperate mod.

Documentation can be found in the wiki.

Bugs/Features

If you have any suggestions, or found any bugs, please fill out this google form.

currently working on adding in world drawing.



Features

  • Draw text on the HUD
  • Draw rectangles and gradient rectangles
  • Render items
  • Render textures
  • Render custom shapes
  • Animate all element properties
  • Detect mouse hover and click events
  • Control display duration and render layers



Installation

  1. Install Minescript.
  2. Place this addon in your mods folder.
  3. Launch the game.



Example

from hud_renderer import *

add_text("Hello World",x=10,y=10,color=argb(255,255,255,255),shadow=True,display_duration=5)



Animations

All HUD elements can be animated using animation functions.

from hud_renderer import *

def move(text:TextObject):
    text.x+=1

_id=add_text("I can MOVE!",x=10,y=10,color=Colors.WHITE,shadow=True,display_duration=5)

animate_text(_id,move)



Mouse Events

All objects can detect mouse hover and click events.

from minescript import echo
from hud_renderer import *

def hover(text:TextObject,mouse:MouseObject,exited:bool):
    if (exited):
        text.color=Colors.WHITE
    else:
        text.color=Colors.GREEN

def click(text:TextObject,mouse:MouseObject):
    echo("Clicked!")

_id=add_text("Click me!",x=10,y=10,color=Colors.WHITE,shadow=True,display_duration=10)

add_mouse_callbacks_and_wait(_id,on_hover=hover,on_click=click)



Layer System

Elements are rendered in layers.
Elements with higher layer values render above elements with lower layers.


API Overview

A more detailed API can be found on the wiki.

Text

  • add_text(...)
  • add_text_with_background(...)
  • add_advanced_text(...)
  • add_advanced_text_with_background(...)
  • animate_text(...)
  • animate_text_with_background(...)

Rectangles

  • add_rectangle(...)
  • add_rectangle_from_corners(...)
  • add_gradient_rectangle(...)
  • add_stroked_rectangle(...)
  • animate_rectangle(...)

Items

  • add_item(...)
  • add_advanced_item(...)
  • animate_item(...)

Textures

Note: Custom textures must be added by a resource pack in the assets/minescripthud/textures/gui/sprites/ folder.

  • add_texture(...)
  • add_advanced_texture(...)
  • animate_texture(...)

Shapes

  • add_shape(...)
  • add_advanced_shape(...)
  • animate_shape(...)
  • add_line(...)
  • add_multiline(...)
  • add_triangle(...)
  • add_quad(...)
  • add_circle(...)
  • add_ellipse(...)

Anti-Aliased Shapes (with smooth edges)

  • add_anti_aliased_shape(...)
  • add_advanced_anti_aliased_shape(...)
  • animate_anti_aliased_shape(...)
  • add_line_with_thickness(...)
  • add_anti_aliased_quad(...)
  • add_anti_aliased_rectangle(...)
  • add_anti_aliased_rectangle_with_round_corners(...)
  • get_points_for_circle(...)
  • add_anti_aliased_circle(...)
  • get_points_for_ellipse(...)
  • add_anti_aliased_ellipse(...)

Utility functions

  • argb(...)
  • argb_to_int(...)
  • alpha_from_int(...)
  • add_async_mouse_callbacks(...)
  • add_mouse_callbacks_and_wait(...)
  • wait_until_removed(...)
  • remove_element(...)
  • clear()
  • suppress_done_message()

Project description from Modrinth.

Pick your setup

Minescript HUD Addon by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

8 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Minescript HUD Addon versions and loaders

29 of 29 releases match

Looking for an older file? The official Modrinth project page is in Resources.