Metadata-Version: 2.4
Name: kintsuki
Version: 0.0.0a6
Summary: SNES emulator wheel for scripted testing and tracing, built on a stripped-down ares Super Famicom core.
Author-email: Emmanuel Peralta <manz@ringum.net>
License-Expression: ISC
Keywords: ares,debugger,emulator,snes,super famicom
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Debuggers
Classifier: Topic :: System :: Emulators
Requires-Python: >=3.10
Provides-Extra: visual
Requires-Dist: numba>=0.59; extra == 'visual'
Requires-Dist: numpy>=1.26; extra == 'visual'
Requires-Dist: pillow>=10; extra == 'visual'
Description-Content-Type: text/markdown

# kintsuki

SNES emulator wheel built on a stripped-down [ares](https://ares-emu.net)
Super Famicom core via a thin C ABI. Aimed at scripted testing and
instruction tracing.

```python
import kintsuki

emu = kintsuki.Emu()
emu.load_rom("game.sfc")
emu.run_frames(60)
print(f"$7E1700 = {emu.read(0x7E1700):#04x}")
emu.screenshot("frame.png")
```

## Build

This package ships `libkintsuki.dylib` (macOS) / `.so` (Linux) /
`.dll` (Windows) in `src/kintsuki/_lib/`. Rebuild from source:

```sh
cmake -S ../ares -B ../build -G Ninja
ninja -C ../build kintsuki
cp ../build/target-kintsuki/libkintsuki.dylib src/kintsuki/_lib/
pip install -e .
```

## License

ISC. Vendors ares under its own ISC license — see `ares/LICENSE` in the
parent repo.
