Installation and documentation

goboscript is the Scratch compiler. It lets you write Scratch projects in a text-based programming language. It outputs .sb3 files which can be opened in Scratch or Turbowarp. It is written in Rust and is designed to have fast compile times.

goboscript is text-based, so you can use Visual Studio Code to write Scratch projects, you can even use Github Copilot to help you write Scratch projects. goboscript also performs optimizations, has a powerful macro system which lets you do meta-programming. It even finds errors in your Scratch projects before you run them.

goboscript code	Scratch blocks

goboscript welcomes contributions in the form of Pull Requests.

goboscript is written in Rust. You'll need to install the Rust toolchain for development.

git clone https://github.com/aspizu/goboscript
cd goboscript

After cloning the repository, run goboscript locally from the repository root with:

cargo run -- build -i your_project/

But, to make development easier, and to validate the generated Scratch project - use the tools/run script:

tools/run compile

This assumes that you have set-up a testing project at playground/. It will compile the project, validate it using the schemas from scratch-parser. If the validation fails, Scratch will refuse to load the project. To further debug the project, the generated project.json file is extracted from the .sb3 file in the playground/ directory.

Lets say that you modified the generated project in the Scratch editor or Turbowarp, and you want to look at the project.json. You can extract it with:

tools/run uncompile

Lets say that goboscript produced a broken project, and you are able to fix it by hand - by modifying the project.json. You can add back the project.json to the .sb3 file with:

tools/run patch

If you want to validate some .sb3 file, use:

tools/run check path/to/project.sb3