Skip to content

Configuration#

goboscript uses a goboscript.toml configuration file to store project-specific configuration.

Standard Library Version#

If not provided, the latest version is picked. The selected version is cached for seven days before checking for updates on a subsequent build.

std = "2.1.0" # default is unset

Sprites layer order#

Specify the order in which sprites are layered, by default the order is alphabetical by name.

layers = ["sprite_name_1", "sprite_name_2"]

Sprites are listed from back to front.

Bitmap Resolution#

Controls the resolution handling for bitmap images (PNG, BMP) in your project.

bitmap_resolution = 2 # default is 1

How Bitmap Resolution Works#

Scratch internally uses high-resolution bitmaps where each screen pixel corresponds to 4 image pixels (2x scale factor). This setting determines how goboscript handles this scaling:

  • bitmap_resolution = 1 (default): Your images are stored as-is, and Scratch automatically scales them up by 2x when the project loads. Use normal-sized images (e.g., 480x360 for full stage backdrops).

  • bitmap_resolution = 2: Your images are treated as high-resolution and displayed at half their pixel size. You must provide double-sized images (e.g., 960x720 for full stage backdrops) to achieve the same visual size.

Note

This setting only affects bitmap formats (PNG, BMP). Vector formats (SVG) are unaffected.

Turbowarp options#

goboscript can generate a turbowarp configuration comment inside the Stage. https://docs.turbowarp.org/advanced-settings

Frame Rate#

frame_rate = 60 # default is 30

Max Clones#

Default#

max_clones = 300

Infinite Clones#

max_clones = inf

No Miscellaneous Limits#

no_miscellaneous_limits = true # default is false

No Sprite Fencing#

no_sprite_fencing = true # default is false

Frame Interpolation#

frame_interpolation = true # default is false

High Quality Pen#

high_quality_pen = true # default is false

Stage Width & Height#

stage_width = 640 # default is 480
stage_height = 480 # default is 360

Notes#

Add credits, instructions, or other project notes to the Stage using a text file.

notes = "NOTES.md" # default is unset

Notes appear in a Stage comment beneath the goboscript logo. The logo is included even when no notes are provided. Comments longer than 8000 characters are shortened.

The notes path is relative to the project directory.