Minecraft Scripting UI

Create your UI Resource Packs for Minecraft Bedrock with JavaScript/TypeScript!

Installation

To install the required dependencies, run the following command in your project directory:

npm install jsonui-scripting

This will add jsonui-scripting to your project's package.json file and download the package into your node_modules directory.

How to use

The syntax is very simple, I can provide an example using code snippets displaying 'Hello World!' text on the Start Screen as follows:

// Import the JsonUIElement and Modify classes from JsonUI Scripting.
const { JsonUIElement, Modify } = require('jsonui-scripting');

// Create an image element to be used as the background for the text
const textBackground = JsonUIElement.image({
    texture: 'textures/ui/Black',
    size: "100%cm + 2px",
    layer: 10,
    alpha: 0.8
});

// Create a text element with the content "Hello World!"
const text = JsonUIElement.label({
    text: "Hello World!"
});

// Add the text element to the image background
textBackground.addElement(text);

// Insert the image background (with the text element) into the start screen's content controls
Modify.StartScreen('start_screen_content').modifications.controls.insertFront(textBackground);

And the code snippet you will receive in JsonUI format will be as follows after you run app.js:

// start_screen.json
{
    "start_screen_content": {
        "modifications": [
            {
                "array_name": "controls",
                "operation": "insert_front",
                "value": [ { "[email protected]:5:38": {} } ]
            }
        ]
    }
}

{
    "namespace": "app",
    "app-js:5:38": {
        "type": "image",
        "texture": "textures/ui/Black",
        "size": [ "100%cm + 2px", "100%cm + 2px" ],
        "layer": 10,
        "alpha": 0.8,
        "controls": [ { "[email protected]:13:28": {} } ]
    },
    "app-js:13:28": {
        "type": "label",
        "text": "Hello World!"
    }
}

Config.json

You can also create a config.json file in your project so that when the JsonUI pack is built, it will be installed into the game.

{
    "folder_name": "output_ui_pack",
    "preview": true,
    "development": true,
    "obfuscate_element_names": false,
    "debug_screen_content": false,
    "manifest": {
        "name": "pack_name",
        "version": [ 1, 0, 0 ],
        "uuid": "********-****-****-****-************",
        "description": "pack_decscription"
    }
}