Assets for the Ruby 2D gem

Contents

• platform/ — Platform-specific headers and pre-built static libraries
  • include/ — C headers for SDL3 and mruby, shared across all targets
  • macos-arm64/, windows-x86_64-mingw-ucrt/, etc. — Compiled static libraries and binaries, organized by {os}-{arch}/ (or {os}-{arch}-{toolchain}/ on Windows)
  • wasm/ — Static libraries for the WASM (Emscripten) target (lib/ only — no host binaries)
• sources/ — Dependency source repos (cloned by rake, gitignored)
• build/ — CMake build artifacts, organized by target ID (e.g. macos-arm64)
• build_support/ — CMake and mruby build configuration files
• resources/ — Static assets bundled with the gem
  • fonts/, icons/, spritesheets/, and web/ (the HTML template for the web build)
• test_media/ — Media files (images, sounds, etc.) for tests
• target.rb — Host OS/arch/toolchain detection and path resolution (used by the Rakefile and build configs)
• deps.yaml — Pinned dependency versions, updated by rake update

Prerequisites

• CMake — required to build SDL3 libraries
• Ruby and Rake — required to run build tasks
• Emscripten — required for WASM builds only

On Windows, we recommend installing Ruby using the RubyInstaller for Windows and downloading the Ruby+Devkit versions. This has been tested with version 4.0.5-1 (arm and x64). git and cmake aren't installed by default — the build tasks check for them up front and offer to install them for you via MSYS2's pacman. To install them yourself instead, run pacman -S with the packages for your architecture:

• For x86_64 systems, git mingw-w64-ucrt-x86_64-cmake
• For ARM64 systems, git mingw-w64-clang-aarch64-cmake

Building

Clone this repo, then run:

rake

With no arguments, rake cleans the current target and builds everything from source. It prints what it will do and prompts before continuing, then:

1. Clones any missing SDL3 and mruby sources at the pinned version tags in deps.yaml — existing sources are left as-is, and it does not run update
2. Builds everything with CMake / mruby's build system
3. Copies headers to platform/include/ and static libraries to platform/{os}-{arch}[-{toolchain}]/lib/

If Emscripten is available on your PATH, the WASM libraries are built too (see rake wasm); otherwise that step is skipped with a notice. Run rake wasm directly to build them explicitly.

To build without the confirmation prompt, run rake build directly. Unlike rake, it re-clones any source whose pinned tag in deps.yaml has changed.

Individual tasks

rake sdl          # Download and build SDL libraries
rake mruby        # Download and build mruby
rake wasm         # Download and build all WASM libraries (SDL + mruby)

To remove the current target's build artifacts (plus WASM):

rake clean

To start completely fresh — remove every target's build artifacts, the WASM libraries, and all downloaded sources (re-cloned on the next build):

rake clean:all

Testing SDL

rake sdl:test     # Compile and run sdl_test.c against the built libraries

Note: sdl:test opens a window and plays audio, so it needs a graphical/audio environment — it won't run headless (e.g. in CI).

Updating dependencies

All dependency versions are pinned by tag in deps.yaml. To check for and apply updates:

rake update

This will check each dependency's remote for newer release tags, show what's available, and ask for confirmation before updating. Pinned tags in deps.yaml are updated automatically.

After updating, run rake build to rebuild with the updated sources.

License

The contents of this repo are released under the MIT License, unless otherwise specified. Third-party files retain their original licenses, including:

• platform/include/SDL3* and the built libSDL3* libraries — SDL3, zlib license
• platform/include/mruby* and the built libmruby libraries — mruby, MIT License
• platform/wasm/lib/ — also includes libraries bundled by SDL_image, SDL_mixer, and SDL_ttf (FreeType, HarfBuzz, libpng, zlib, Ogg/Vorbis, FLAC, PlutoVG/PlutoSVG), each under its own license
• resources/fonts/ — Outfit and Roboto Mono, SIL Open Font License 1.1
• resources/spritesheets/ — Kenney's New Platformer Pack, CC0

See the license file included alongside each of the above, or the upstream project, for full terms.