Back to mods
Spis Ui Api project artwork

Modrinth · Minecraft mod

Spis Ui Api

Library mod that adds easy to use UI elements like Custom Fonts or animated textures

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

Quick answer

Which Spis Ui Api release should I use?

Updated 21 days ago
Latest stable file 1.0.0
Game version 1.21.1
Loader NeoForge

Spis Ui Api 1.0.0 targets 1.21.1 with NeoForge. Installation on the client is optional. Installation on the dedicated server is optional. No extra mods listed for this file.

Where it goes

Is Spis Ui Api required on the client, server, or both?

Installation on the client is optional. Installation on the dedicated server is optional.

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

The source marks this as usable on both the client and server.

What else does Spis Ui Api 1.0.0 need?

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

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add Spis Ui Api without breaking your instance.

Built for Spis Ui Api 1.0.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.0.0. It targets 1.21.1 with NeoForge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    Installation on the client is optional. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

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

About this project

What does Spis Ui Api add?

Who It's For?

This library is mainly for use in my mods, to streamline creating ui/gui interfaces.
However anyone can use this mod as a dependency to use its features.

Why Use It?

Currently the mod does the following;
A new set of drawStrings(), which adds easily accessed custom fonts, aswell as wordwrapping to custom bounding boxes, and setting the alignment to left/center/right.
Quick Example

How Use It?

Github Wiki
Imports

import net.spidrone.uiapi.UIAnimationManager;  
import net.spidrone.uiapi.UIGraphicsHelper;  

Animated Graphics

UIAnimationManager.drawGif(GuiGraphics graphics, String imagePath, int x, int y, int frameWidth, int frameHeight, int totalFrames, int fps, float scaleX, float scaleY, float red, float green, float blue)

Custom drawString()

UIGraphicsHelper.drawCustomFont(GuiGraphics graphics, ResourceLocation fontLocation, String message, int x, int y, int color, boolean dropShadow, TextAlign align)

Custom drawString() with bounding boxes/autowrap/line splitting

UIGraphicsHelper.drawCustomFontBound(GuiGraphics graphics, ResourceLocation fontLocation, String message, char splitChar, int x1, int y1, int x2, int y2, int color, boolean dropShadow, TextAlign align)

not including something like the fontLocation will cause it to use the default font
align : LEFT/CENTER/RIGHT

splitChar "$" will cause hi$world to appear on your ui as

hi
world

Register your fonts ttf by placing them in your assets folder
assets/modid/font
in the same folder include a .json file

{
  "providers": [
    {
      "type": "ttf",
      "file": "spis_ui_api:boldpixels.ttf",
      "shift": [0.0, 0.0],
      "size": 16.0,
      "oversample": 2.0
    }
  ]
}

Declare the fonts resource location in your ui

public static final ResourceLocation BOLD_PIXELS_FONT = ResourceLocation.fromNamespaceAndPath("spis_ui_api", "boldpixels");

Credits

Bold Pixels : https://yukipixels.itch.io/boldpixels
The font is absolutely perfect for minecraft

Extras

Q: Do you support X version
A: This library will mostly be used by me for my own projects, If you'd like to request a version you can join the discord, but nothing before 1.21.1 will be considered

Project description from Modrinth.

Pick your setup

Spis Ui Api by Minecraft version and loader

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

1 available setups

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

Recent files

Spis Ui Api versions and loaders

6 of 6 releases match

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