Skip to content

Command Line

PokeJofeJr4th edited this page Jul 14, 2023 · 2 revisions

Required Arguments

minescript <PATH> <NAMESPACE> minescript src.txt my_project

PATH

This is the path to your source file. If you run the command from the folder your code is in, this should be something simple like src.txt.

NAMESPACE

This is the namespace your project will be built into. It's important to note that minescript will delete any existing datapacks it finds with this name.

Flags

You can add flags after the required arguments to change how minescript behaves.

Verbose

minescript ... -v minescript ... --verbose

With this flag enabled, minescript will print out detailed data on how it interprets your code. This is most useful for debugging and submitting issues.

World

minescript ... -w <WORLD> minescript ... --world <WORLD>

Without this flag, minescript writes to .minecraft/datapacks/<NAMESPACE>. With this flag, it writes to .minecraft/saves/<WORLD>/datapacks/<NAMESPACE>.

Hot Reloading

minescript ... -r minescript ... --reload

When you use this flag, minescript will monitor your source files. Whenever they change, it will rebuild your project. If you combine this with the -w flag, you can apply your changes in Minecraft with just the /reload command.

Help

minescript -h minescript --help

This flag doesn't run minescript, and instead displays a short description of how you can call minescript.

Clone this wiki locally