furnace/README.md

87 lines
1.5 KiB
Markdown
Raw Normal View History

2021-05-13 08:22:57 +00:00
# Furnace
2021-12-11 09:55:31 +00:00
this is a player for DefleMask module files (.dmf).
2021-05-28 19:15:27 +00:00
## features
2021-12-09 08:37:31 +00:00
- supports Sega Genesis, Master System, Game Boy, PC Engine, NES, C64, YM2151/PCM and Neo Geo!
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-11 09:55:31 +00:00
- accurate emulation cores whether possible (Nuked, MAME, SameBoy, Mednafen PCE, puNES, reSID and ymfm)
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>
```
2021-12-11 09:55:31 +00:00
this will play a .dmf file.
2021-12-07 18:08:48 +00:00
```
./furnace -view commands <file>
```
this will play a .dmf file and enable the commands view.
```
./furnace -loops 0 <file>
```
this will play a .dmf file and not loop it.
```
./furnace -output audio.wav <file>
```
this will render a .dmf file to .wav.
2021-12-11 18:30:06 +00:00
# notes
> my song plays different after looping!
that's because Furnace does not reset channel status when looping.
> my song sounds very odd at a certain point
file a bug report. use the Issues page.
it's probably another playback inaccuracy.
2021-12-11 18:41:37 +00:00
> extremely high CPU usage in arcade platform
yep, that's how accurate Nuked is. I'll add an ymfm-based core soon.