doodle/pkg/balance
Noah Petherbridge 5654145fd8 (Experimental) Run Length Encoding for Levels
Finally add a second option for Chunk MapAccessor implementation besides the
MapAccessor. The RLEAccessor is basically a MapAccessor that will compress
your drawing with Run Length Encoding (RLE) in the on-disk format in the ZIP
file.

This slashes the file sizes of most levels:

* Shapeshifter: 21.8 MB -> 8.1 MB
* Jungle: 10.4 MB -> 4.1 MB
* Zoo: 2.8 MB -> 1.3 MB

Implementation details:

* The RLE binary format for Chunks is a stream of Uvarint pairs storing the
  palette index number and the number of pixels to repeat it (along the Y,X
  axis of the chunk).
    * Null colors are represented by a Uvarint that decodes to 0xFFFF
      or 65535 in decimal.
    * Gameplay logic currently limits maps to 256 colors.
* The default for newly created chunks in-game will be RLE by default.
* Its in-memory representation is still a MapAccessor (a map of absolute
  world coordinates to palette index).
* The game can still open and play legacy MapAccessor maps.
* On save in the editor, the game will upgrade/convert MapAccessor chunks over
  to RLEAccessors, improving on your level's file size with a simple re-save.

Current Bugs

* On every re-save to RLE, one pixel is lost in the bottom-right corner of
  each chunk. Each subsequent re-save loses one more pixel to the left, so what
  starts as a single pixel per chunk slowly evolves into a horizontal line.
* Some pixels smear vertically as well.
* Off-by-negative-one errors when some chunks Iter() their pixels but compute
  a relative coordinate of (-1,0)! Some mismatch between the stored world coords
  of a pixel inside the chunk vs. the chunk's assigned coordinate by the Chunker:
  certain combinations of chunk coord/abs coord.

To Do

* The `doodad touch` command should re-save existing levels to upgrade them.
2024-05-23 23:02:01 -07:00
..
boolprops.go Rename Go module 2022-09-24 15:17:25 -07:00
cheats.go Add cheat code to send power to all actors 2023-02-18 14:21:07 -08:00
debug.go Prepare v0.12.1 for release 2022-04-16 17:50:40 -07:00
feature_flags.go (Experimental) Run Length Encoding for Levels 2024-05-23 23:02:01 -07:00
fonts.go Spit and polish 2022-03-05 22:44:54 -08:00
numbers.go Deterministic JavaScript intervals + Code Cleanup 2024-04-27 00:10:28 -07:00
README.md Code Layout Refactor 2019-04-09 17:35:44 -07:00
responsive.go Level Thumbnails on Story Mode Select 2023-12-09 14:59:31 -08:00
runtime.go Menu Bar Update 2020-06-04 21:55:54 -07:00
shell.go Spit and polish 2022-03-05 22:44:54 -08:00
tag_dpp.go WIP Doodle++ 2024-04-18 20:23:07 -07:00
tag_foss.go WIP Doodle++ 2024-04-18 20:23:07 -07:00
theme.go Level Thumbnails on Story Mode Select 2023-12-09 14:59:31 -08:00
workarounds.go WASM Event Queue 2019-06-26 20:33:24 -07:00

balance

Constants and settings for the Doodle app.

Environment Variables

Some runtime settings can be configured in the environment. Here they are with their default values.

Most colors work with alpha channels; just provide an 8 hex character code, like #FF00FF99 for 153 ($99) on the alpha channel.

  • Application Windw Size (ints):
    • DOODLE_W=1024
    • DOODLE_H=768
  • Shell settings:
    • D_SHELL_BG=#001428C8: shell background color.
    • D_SHELL_FG=#0099FF: shell text color.
    • D_SHELL_PC=#FFFFFF: shell prompt color.
    • D_SHELL_LN=8: shell history line count (how tall the shell is in lines)
    • D_SHELL_FS=16: font size for both the shell and on-screen flashed messages.
  • Debug Colors and Hitboxes (default invisible=off):
    • DOODLE_DEBUG_ALL=false: turn on all debug colors and hitboxes to their default colors and settings.
    • DEBUG_CHUNK_COLOR=#FFFFFF: background color when caching a chunk to bitmap. Helps visualize where the chunks and caching are happening.
    • DEBUG_CANVAS_BORDER: draw a border color around every uix.Canvas widget. This effectively draws the bounds of every Doodad drawn on top of a level or inside a button and the bounds of the level space itself.
    • DEBUG_CANVAS_LABEL=false: draw a label in the corner of every Canvas with details about the Canvas.
  • Tuning constants (may not be available in production builds):
    • D_SCROLL_SPEED=8: Canvas scroll speed when using the keyboard arrows in the Editor Mode, in pixels per tick.
    • D_DOODAD_SIZE=100: Default size when creating a new Doodad.

Development booleans for unit tests (set to any non-empty value):

  • T_WALLPAPER_PNG for pkg/wallpaper to output PNG images.