furnace/README.md

37 lines
716 B
Markdown
Raw Normal View History

2021-05-13 08:22:57 +00:00
# Furnace
2021-05-28 19:15:27 +00:00
did i say prepare?
2021-05-28 19:15:27 +00:00
this is a work-in-progress chip music player (currently) for the .dmf format.
## features
- supports Sega Genesis, Master System and Game Boy (for now, with more systems coming soon)
- clean-room design (zero reverse-engineered code and zero decompilation; using official DMF specs, guesswork and ABX tests only)
- bug/quirk implementation for increased playback accuracy
- accurate emulation cores (Nuked, MAME and SameBoy)
- open-source. GPLv2.
## dependencies
SDL2. untested on Windows/macOS.
## compilation
your typical CMake project. clone and:
```
mkdir build
cd build
cmake ..
make
```
## usage
```
./furnace <file>
```
this will play a file (must be in .dmf format).