otomatalabs/furnace
8
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

General docs updates.

Browse source 
New menu items, new options, a whole new user systems feature...
This commit is contained in:
Electric Keet 2024-07-25 20:48:58 -07:00 • committed by tildearrow
parent fca3ce02a7
commit 6037adab51
16 changed files with 311 additions and 234 deletions
Download patch file Download diff file Expand all files Collapse all files

51
doc/2-interface/export.md
View file

@ -1,26 +1,27 @@
# export
Furnace allows you to export your song in several formats. this section deals with describing the available export options.
Furnace allows you to export your song in several formats. this section deals with describing the available export options within each tab of the export window.
## export audio
## Audio
this option allows you to export your song in .wav format. I know I know, no .mp3 or .ogg export yet, but you can use a converter.
there are two parameters:
- **Export type**:
- **one file**: exports your song to one .wav file.
- **multiple files (one per chip)**: exports the output of each chip to .wav files.
- **multiple files (one per channel)**: exports the output of each channel to .wav files.
- useful for usage with a channel visualizer such as corrscope.
- **Bit depth**:
- **16-bit integer**: the most common type of .wav file, perfect for music playback.
- **32-bit float**: used for advanced audio manipulation. don't select this unless you know what you need it for.
- **Sample rate**: the default is 44100, the most common .wav sample rate.
- **Channels in file**: default is 2 (stereo). Set to 1 for mono.
- **Loops**: sets the number of times the song will loop.
- does not have effect if the song ends with `FFxx` effect.
- **Fade out (seconds)**: sets the fade out time when the song is over.
- does not have effect if the song ends with `FFxx` effect.
and three export choices:
- **one file**: exports your song to one .wav file.
- **multiple files (one per chip)**: exports the output of each chip to .wav files.
- **multiple files (one per channel)**: exports the output of each channel to .wav files.
- useful for usage with a channel visualizer such as corrscope.
## export VGM
## VGM
this option allows exporting to a VGM (Video Game Music) file. these can be played back with VGMPlay (for example).
@ -40,9 +41,6 @@ the following settings exist:
- **custom**: allows you to specify how many ticks to add.
- `0` is effectively none, disabling loop trail completely.
- this option will not appear if the loop modality isn't set to None as there wouldn't be a need to.
- **chips to export**: select which chips are going to be exported.
- due to VGM format limitations, you can only select up to two of each chip type.
- some chips will not be available, either because VGM doesn't support these yet, or because you selected an old format version.
- **add pattern change hints**: this option adds a "hint" when a pattern change occurs. only useful if you're a developer.
- the format of the "hint" data block that gets written is: `67 66 FE ll ll ll ll 01 oo rr pp pp pp ...`
- `ll`: length, a 32-bit little-endian number
@ -51,12 +49,9 @@ the following settings exist:
- `pp`: pattern index (one per channel)
- **direct stream mode**: this option allows DualPCM to work. don't use this for other chips.
- may or may not play well with hardware VGM players.
click on **click to export** to begin exporting.
## export text
this option allows you to export your song as a text file.
- **chips to export**: select which chips are going to be exported.
- due to VGM format limitations, you can only select up to two of each chip type.
- some chips will not be available, either because VGM doesn't support these yet, or because you selected an old format version.
## export ZSM
@ -72,21 +67,21 @@ the following settings are available:
- **loop**: enables loop. if disabled, the song won't loop.
- **optimize size**: removes unnecessary commands to reduce size.
click on **Begin Export** to... you know.
## export text
this option allows you to export your song as a text file.
## export command stream
this option exports a binary file which contains a dump of the internal command stream produced when playing the song.
this option exports a binary file in Furnace's own command stream format (FCS) which contains a dump of the internal command stream produced when playing the song.
it's not really useful, unless you're a developer and want to use a command stream dump for some reason (e.g. writing a hardware sound driver).
- **export**: exports in Furnace's own command stream format (FCS). see `export-tech.md` in `papers/` for details.
it's not really useful, unless you're a developer and want to use a command stream dump for some reason (e.g. writing a hardware sound driver). see `export-tech.md` in `papers/` for details.
## export DMF
this option allows you to save your song as a .dmf which can be opened in DefleMask.
the following systems are supported when saving as 1.0/legacy:
the following systems are supported when saving as 1.0/legacy (0.12):
- Sega Genesis/Mega Drive (YM2612 + SN76489)
- Sega Genesis/Mega Drive (YM2612 + SN76489, extended channel 3)
- Sega Master System
@ -97,7 +92,7 @@ the following systems are supported when saving as 1.0/legacy:
- Arcade (YM2151 + SegaPCM 5-channel compatibility)
- Neo Geo CD (DefleMask 1.0+)
the following systems are supported when saving as 1.1.3+:
the following systems are also supported when saving as 1.1.3+:
- Sega Master System (with FM expansion)
- NES + Konami VRC7
- Famicom Disk System