Repository navigation
0.11
| 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 |
Renamed: the Mega Drive exporter is export_megadrive now; up to 0.10.2 it was export_sgdk. Scripts that call
it need the new name; its options are the same as before (--output-demo-dir still works, --output-dir is the name
now).
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 Prince of Persia project is now
examples/pop/PoP_WW.json (it was in examples/sgdk/).
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/)
Both exporters take the same options: --project-json, --output-dir, --mapping (a mapping's name or id, all or
none), --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 data is blob version 5, as in 0.9 and 0.10, so games keep the runtime they have
(examples/megadrive/megadrive_demo/src/modsprite.c and inc/modsprite.h). 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 from the source code (examples/snes/snes_demo/src/modsprite.c, src/modsprite_draw.asm
and inc/modsprite.h; 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 (the SNES one for PoP_WW and the Adventurer, and stops on Sonic's 600 tiles as the script does). 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 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, each
with work RAM all zeros and all 0xFF at power-on, and drew the same on every frame.
What's new since 0.10.2
Every supported console is treated the same. Everything console-specific is named after the console: the Mega
Drive's exporter, folders (examples/megadrive, its demo megadrive_demo) and scripts, like the SNES's. Both exporters
take the same command line, report a project made for another console the same way, and check tiles and palettes in
the same place. docs/CONSOLES.md says
what full support of a console means, as the checklist the Mega Drive and the SNES meet, and what adding a console
takes. The SNES exporter also gained --copy-assets.
The Prince of Persia example moved to examples/pop/, next to Sonic and the Adventurer: it belongs to no one
console.
File format 8, as in 0.10.