furnace/README.md

53 lines
1,002 B
Markdown
Raw Normal View History

2021-05-13 08:22:57 +00:00
# Furnace
2021-05-28 19:15:27 +00:00
this is a work-in-progress chip music player (currently) for the .dmf format.
## features
2021-12-05 04:55:28 +00:00
- supports Sega Genesis, Master System, Game Boy, PC Engine, NES and C64 (for now, with more systems coming soon)
2021-05-28 19:15:27 +00:00
- 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
2021-12-05 04:55:28 +00:00
- accurate emulation cores (Nuked, MAME, SameBoy, Mednafen PCE, puNES and reSID (hahaha!))
2021-05-28 19:15:27 +00:00
- open-source. GPLv2.
## dependencies
2021-05-28 20:31:35 +00:00
- CMake
- SDL2
- zlib
2021-06-09 08:33:03 +00:00
- JACK (optional)
2021-05-28 20:31:35 +00:00
2021-06-09 08:33:03 +00:00
SDL2 and zlib are included as submodules for Windows and macOS.
2021-05-28 19:15:27 +00:00
## compilation
your typical CMake project. clone (including submodules) and:
2021-05-28 19:15:27 +00:00
2021-05-28 20:31:35 +00:00
### Windows using MSVC
from the developer tools command prompt:
```
mkdir build
cd build
cmake ..
msbuild ALL_BUILD.vcxproj
```
### macOS and Linux
2021-05-28 19:15:27 +00:00
```
mkdir build
cd build
cmake ..
make
```
## usage
```
./furnace <file>
```
this will play a file (must be in .dmf format).