0.6pre1 - introduce the final changes
- implement E1xy/E2xy Defle bug when using same note twice - add SNK Touchdown Fever preset - update README.md and to-do list - update credits thank you for your patience! see you in 0.6pre1.5 coming soon...
This commit is contained in:
tildearrow
parent
6a35258e9b
commit
a8a38dce2b
14 changed files with 222 additions and 91 deletions
190
README.md
190
README.md
|
|
@ -1,8 +1,8 @@
|
|||
# Furnace Tracker
|
||||
|
||||
|
||||
|
||||
|
||||
this is a multi-system chiptune tracker.
|
||||
the biggest multi-system chiptune tracker ever made!
|
||||
|
||||
[downloads](#downloads) | [discussion/help](#quick-references) | [developer info](#developer-info) | [unofficial packages](#unofficial-packages) | [FAQ](#frequently-asked-questions)
|
||||
|
||||
|
|
@ -15,34 +15,91 @@ check out the [Releases](https://github.com/tildearrow/furnace/releases) page. a
|
|||
|
||||
## features
|
||||
|
||||
- supports the following systems:
|
||||
- Sega Genesis
|
||||
- Sega Master System
|
||||
- over 50 sound chips - and counting:
|
||||
- Yamaha FM chips:
|
||||
- YM2151 (OPM)
|
||||
- YM2203 (OPN)
|
||||
- YM2413 (OPLL)
|
||||
- YM2414 (OPZ) used in Yamaha TX81Z
|
||||
- YM2608 (OPNA) used in PC-98
|
||||
- YM2610 (OPNB) used in Neo Geo
|
||||
- YM2610B (OPNB2)
|
||||
- YM2612 (OPN2) used in Sega Genesis and FM Towns
|
||||
- YM3526 (OPL) used in C64 Sound Expander
|
||||
- YM3812 (OPL2)
|
||||
- YMF262 (OPL3) with full 4-op support!
|
||||
- Y8950 (OPL with ADPCM)
|
||||
- square wave chips:
|
||||
- AY-3-8910/YM2149(F) used in several computers and game consoles
|
||||
- Commodore VIC used in the VIC-20
|
||||
- Microchip AY8930
|
||||
- TI SN76489 used in Sega Master System and BBC Micro
|
||||
- PC Speaker
|
||||
- Philips SAA1099 used in SAM Coupé
|
||||
- sample chips:
|
||||
- Amiga
|
||||
- SegaPCM - all 16 channels
|
||||
- Capcom QSound
|
||||
- Yamaha YMZ280B (PCMD8)
|
||||
- Ricoh RF5C68 used in Sega CD and FM Towns
|
||||
- OKI MSM6258 and MSM6295
|
||||
- wavetable chips:
|
||||
- HuC6280 used in PC Engine
|
||||
- Konami Bubble System WSG
|
||||
- Konami SCC/SCC+
|
||||
- Namco arcade chips (WSG/C15/C30)
|
||||
- WonderSwan
|
||||
- Seta/Allumer X1-010
|
||||
- NES (Ricoh 2A03/2A07), with additional expansion sound support:
|
||||
- Konami VRC6
|
||||
- Konami VRC7
|
||||
- MMC5
|
||||
- Famicom Disk System
|
||||
- Sunsoft 5B
|
||||
- Namco 163
|
||||
- Family Noraebang (OPLL)
|
||||
- SID (6581/8580) used in Commodore 64
|
||||
- Mikey used in Atari Lynx
|
||||
- ZX Spectrum beeper (SFX-like engine)
|
||||
- TIA used in Atari 2600
|
||||
- Game Boy
|
||||
- PC Engine
|
||||
- NES
|
||||
- Commodore 64
|
||||
- Yamaha YM2151 (plus PCM)
|
||||
- Neo Geo
|
||||
- AY-3-8910 (ZX Spectrum, Atari ST, etc.)
|
||||
- Microchip AY8930
|
||||
- Philips SAA1099
|
||||
- Amiga
|
||||
- TIA (Atari 2600/7800)
|
||||
- multiple sound chips in a single song!
|
||||
- DefleMask compatibility - loads .dmf modules, .dmp instruments and .dmw wavetables
|
||||
- clean-room design (guesswork and ABX tests only, no decompilation involved)
|
||||
- bug/quirk implementation for increased playback accuracy
|
||||
- VGM and audio file export
|
||||
- accurate emulation cores whether possible (Nuked, MAME, SameBoy, Mednafen PCE, puNES, reSID, Stella, SAASound and ymfm)
|
||||
- additional features on top:
|
||||
- modern/fantasy:
|
||||
- Commander X16 VERA
|
||||
- tildearrow Sound Unit
|
||||
- mix and match sound chips!
|
||||
- over 200 ready to use presets from computers, game consoles and arcade boards...
|
||||
- ...or create your own - up to 32 of them or a total of 128 channels!
|
||||
- DefleMask compatibility
|
||||
- loads .dmf modules from all versions (beta 1 to 1.1.3)
|
||||
- saves .dmf modules - both modern and legacy
|
||||
- Furnace doubles as a module downgrader
|
||||
- loads .dmp instruments and .dmw wavetables as well
|
||||
- clean-room design (guesswork and ABX tests only, no decompilation involved)
|
||||
- bug/quirk implementation for increased playback accuracy through compatibility flags
|
||||
- VGM export
|
||||
- modular layout that you may adapt to your needs
|
||||
- audio file export - entire song, per system or per channel
|
||||
- quality emulation cores (Nuked, MAME, SameBoy, Mednafen PCE, NSFplay, puNES, reSID, Stella, SAASound, vgsound_emu and ymfm)
|
||||
- wavetable synthesizer
|
||||
- available on wavetable chips
|
||||
- create complex sounds with ease - provide up to two wavetables, select and effect and let go!
|
||||
- MIDI input support
|
||||
- [Fractal Sound](https://gitlab.com/Natsumi/Fractal-Sound) support!
|
||||
- the game-ready Sega Genesis/Mega Drive sound driver!
|
||||
- compose your songs in Furnace using the Fractal Sound presets and then use them in your games with Fractal!
|
||||
- additional features:
|
||||
- FM macros!
|
||||
- negative octaves
|
||||
- arbitrary pitch samples
|
||||
- sample loop points
|
||||
- SSG envelopes in Neo Geo
|
||||
- SSG envelopes and ADPCM-B in Neo Geo
|
||||
- full duty/cutoff range in C64
|
||||
- ability to change tempo mid-song with `Cxxx` effect (`xxx` between `000` and `3ff`)
|
||||
- ability to change tempo mid-song
|
||||
- multiple sub-songs in a module
|
||||
- per-channel oscilloscope with waveform centering
|
||||
- built-in sample editor
|
||||
- chip mixing settings
|
||||
- built-in visualizer in pattern view
|
||||
- open-source under GPLv2 or later.
|
||||
|
||||
***
|
||||
|
|
@ -59,7 +116,7 @@ some people have provided packages for Unix/Unix-like distributions. here's a li
|
|||
- **Arch Linux**: [furnace-git is in the AUR.](https://aur.archlinux.org/packages/furnace-git) thank you Essem!
|
||||
- **FreeBSD**: [a package in ports](https://www.freshports.org/audio/furnace/) is available courtesy of ehaupt.
|
||||
- **Nix**: [package](https://search.nixos.org/packages?channel=unstable&show=furnace&from=0&size=50&sort=relevance&type=packages&query=furnace) thanks to OPNA2608.
|
||||
- **OpenSUSE**: [a package](https://software.opensuse.org/package/furnace) is available, courtesy of fpesari.
|
||||
- **openSUSE**: [a package](https://software.opensuse.org/package/furnace) is available, courtesy of fpesari.
|
||||
|
||||
***
|
||||
# developer info
|
||||
|
|
@ -73,11 +130,17 @@ if you can't download these artifacts (because GitHub requires you to be logged
|
|||
## dependencies
|
||||
|
||||
- CMake
|
||||
- SDL2
|
||||
- zlib
|
||||
- JACK (optional)
|
||||
- JACK (optional, macOS/Linux only)
|
||||
|
||||
SDL2 and zlib are included as submodules.
|
||||
if building under Windows or macOS, no additional dependencies are required.
|
||||
otherwise, you may also need the following:
|
||||
|
||||
- libpulse
|
||||
- libx11
|
||||
- libasound
|
||||
- libGL
|
||||
|
||||
some Linux distributions (e.g. Ubuntu or openSUSE) will require you to install the `-dev` versions of these.
|
||||
|
||||
## getting the source
|
||||
|
||||
|
|
@ -127,14 +190,20 @@ Available options:
|
|||
| Name | Default | Description |
|
||||
| :--: | :-----: | ----------- |
|
||||
| `BUILD_GUI` | `ON` | Build the tracker (disable to build only a headless player) |
|
||||
| `USE_RTMIDI` | `ON` | Build with MIDI support using RtMidi |
|
||||
| `USE_SDL2` | `ON` | Build with SDL2 (required to build with GUI) |
|
||||
| `USE_SNDFILE` | `ON` | Build with libsndfile (required in order to work with audio files) |
|
||||
| `USE_BACKWARD` | `ON` | Use backward-cpp to print a backtrace on crash/abort |
|
||||
| `WITH_JACK` | `ON` if system-installed JACK detected, otherwise `OFF` | Whether to build with JACK support. Auto-detects if JACK is available |
|
||||
| `SYSTEM_FFTW` | `OFF` | Use a system-installed version of FFTW instead of the vendored one |
|
||||
| `SYSTEM_FMT` | `OFF` | Use a system-installed version of fmt instead of the vendored one |
|
||||
| `SYSTEM_LIBSNDFILE` | `OFF` | Use a system-installed version of libsndfile instead of the vendored one |
|
||||
| `SYSTEM_RTMIDI` | `OFF` | Use a system-installed version of RtMidi instead of the vendored one |
|
||||
| `SYSTEM_ZLIB` | `OFF` | Use a system-installed version of zlib instead of the vendored one |
|
||||
| `SYSTEM_SDL2` | `OFF` | Use a system-installed version of SDL2 instead of the vendored one |
|
||||
| `WARNINGS_ARE_ERRORS` | `OFF` (but consider enabling this & reporting any errors that arise from it!) | Whether warnings in furnace's C++ code should be treated as errors |
|
||||
|
||||
## usage
|
||||
## console usage
|
||||
|
||||
```
|
||||
./furnace
|
||||
|
|
@ -156,36 +225,21 @@ this will play a compatible file and enable the commands view.
|
|||
|
||||
**note that these commands only actually work in Linux environments. on other command lines, such as Windows' Command Prompt, or MacOS Terminal, it may not work correctly.**
|
||||
|
||||
***
|
||||
# notes
|
||||
|
||||
> how do I use Neo Geo SSG envelopes?
|
||||
|
||||
the following effects are provided:
|
||||
|
||||
- `22xy`: set envelope mode.
|
||||
- `x` sets the envelope shape, which may be one of the following:
|
||||
- `0: \___` decay
|
||||
- `4: /___` attack once
|
||||
- `8: \\\\` saw
|
||||
- `9: \___` decay
|
||||
- `A: \/\/` inverse obelisco
|
||||
- `B: \¯¯¯` decay once
|
||||
- `C: ////` inverse saw
|
||||
- `D: /¯¯¯` attack
|
||||
- `E: /\/\` obelisco
|
||||
- `F: /___` attack once
|
||||
- if `y` is 1 then the envelope will affect this channel.
|
||||
- `23xx`: set envelope period low byte.
|
||||
- `24xx`: set envelope period high byte.
|
||||
- `25xx`: slide envelope period up.
|
||||
- `26xx`: slide envelope period down.
|
||||
|
||||
a lower envelope period will make the envelope run faster.
|
||||
|
||||
***
|
||||
# frequently asked questions
|
||||
|
||||
> woah! 50 sound chips?! I can't believe it!
|
||||
|
||||
yup, it's real.
|
||||
|
||||
> where's the manual?
|
||||
|
||||
see [papers/](papers/README.md). it's kind of incomplete, but at least the systems (sound chips) section is there.
|
||||
|
||||
> it doesn't open under macOS!
|
||||
|
||||
this is due to Apple's application signing policy. a workaround is to right click on the Furnace app icon and select Open.
|
||||
|
||||
> how do I use C64 absolute filter/duty?
|
||||
|
||||
on Instrument Editor in the C64 tab there are two options to toggle these.
|
||||
|
|
@ -195,25 +249,27 @@ also provided are two effects:
|
|||
- `4xxx`: set fine cutoff. `xxx` range is 000-7ff.
|
||||
additionally, you can change the cutoff and/or duty as a macro inside an instrument by clicking the `absolute cutoff macro` and/or `absolute duty macro` checkbox at the bottom of the instrument. (for the filter, you also need to click the checkbox that says `volume macro is cutoff macro`.)
|
||||
|
||||
> Q: how do I use PCM on a PCM-capable system?
|
||||
> how do I use PCM on a PCM-capable system?
|
||||
|
||||
A: Two possibilities: the recommended way is via creating the "Amiga/Sample" type instrument and assigning sample to it, or via old, Deflemask-compatible method, using `17xx` effect
|
||||
two possibilities:
|
||||
- the recommended way is by creating the "Sample" type instrument and assigning a sample to it.
|
||||
- otherwise you may employ the DefleMask-compatible method, using `17xx` effect.
|
||||
|
||||
> Q: my song sounds very odd at a certain point
|
||||
> my .dmf song sounds very odd at a certain point
|
||||
|
||||
A: file a bug report. use the Issues page. it's probably another playback inaccuracy.
|
||||
file a bug report. use the Issues page. it's probably another playback inaccuracy.
|
||||
|
||||
> Q: my song sounds correct, but it doesn't in DefleMask
|
||||
> my .dmf song sounds correct, but it doesn't in DefleMask
|
||||
|
||||
A: file a bug report **here**. it still is a playback inaccuracy.
|
||||
file a bug report **here**. it still is a playback inaccuracy.
|
||||
|
||||
> Q: my C64 song sounds terrible after saving as .dmf!
|
||||
> my song sounds terrible after saving as .dmf!
|
||||
|
||||
A: that's a limitation of the DefleMask format. save in Furnace song format instead (.fur).
|
||||
the DefleMask format has several limitations. save in Furnace song format instead (.fur).
|
||||
|
||||
> Q: how do I solo channels?
|
||||
> how do I solo channels?
|
||||
|
||||
A: right click on the channel name.
|
||||
right click on the channel name.
|
||||
|
||||
***
|
||||
# footnotes
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue