📦 SIRIUS Ui Wiki

Minecraft 26.1.1 | Data-Driven UI Framework (Version 0.3.1)

SIRIUS Ui is a mod that allows you to customize Minecraft's Title Screen, Game Selection Screen, Pause Screen, and Death Screen using simple JSON configurations and texture assets. No Java coding required – easily add images, buttons, backgrounds, and dynamic layouts.

Overview

SIRIUS Ui replaces hardcoded screens with a JSON‑based dynamic rendering system. Resource packs can override the following files:

• assets/sirius_ui/screens/title_screen.json — Title Screen layout
• assets/sirius_ui/screens/game_selection_screen.json — Game Selection Screen layout
• assets/sirius_ui/screens/pause_screen.json — Pause Screen layout
• assets/sirius_ui/screens/death_screen.json — Death Screen layout
• assets/sirius_ui/buttons/*.json — Button style definitions
• Any PNG texture files

Resource Pack Structure

Your resource pack must follow this exact folder hierarchy:

📦 your-resource-pack/
└── 📁 assets/
    └── 📁 sirius_ui/
        ├── 📁 screens/
        │   ├── 📄 title_screen.json
        │   ├── 📄 game_selection_screen.json
        │   ├── 📄 pause_screen.json
        │   └── 📄 death_screen.json
        ├── 📁 buttons/
        │   ├── singleplayer.json
        │   ├── multiplayer.json
        │   └── ...
        └── 📁 textures/
            └── 📁 gui/
                ├── custom_logo.png
                ├── btn_normal.png
                └── ...
└── 📄 pack.mcmeta

pack.mcmeta example:

{
  "pack": {
    "pack_format": 26,
    "description": "SIRIUS Ui custom UI resource pack"
  }
}

Screen Configuration

The root object of each screen JSON is screen, which can contain:

• panorama — background configuration (object or string)
• graphicsDraw — array of background layers (optional)
• elements — array of UI elements (required)
• copyright — copyright text object (title screen only, optional)

Background (panorama)

Three forms are supported:

• "panorama": "vanilla" — vanilla dynamic panorama background
• "panorama": "none" — solid black background
• "panorama": { "type": "image", "texture": "namespace:path/image" } — custom image, automatically scaled and centered to fill the screen (preserves aspect ratio, similar to CSS background-size: cover). Example texture path: "sirius_ui:textures/gui/background.png".

Background Layers (graphicsDraw)

graphicsDraw is an array of colored rectangles drawn between the background and regular elements. Useful for masks, decorative lines, semi‑transparent overlays, etc. Each rectangle object contains:

Elements (elements)

The elements array can contain objects of the following three types, each must have a "type" field to distinguish the type.

🖼️ Logo Element (type: "logo")

Displays a static image (e.g. mod logo, decoration).

🔘 Button Element (type: "button")

Interactive button with support for different state textures, text, and actions.

📝 Text Element (type: "text")

Displays text, supports static localization keys, dynamic game data, scaling, shadow, and custom color.

Copyright (copyright)

Only used on the title screen, for copyright text at the bottom. Object fields:

Button Style

A button style file (e.g. buttons/default.json) must contain a top‑level object button with the following fields:

Actions

The action field of a button is an object containing type and optional parameters. Supported action types:

Coordinate System & Expressions

Origin

The origin (0,0) is at the top‑left corner of the screen. X increases to the right, Y increases downward.

Element Anchor

The position field defines the top‑left corner of the element, not its center.

Correct centering expressions:

"x": "(width - elementWidth)/2"
"y": "(height - elementHeight)/2"

Expression Variables & Operators

Supported variables:

• width — current screen width (scaled pixels)
• height — current screen height
• elementWidth — element's own width (for buttons, from size.width; for text, the rendered width, affected by scale)
• elementHeight — element's own height (similar)

Operators: + - * / ( ), integer division truncates. Shortcuts:

• "center" → "(width - elementWidth)/2" (for x coordinate only)
• "bottom-20" → "height - elementHeight - 20" (for y coordinate only)

Common Alignment Formulas

Configuration Examples

Complete death screen configuration demonstrating all features:

{
  "screen": {
    "panorama": "vanilla",
    "graphicsDraw": [
      { "x": "0", "y": "0", "width": "width", "height": "height", "color": "#88000000" },
      { "x": "width/2 - 140", "y": "height/2", "width": 280, "height": 1, "color": "#88FF0000" }
    ],
    "elements": [
      {
        "type": "text",
        "text_key": "deathScreen.title",
        "position": { "x": "center", "y": "height/5" },
        "color": "#FF0000",
        "scale": 2.5,
        "shadow": true
      },
      {
        "type": "text",
        "dynamicType": "death_cause",
        "position": { "x": "width/2 - 140", "y": "height/2 - 30" },
        "color": "#FFFFFF"
      },
      {
        "type": "text",
        "dynamicType": "score",
        "position": { "x": "width/2 + 140", "y": "height/2 - 30" },
        "color": "#FFFFAA"
      },
      {
        "type": "button",
        "text_key": "deathScreen.respawn",
        "style": "sirius_ui:buttons/death/button_re.json",
        "position": { "x": "width/2 - 130", "y": "height * 3 / 4" },
        "size": { "width": 120, "height": 20 },
        "action": { "type": "respawn" }
      },
      {
        "type": "button",
        "text_key": "deathScreen.titleScreen",
        "style": "sirius_ui:buttons/death/button_quit.json",
        "position": { "x": "width/2 + 10", "y": "height * 3 / 4" },
        "size": { "width": 120, "height": 20 },
        "action": { "type": "exit_to_title" }
      }
    ],
    "copyright": {
      "textKey": "auui.copyright",
      "position": { "x": "width - 10", "y": "height - 10" },
      "color": "#666666"
    }
  }
}

Troubleshooting