@sprightgames/spyglass
v0.1.0
Published
Validation CLI for Minecraft Bedrock content.
Maintainers
Readme
Spyglass
Validation CLI for Minecraft Bedrock content. Checks add-ons, world templates, skin packs, texture packs, persona pieces, and emotes, and reports every problem with a stable ID such as MANIFEST/601.
Install
Node 22 or later.
npm install --global @sprightgames/spyglassOr run without installing:
npx @sprightgames/spyglass addon --input ./MyAddonUse
spyglass addon --input ./MyAddon
spyglass world --input ./MyWorld.mctemplate
spyglass skin --input ./MySkins --layout marketplace --fail-on warning
spyglass --list-rulesThe first argument is the content type: addon, world, skin, texture, or persona. --input takes a folder, a .mcaddon, .mctemplate, .mcworld, .mcpack, .mcpersona, or a .zip.
The exit code is 0 when nothing at or above --fail-on was found and 1 otherwise, so the command can be used directly in CI to block a build.
Docs
- Getting started
- Command line options, config file, output formats, exit codes
- Checks every check by group, with what it checks and how to fix it
- Layouts the folder structure of each content type
- Contributing architecture and how to add a check
License
MIT
