Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.26 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.26 KB
page_type author description ms.author ms.date languages products
sample
mammerla
An add-on for Minecraft and the Minecraft Editor for managing debug states and configuration.
07/16/2024
typescript
minecraft

Minecraft Debug Tools

This sample contains a set of simple debug tools for adding in-game and editor watches.

Prerequisites

Install Node.js tools, if you haven't already

We're going to use the package manager npm to get more tools to make the process of building our project easier.

Visit https://nodejs.org/.

Download the version with "LTS" next to the number and install it. (LTS stands for Long Term Support, if you're curious.) In the Node.js Windows installer, accept the installation defaults. You do not need to install any additional tools for Native compilation.

Install Visual Studio Code, if you haven't already

Visit the Visual Studio Code website and install Visual Studio Code.

Getting Started

  1. Use npm to install dependent modules:

    npm i

  2. Use this shortcut command to open the project in Visual Studio Code:

    code .

Running the parts of our project

Within the root folder (debug_tools) of this sample, run this command:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass

Run this one to deploy in the game.

npm run local-deploy

If you'd like to run deployment in a watch mode, run the following:

npm run local-deploy -- --watch

Run this one to deploy in the editor mode.

npm run local-deploy-editor

Manifest

  • just.config.ts: This file contains build instructions for just-scripts, for building out TypeScript code.
  • scripts: This contains Debug Tools TypeScript files, that will be compiled and built into your projects.
  • behavior_packs: This contains resources and JSON files that define your behavior pack.