amiga-re-kit
Tools for reverse-engineering Commodore Amiga games from a disk image —
extracted from three complete game projects
(S.W.I.V.,
Turrican II,
Superfrog) and made
game-agnostic. One Python package (arek), one command line (arek), and an
MCP server (arek-mcp) so an AI assistant can drive the same instruments
you do.
The method is the point: first a complete, measured description of the original — only then anything else. Nothing here guesses. The decoder refuses instructions it does not model, the walker reports every indirect jump it cannot follow, the packers verify with the checksums the originals carry, and the emulator captures are compared byte for byte.
No game data is included or needed to run the kit. The tests use a
hand-assembled 20-byte program and random buffers. Your disk image and
Kickstart ROM stay on your machine, referenced from a git-ignored
local.conf.
Install
pip install -e ".[mcp,png,dev]" # or without extras: pip install -e .
python -m pytest # 75 tests, synthetic data only
arek --help
Optional: a patched headless vAmiga
for anything that runs the original (arek shot, arek bpstate) — see
docs/HEADLESS.md. Optional: m68k-elf-objdump for
arek xref.
The workflow in commands
arek init myproject && cd myproject # skeleton + local.conf (edit the paths)
# 1. measure the disk
arek adf info disk.adf # size, sha256, boot block, checksum
arek adf map disk.adf # entropy picture, one char per sector
arek adf regions disk.adf # where code / data / packed blocks sit
arek scan disk.adf # packer signatures, verified Bytekiller blocks
# 2. unpack what the loader unpacks
arek adf track disk.adf -n 1 -o trk1.bin
arek adf ls disk.adf # AmigaDOS files, if the disk has a filesystem
arek adf cat disk.adf -p LEVELS/L1 -o l1.atn # one file, data blocks verified
arek pp20 file.pp -o file.bin # PowerPacker 2.0
arek bytekiller trk1.bin --offset 0x200 -o main.bin
arek t2 INTR -o intr.bin # Turrican II three-stage
arek atn BLOCK -o out.bin --offset 0x1234 # Atomik (ATN!), block inside an image
arek hunk info prog && arek hunk load prog --base 0x20000 -o h # AmigaDOS executables
# 3. read the code - flow graph, not linear
arek dis main.bin --base 0x20700 --walk 0x20700 # only reachable code
arek walk main.bin --base 0x20700 --start 0x20700 # call tree + frontiers
arek hwscan main.bin --base 0x20700 --roots 0x20700 # the hardware boundary
arek copper ram.bin --base 0x0 --limit 200 # a copper list from a RAM dump
arek xref prog.txt --syms syms.json # from an objdump listing
# 4. translate and verify
arek recomp main.bin --base 0x20700 --auto 0x21234 --main -o draw.c
arek bpstate --address 0x21234 --end 20 --out cap/before
arek bpstate --address 0x21300 --end 20 --out cap/after
arek diff cap/before cap/after --range 0x60000 0x70000
arek shot build/shots/title 5 10 --at 3 "joystick 1 press fire"
Every command prints what it measured and nothing else. arek audit profile.json produces the JSON inventory + reachability record the method
asks for (see examples/profile.example.json).
What is inside
| module | what it does | origin |
|---|---|---|
arek.adf |
geometry, boot block checksum, entropy map / regions, inventory | new |
arek.amigados |
AmigaDOS OFS/FFS reader (directories, files, extension blocks, checksums) + synthetic image builder for tests | new |
arek.packers.pp20 |
PowerPacker 2.0 decruncher (+ literal-only encoder for tests) | Turrican II / Superfrog |
arek.packers.bytekiller |
Bytekiller format B (XOR checksum) and the SWIV word-stream format A | S.W.I.V. |
arek.packers.turrican2 |
Huffman → backwards LZ → RLE three-stage decruncher | Turrican II |
arek.packers.atomik |
Atomik (ATN!) decruncher with exact block extent (+ greedy LZ test encoder) |
Superfrog |
arek.packers.scan |
brute-force scan: signatures (PP20, RNC, ATN!, IMP!, …) + verified blocks | S.W.I.V. |
arek.hunk |
bounded HUNK reader: CODE/DATA/BSS, RELOC32, split streams; build() for probes |
Superfrog |
arek.copper |
copper list disassembler with custom register names | S.W.I.V. |
arek.m68k.decoder |
strict 68000 decoder: raises Unsupported instead of guessing |
Superfrog (fixed ADDA/SUBA/CMPA) |
arek.m68k.disasm |
linear and flow-walk listings straight from the decoder | new |
arek.m68k.hwscan |
which routines are pure RAM and which touch custom chips / CIA / ROM | Turrican II |
arek.m68k.recomp |
static 68k → C recompiler with a verification driver (MEM[], write log, minimal blitter model) |
Superfrog |
arek.m68k.xref |
call / data cross references from m68k-elf-objdump text |
Superfrog |
arek.m68k.audit |
profile-driven inventory + conservative reachability, JSON in / JSON out | Superfrog |
arek.headless |
local.conf, RetroShell scripts, screenshots, breakpoint captures |
Turrican II / Superfrog |
arek.contract |
byte-level comparison of captures, register diffs, "untouched" assertions | Superfrog |
arek.cli / arek.mcp_server |
the command line and the MCP server | new |
Each module's docstring explains the format or the measurement it implements; docs/METHOD.md explains how they fit together.
MCP: let an assistant hold the instruments
pip install -e ".[mcp]"
Claude Code (.mcp.json in your project, or claude mcp add arek -- arek-mcp):
{"mcpServers": {"arek": {"command": "arek-mcp"}}}
The server exposes 20 tools (adf_info, adf_map, adf_ls, adf_file, scan_packed, unpack,
hunk_load, disassemble, walk, hwscan, recomp, xref, copper,
headless_shot, headless_bpstate, diff_captures, ram_at, …). All of them
take paths on the local machine; the server never fetches anything, never
writes outside the paths it is given, and only returns measurements — the
assistant sees entropy maps, listings and diffs, not your disk image.
A working session looks like: "map the disk" → "scan for packed blocks" → "unpack the block at 0x1f40 and walk it from its entry" → "which of these routines touch hardware?" → "recompile 0x21234 and compare its RAM writes with a capture of the original". Every answer is backed by a tool result.
Legal
The kit is MIT (see LICENSE). It ships no game data, no ROM, and no game-specific knowledge — the "engine without data" model: you supply the image you own. The vAmiga patches are modifications of MPL-2.0 sources and are published as required; see THIRD-PARTY.md.
Code comments inside the transplanted modules are partly in Czech (the projects' working language); public docstrings, the CLI and the docs are English.
Metadata
Release files for amiga-re-kit 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| amiga_re_kit-0.2.0.tar.gz | 80.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| amiga_re_kit-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 163.0 kB
Release files / amiga_re_kit-0.2.0.tar.gz
| Download URL | amiga_re_kit-0.2.0.tar.gz |
|---|---|
| Size | 80.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b35a0246d0da245042e301a7ddb207e917ccbc570c0b80c43e9ab627e22c4df7
|
|
BLAKE2b-256 checksum How to use checksums |
362825edf91e6dd0dd9cc74190b454b01b45259d93565f1a32b38bb48bc08f1f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.2
|
Release files / amiga_re_kit-0.2.0-py3-none-any.whl
| Download URL | amiga_re_kit-0.2.0-py3-none-any.whl |
|---|---|
| Size | 82.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc5a25a9f8c7e1ab33eda9b29ee6b5cf8246d73c3fa628dbfb54b221ae4c2790
|
|
BLAKE2b-256 checksum How to use checksums |
1e99cddf3ce49e96152d917daf97f753f9cb061a6e64ac629dbdeed8026c000d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.2
|
Security for amiga-re-kit 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.