Repository navigation
| Editor | Mega Drive exporter | SNES exporter | |
|---|---|---|---|
| Windows (x64) | ModularSpriteEditor-windows.zip |
export_megadrive-windows.zip |
export_snes-windows.zip |
| macOS (Apple Silicon) | ModularSpriteEditor-macos.zip |
export_megadrive-macos.zip |
export_snes-macos.zip |
| Linux (x64, glibc 2.35+, e.g. Ubuntu 22.04) | ModularSpriteEditor-linux.tar.gz |
export_megadrive-linux.tar.gz |
export_snes-linux.tar.gz |
New in the runtimes: characters face either way. ms_draw_anim_player_flipped(player, x, y, flip) draws an
animation's current step mirrored, as the editor's Mirror preview shows it, so a character that turns around needs each
animation once; ms_draw_anim_player_as_flipped does it with another mapping and palette swap for the draw (a guard
drawn from the hero's animations, facing him). ms_flip_hitbox and ms_flip_point give a step's or frame's hitboxes
and points mirrored the same way. On the Mega Drive and the SNES alike.
The exported data is 0.12's (Mega Drive blob version 7, 8 when streamed; SNES data version 4, 5 when streamed): a
game keeps its 0.12 export. Copy this version's runtime files (src/modsprite.c and inc/modsprite.h of the console's
demo) for the new calls.
The editor exports for the Mega Drive and the SNES itself (File ▸ Export ▸ Mega Drive (SGDK)... and File ▸ Export ▸
SNES (PVSnesLib)...). The exporters are the same exports from the command line, for programmers who export in a game's
build without opening the editor; you do not need them to make sprites.
The example projects, for every system: ModularSpriteEditor-examples.zip (Prince of Persia, Sonic and the
Adventurer). Unpack it and open a project with File ▸ Open... in the editor.
The SNES demo: ModularSpriteEditor-snes-demo.zip. modular_sprite_snes_demo.sfc is a SNES ROM made with the
editor's SNES export from the Prince of Persia example: open it in a SNES emulator (Mesen, bsnes, ares). It starts on
the Swordfight; UP / DOWN switch between scenes, animations, frames and modules, LEFT / RIGHT browse, A plays and pauses,
B shows hitboxes and points, X changes the look (mappings and palette swaps), START shows the controls and what a frame
costs. Next to it is the ROM's PVSnesLib project (examples/snes/snes_demo): export your own project into it and
build it with PVSnesLib 4.x, with make on macOS and Linux, or on Windows with build_windows.ps1 (PVSnesLib's Windows
tools, no make or MSYS2).
The user guide: https://modularsprites.bionic-productions.com/ (what's new, for artists:
https://modularsprites.bionic-productions.com/reference/releases/); for programmers, the new developer documentation:
https://modularsprites.bionic-productions.com/developers/ (the runtime, every function, the file formats, each console)
Both exporters take the same options: --project-json, --output-dir, --mapping (a mapping's name or id, all or
none), --mode (parts, parts_streamed or frames_streamed), --copy-assets and --strict; the SNES's also
--setup for its sprite sizes.
Mega Drive: export_megadrive --project-json my.json --output-dir path/to/megadrive_game, then build the game with SGDK.
The demo builds with make release; on macOS and Linux its first build compiles SGDK's library with your own m68k GCC,
because the one SGDK ships links only with SGDK's GCC 13 (which Windows uses). See
examples/megadrive/README.md.
SNES: export_snes --project-json my.json --output-dir path/to/snes_game writes the data into a PVSnesLib project
that has the SNES runtime (the demo project has it). See
examples/snes/README.md.
The builds are not signed. Windows: "More info" › "Run anyway". macOS: right-click › Open the first time
(or xattr -dr com.apple.quarantine ModularSpriteEditor.app export_megadrive export_snes).
Every build was tested in CI: unit tests; the built editor drives every tab against the PoP_WW and Sonic examples
(--smoke-test), exports for the Mega Drive and the SNES included; each built exporter writes exactly what its Python
exporter writes. On Windows the Mega Drive demo ROMs were built from the packaged files with the bundled SGDK, and the
SNES demo ROMs with the bundled PVSnesLib. The Mega Drive runtime was built with the vendored SGDK into probe ROMs of PoP_WW, Sonic and the Adventurer and
played in BlastEm 0.6.2, resident and in both streamed ways: every sprite table and profile as the host build of the
runtime writes them, the VDP's sprite table, video memory and colour RAM, frames of four sprites or more drawn by its
68000 loops, animation players drawn mirrored included. The SNES demo ROM in the zip was built with PVSnesLib 4.6.0
on Linux and its runtime checked in Mesen 2.1.1: every sprite table byte for byte as the host build of the runtime
writes it, which the unit tests compare with the editor. The ROM built on Windows was played next to it in Mesen with
the same presses through every view and drew the same on every frame.
What's new since 0.12
Animation players drawn mirrored (ms_draw_anim_player_flipped, ms_draw_anim_player_as_flipped) and hitboxes
and points mirrored (ms_flip_hitbox, ms_flip_point, which pass NULL on, so they chain with ms_find_hitbox and
ms_find_point), in both runtimes. The host tests draw every animation step of the example projects mirrored each way
against the editor's mirror preview, with its hitboxes and points, and the ROM checks draw an animation facing itself
in BlastEm and Mesen 2.
Developer documentation on the site: https://modularsprites.bionic-productions.com/developers/ (how the data works,
using the runtime, the API reference, video memory and limits, integrating with an engine, exporting from a build, the
project file, and per console its set-up, numbers and data format, record by record).
File format 9, as in 0.12.