Skip to content

Commit 4b91413

Browse files
committed
docs: explain bitmap resolution configuration option
1 parent c1d0674 commit 4b91413

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/configuration.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,25 @@ Specify the order in which sprites are layered, by default the order is undefine
6363
layers = ["sprite_name_1", "sprite_name_2"]
6464
```
6565

66+
## Bitmap Resolution
67+
68+
Controls the resolution handling for bitmap images (PNG, BMP) in your project.
69+
70+
```toml
71+
bitmap_resolution = 2 # default is 1
72+
```
73+
74+
### How Bitmap Resolution Works
75+
76+
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:
77+
78+
- **`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).
79+
80+
- **`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.
81+
82+
!!! NOTE
83+
This setting only affects bitmap formats (PNG, BMP). Vector formats (SVG) are unaffected.
84+
6685
## Turbowarp options
6786

6887
goboscript can generate a turbowarp configuration comment inside the Stage.

0 commit comments

Comments
 (0)