This repository contains a set of scripting libraries for use with the minecraft scripting modules in creating content for the game. The repository is structured as a javascript "monorepo" that contains multiple packages. These packages are fully javascript and are typically intended to server as helper libraries that can be commonly used when creating content. The libraries are provided both through NPM, but also in pre-bundled forms in cases where user workflows do not leverage techniques such as bundling for their own content creation.
More details on each individual library are in the README files for individual packages. The packages are located generally within the libraries subfolder.
- Install the latest LTS of Node (20 or higher) and confirm after installation that you have NPM 10 or higher also installed.
- It is recommended to use nvm or nvm-windows for ease of management of node version installation.
- Globally install the turbo tool using the command
npm install --global turbo. The turbo tool is used under the covers for all of the build scripts, and having it accessible globally is convenient for running builds from subdirectories as well.
Run
npm installfrom the root of this repository to install all appropriate dependencies.
To build all packages, run
npm run build
This will build all packages in this repository in the right order using turbo. This is equivalent to running turbo build. If you would like to build or work on a specific package, perform a full build first, and then navigate to the package you care about and from there you can then run npm run build to build that specific package. Each individual package has it's own README and potentially additional scripts. Refer to the readme per package for more information.
All packages are validated via ESLint with a consistent set of rules as well as enforces styling through prettier. To explicitly run linting, use npm run lint, and some changes can be fixed automatically with npm run lint -- --fix
All packages support testing via vitest. Tests are authored with the .test.ts suffix and tests can be run with npm run test.
See Contributing.md for details on contributions
Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.
