API Modules

Overview ​

Script API has modules for developers to interact with Minecraft. Additionally, manifest dependencies will need to be set based on the modules used within your add-on.

Module Descriptions ​

@minecraft/common ​

Has few stable releases, this module can be imported without being mentioned in dependencies. It is a module with basic sources such as error classes or interfaces.

@minecraft/debug-utilities ​

An experimental module. This module provides debugging tools but should not be used in the public release of the addon.

@minecraft/server ​

Has a lot of stable releases, but is still being actively developed. The cornerstone for addons scripting on the server side, it is intended for interaction between the script engine and your world, such as blocks, entities, items, players, and other world resources.

@minecraft/server-ui ​

A somewhat smaller module, but very useful for the interaction between the server and the end user of your package. This is a module that provides the possibility of sending data to the player through customizable forms.

@minecraft/server-gametest ​

This is the oldest module that currently exists, yet there is not a single stable version of this module. This module is used to test vanilla experiments, for compatibility with other custom content, catching edge cases, or making sure repeatability is possible. This module is not intended for content creators and there is no need to guarantee backward compatibility with stable versions.

@minecraft/server-net ​

This is a module that is only allowed on Bedrock Dedicated Servers because it could threaten the safety of the user of common addon packages. This is a module has access to the internet through web requests such as GET, SET, POST and others. This module exists only in experimental form.

@minecraft/server-admin ​

This module is also only allowed on Bedrock Dedicated Servers. this module is responsible for processing basic data stored in JSON admin files, which is intended for setting the behavior of a pack without interfering with the original pack. This module exists only in experimental form.

@minecraft/server-editor-bindings ​

This is a special set of native functions for the editor module, this module is undocumented and should not be used by creators, however this module can be imported if you reference it in dependencies but it can only be used in worlds that are created as editor projects.

@minecraft/server-editor ​

This module is exceptional because its implementation is not native but it is a JS module, although it is implemented in JS so its existence is hardcoded, it can be referenced in dependencies but it can only be used in worlds that are created as editor projects.

Alpha Versions ​

Alpha version is an outdated version of modules, this version should not be used in current addons and is marked as experimental, only two modules have this alpha version, @minecraft/server then known as mojang-minecraft and @minecraft/server -gametestthen known asmojang-gametest`. If you want to try to use this version, keep in mind that they should only be imported under these names.

Alpha 2.X ​

Now you can also notice the new alpha 2.X series, but this is different from the original alpha version, but it is also an experimental version, but it can easily be imported under the names known today, keep in mind that this version breaks compatibility with the previous serial 1.X .

Module Referencing ​

Module referencing is required for ability to import module in your JS code.

Example for @minecraft/server with version of 1.13.0.

{
    "module_name": "@minecraft/server",
    "version": "1.13.0"
}

Required capability to mark your pack as Editor Extension, in that case editor modules are allowed.

{
    "capabilities": ["editorExtension"]
}