Skip to content

0.1.0 - playable, widescreen, achievements

Choose a tag to compare

View all tags
@YuutaTsubasa YuutaTsubasa released this 24 Sep 02:38
· 69 commits to main since this release
v0.1.0
bac6e4f

Superseded by v0.2.0,
which ships the recompiled build. This release predates that decision and
its notes below say a recompiled binary cannot be distributed; the project's
position changed in v0.2.0, and
LEGAL.md
now sets out the current one. The interpreter downloads here still work and
remain the more conservative option.

First tagged version: the game is playable end to end, with sound, true
widescreen in levels, a first-run setup page, local achievements, and builds
for Windows, Linux, macOS and Android.

Read this before downloading

The download below is not the game, and it is not the recompiled build.

It contains no game data at all — no ROM, no graphics, no music, not one byte
of Sega's program. You supply your own legally obtained copy of Knuckles'
Chaotix (Japan, USA) (SHA-1 0c2fff7bc79ed26507c08ac47464c3af19f7ced7), and
the setup page on first launch installs it.

It is also the interpreter build, not the statically recompiled one. The
point of this project is recompilation — translating the 68000 and SH-2 game
code into native C++ ahead of time — but that output is a translation of
Sega's copyrighted program, so a recompiled binary cannot be distributed. See
LEGAL.md.

The interpreter runs the same game from the same ROM and is what the
recompiled code is validated against frame by frame. It is roughly 3x slower,
which is still comfortably above real time on a modern machine.

To get the recompiled build, build it yourself with your ROM:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCHAOTIX_ROM=/path/to/chaotix.32x
cmake --build build

Downloads

File Notes
ChaotixRecompiled-0.1.0-windows-x64.zip Windows 10/11 x64. Unzip anywhere and run ChaotixRecompiled.exe.
ChaotixRecompiled-0.1.0-android.apk Android 8.0+ (arm64-v8a and x86_64). Signed with the standard Android debug key and marked debuggable, so your device will warn you about installing from an unknown source. Copy your ROM to Android/data/org.chaotixrecompiled/files/ (or use Browse on the setup page).

Both are the interpreter build and contain no game data.

What works

  • Boots to the title screen; menus, character select and the stage-select hall
  • Levels are playable, with sound (Z80 driver, YM2612, PSG, PWM)
  • True widescreen in levels: the game's own renderer is extended to draw
    real tiles, objects and sprites in the extra area rather than stretching a
    4:3 image. Anything from 1.24:1 (320×240) to 2:1 (480×224) is filled, and
    the centre 320 pixels stay bit-identical to the unmodified game — checked by
    a test.
  • First-run setup page that verifies your ROM by SHA-1 and installs it once
  • 13 local achievements (no account, nothing downloaded)
  • Windows, Linux, macOS, Android; gamepad, keyboard and touch

How it is validated

The recompiled code and the reference interpreter run in lockstep and must
agree exactly — every register, memory write and cycle count. The suite
includes two 36,000-frame lockstep runs and golden frame hashes for 4:3,
widescreen and 16:9.

Known gaps

  • Linux and macOS build in CI but have not been run on real hardware by the author
  • iOS is configured but not yet built
  • The level timer is not yet decoded, so there are no time-based achievements
Assets 4
Loading