furnace/README.md
2021-06-08 23:46:16 -05:00

53 lines
960 B
Markdown

# Furnace
did i say prepare?
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, SameBoy and Mednafen PCE)
- open-source. GPLv2.
## dependencies
- CMake
- SDL2
- zlib
the latter two are included as submodules for Windows and macOS.
## compilation
your typical CMake project. clone (including submodules) and:
### Windows using MSVC
from the developer tools command prompt:
```
mkdir build
cd build
cmake ..
msbuild ALL_BUILD.vcxproj
```
### macOS and Linux
```
mkdir build
cd build
cmake ..
make
```
## usage
```
./furnace <file>
```
this will play a file (must be in .dmf format).