Resource Links

A list of links related to resources for Minecraft Script API. I'll try to keep this page up to date with useful content. This webpage is made since all the Script API documentation are all over the place, and I'm definitely not part of the problem...

JavaScript Fundamental

• Codecademy: Introduction to JavaScript

  Learn how to use JavaScript — a powerful and flexible programming language in an interactive way.

• MDN: JavaScript language overview

  An article written by Mozilla which provides begineer-level information for JavaScript language.

• freeCodeCamp.org: JavaScript Algorithms and Data Structures

  Learn the fundamentals of JavaScript including variables, arrays, objects, loops, and functions.

• TypeScript: Documentation - Interfaces

  Interfaces are capable of describing the wide range of shapes that JavaScript objects can take. It is used frequently in Minecraft Script API.

  Warning

  Interfaces is one of TypeScript’s core principles for type checking, and interface syntax is not supported in JavaScript.

Script API

Microsoft Learn

Getting Started with Script API

• Introduction to Scripting in Minecraft

  An introducion to writing and deploying scripts in Minecraft: Bedrock Edition

• Official Script API Documentation

  Microsoft's official documentation of high-level introduction of experimental Script API

@minecraft/server Related Documentation

• Stable API Reference

  Reference documentation for @minecraft/server latest stable APIs

• Beta API Reference

  Reference documentation for @minecraft/server preview beta APIs

• Game Loops and Timed Callbacks

  High level introduction to system.run(), system.runInterval() and system.runJob() functions within the @minecraft/server module.

• Custom Components

  Guide to connect the configuration of Blocks and Items in JSON to scripting

Other Minecraft Modules and Libraries

• @minecraft/server-ui API Reference

  Reference documentation for @minecraft/server-ui latest stable APIs

  Tips

  For reference documentation for Minecraft Preview Beta APIs for @minecraft/server-ui

• Open Source Scripting Libraries

  Overview of Mojang's open source scripting libraries such as @minecraft/math and @minecraft/vanilla-data hosted on npmjs.com

• Get Started with GameTest Framework

  Introduction to the GameTest Framework / @minecraft/server-gametest module.

Using TypeScript in Scripting

• Build a gameplay experience with TypeScript

  Use TypeScript compilation and with Microsoft's build configuration for Minecraft to build a simple gameplay experience in Minecraft scripting.

• Using Type Defintion files and Minecraft Script Debugger

  Mojang provides tools for enhanced editing, debugging, and profiling of JavaScript within Visual Studio Code to write scripts more efficiently.

GitHub Repositories

• Minecraft GameTest Samples

  Sample GameTest behavior files for Minecraft Bedrock Edition. Minecraft supports GameTests - a combination of JavaScript + MCStructures - for validating facets of Minecraft behavior.

• Scripting Project Starters

  Contains various project samples for Minecraft script development.

Bedrock Wiki

• Starting Scripting

  Community documentation on starting a project that utilize Minecraft Scripting API

• BeforeEvents privilege system

  Overview of BeforeEvents privilege system, the feature which throws the following error at times: Native function does not have required privileges.

• Creating Script UI Forms

  Using @minecraft/server-ui module to create form UIs without the need for JSON UI-wrangling in Minecraft.

• Script Requests API

  Send and receive HTTP-based requests to interact with the internet using @minecraft/server-net module.

  Warning

  This feature is only available to Bedrock Dedicated Servers, and it cannot be used on Minecraft clients.

• Script Watchdog System

  Overview of Watchdog performance system in Minecraft script engine.

Scripting Q&A with Microsoft/Mojang

• GameTest Q&A 2021/08/06

  Questions and answers about the Scripting API back in 2021.

• Scripting and Editor Q&A 2023/09/22

  Questions and answers about the Scripting and Editor API.

Others

• Jayly's Script API examples

  Community driven script examples for Minecraft Bedrock Script API.

• Bundle Minecraft Scripts with ESBuild and Regolith

  Merge Minecraft script files through bundling with esbuild and regolith. Using Mojang's open source libraries, such as @minecraft/math in scripts, require it.