STOOL-API

API used for Minecraft Bedrock Edition ScriptAPI development.

Warning: This repository is still in development. While it can be used, some functions may be less effective and are subject to future improvements.

---

📁 Configuration

Path: scripts/config.js

The configuration is designed for file-based management, avoiding in-game adjustments to simplify development.

const config = {
    /** 
     * # DONT CHANGE THIS!!
     * @dev_spot 
     */
    version: "1.0.5",
    creator: "Nperma",
    github: "https://github.com/nperma",

    /** @configuration */

    prefix: ["+", "-", "?", "!"], // Default command prefixes
    admin_tag: "perm.admin", // Admin tag
    log: {
        message: true,
        teleport: true
    },
    default_title: "§l§2[§aSERVERTOOL§l§2]§r §7»§r ",
    default_balance: 2000,
    numeric_symbol: ["", "k", "M", "B", "T"],
    home: {
        countdown: 3, // 3 seconds
        homelimit: {
            /** @type {Object} @property {Tag} key @property {limithome} value */
            default: 2,
            "perm.admin": 20,
            vip: 5,
            mvp: 8,
            legend: 12
        }
    },
    warp: {
        countdown: 3,
        teleportbroadcast: true // Broadcast teleport to all players
    }
    // Under development...
};

📝 Default Manifest

{
    "format_version": 2,
    "header": {
        "name": "§l§bStool-API",
        "description": "Inspired by WhatsApp Bot Style",
        "uuid": "117b23ff-ea32-407e-9a30-c5f4a890d626",
        "version": [1, 0, 0],
        "min_engine_version": [1, 21, 20]
    },
    "modules": [
        {
            "type": "data",
            "description": "Supports Realm and Server",
            "uuid": "10d70681-9c08-432e-adfe-c8c5e5da18bd",
            "version": [1, 0, 0]
        },
        {
            "description": "",
            "uuid": "59f9e579-38b3-4bce-8e20-732c2f9e82e0",
            "version": "1.1.0-beta",
            "type": "script",
            "language": "javascript",
            "entry": "scripts/nperma/index.js"
        }
    ],
    "dependencies": [
        {
            "module_name": "@minecraft/server",
            "version": "1.14.0-beta"
        },
        {
            "module_name": "@minecraft/server-ui",
            "version": "1.3.0-beta"
        }
    ],
    "capabilities": ["script_eval"]
}

🔌 Default Plugins

const PLUGIN_REGISTER = [
    /** @general */
    "help-general",
    "tps-general",
    "about-general",
    "home-general",
    "sb-general",
    "clearchat-general",
    "warp-general",
    "mods-general",
    /** @admin */
    "teleport-admin",
    /** @logger */
    "message-_log",
    /** @system */
    "join-_system",
    "leave-_system",
    "proto_openui-_system",
    /** @developer */
    "eval-dev"
];

⚙️ HANDLER Structure

/**
 * # HANDLER STRUCTURE
 * @type {Command<function>}
 * @property {boolean} admin
 * @property {string[]} commands
 * @property {string} category
 * @property {string[]} help
 * @property {string[]} custom_prefix
 * @property {boolean} no_prefix
 * @property {afterCommand<function>} after
 * @property {Interval<function>} interval
 * @property {Static<function>} static
 */

Path: scripts/nperma/index.js
Library: ./plugins

SETDEV: new Set(["NASRULGgindo","NpermaDev"]) - GamerTag developers(isDev args).

HANDLER Command/Default

Type @function (*required)

### CALLBACK ARGUMENTS
- mc = @minecraft/server
- ui = @minecraft/server-ui
- tools = ./extension/tools
- sender = Sender @type {Player}
- message = Message By Sender @type {string}
- text = Text after command @type {string}
- prefix = Prefix used @type {string}
- command = Command used by Sender @type {string}
- args = Arguments @type {string[]}
- isAdmin = Check if sender is Admin @type {boolean}
- isDev = Check if sender is Developer @type {boolean}
- database = Database object
- Database = Database @type {Map}
- attr = Plugin Default Saver @type {Command<function>}
- attr_after = Plugin After Saver @type {AfterCommand<function>}
- attr_interval = Plugin Interval Saver @type {Interval<function>}
- PLUGIN_REGISTER = Plugins

👤 Creator

• Nperma

ℹ️ About Script

This script is used for creating the latest server tool script addon with type NSS (ServerTool-NSS).

Extension

• ConDatabase

Supported Version

Latest Update: 1.21.20+
Important: Since the module uses the stable beta version, you must enable Beta-API.

• @minecraft/server^1.14.0-beta
• @minecraft/server-ui^1.3.0-beta