Skip to content
BasaltSoftware
Bedrock 1.26.60

Site colour

Discord
Esc

    ↑↓ moveEnter openEsc close

    Keyboard shortcuts
    Ctrl K
    Search the whole site, from any page
    /
    Jump to the sidebar search, or search the whole site where there isn't one
    Enter
    Open the top search result
    Esc
    Clear the search, or close this panel
    ?
    Show these shortcuts
    Home

    Plugin API

    Write plugins for Basalt in TypeScript or JavaScript.

    2 min read · 5 sections
    On this page

    Basalt plugins are behaviour packs with scripts. They run against Basalt’s port of the @minecraft/server API, so most scripts written for vanilla work as they are, and Basalt adds a few modules and methods of its own.

    Start here

    Section titled “Start here”

    Your first plugin goes from an empty folder to a running plugin. The search box at the top of the sidebar finds any class, method, property or event by name.

    Guides

    Section titled “Guides”

    Each guide covers one area, with working examples in TypeScript.

    Your first pluginGo from an empty folder to a running Basalt plugin, with TypeScript checking in your editor. EventsSubscribe to before and after events, cancel actions, and follow the rule about reads inside before events. Custom commandsRegister your own slash commands with typed parameters, enums and permission levels. FormsShow button menus, confirmation dialogs and input forms with @minecraft/server-ui. Dynamic propertiesSave plugin data on the world, on players and entities, on items and on blocks, plus tags for simple flags. ScoreboardsCreate objectives, track scores for players and fake players, and show them on screen. HTTP requestsCall web APIs, post to webhooks and open WebSockets from a plugin with @minecraft/server-net. Script eventsTrigger plugin code with the /scriptevent command, and send messages between plugins. Container menusOpen chest-style menus with clickable item slots using Basalt's @basalt/menus module. Differences from BDSWhat behaves differently from Bedrock Dedicated Server's scripting, what is missing and what Basalt adds.

    Modules

    Section titled “Modules”

    The reference is generated from Basalt’s typings. The typings follow Mojang’s API closely and declare more than Basalt implements; Differences from BDS lists what is missing.

    @minecraft/serverThe world, players, entities, blocks, items, events, commands and scoreboards. @minecraft/server-uiAction, message and modal forms. @minecraft/server-netHTTP requests and WebSockets from plugins. @basalt/menusBasalt's own container menus: chest-style windows with no block behind them.

    Installing a plugin

    Section titled “Installing a plugin”

    Drop the plugin’s folder, with its manifest.json and scripts/, into plugins/.

    Typings

    Section titled “Typings”

    TypeScript typings for every module ship with Basalt in typings/, and Basalt writes them into plugins/node_modules on every start. The reference pages here are generated from them.