Minor docs tweaks and fixes.

This commit is contained in:
Electric Keet 2024-07-26 11:12:30 -07:00 committed by tildearrow
parent 6037adab51
commit edf5cb38af
3 changed files with 14 additions and 11 deletions

View file

@ -53,7 +53,7 @@ the following settings exist:
- 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
## ZSM
ZSM (ZSound Music) is a format designed for the Commander X16 to allow hardware playback.
it may contain data for either YM2151 or VERA chips.
@ -67,17 +67,17 @@ the following settings are available:
- **loop**: enables loop. if disabled, the song won't loop.
- **optimize size**: removes unnecessary commands to reduce size.
## export text
## Text
this option allows you to export your song as a text file.
## export command stream
## Command Stream
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). see `export-tech.md` in `papers/` for details.
## export DMF
## DMF
this option allows you to save your song as a .dmf which can be opened in DefleMask.

View file

@ -2,7 +2,8 @@
the Settings window allows you to change Furnace settings.
settings are saved when clicking the **OK** or **Apply** buttons at the bottom of the window.
settings are saved when clicking the **OK** or **Apply** buttons at the bottom of the window, and when closing the program. several backups are kept in the Furnace settings directory.
## General
@ -11,8 +12,8 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
- **Language**: select the language used for the interface. some languages are incomplete, and are listed with their approximate completion percentage.
- **Render backend**: changing this may help with performace or compatibility issues. the available render backends are:
- SDL Renderer: this was the only available render backend prior to the addition of dedicated OpenGL/DirectX backends in 0.6. default on macOS.
- DirectX 11: works with the majority of graphics chips/cards and is optimized specifically for Windows.
- it is slower than the other backends.
- DirectX 11: works with the majority of graphics chips/cards and is optimized specifically for Windows.
- DirectX 9: use if your hardware is incompatible with DirectX 11.
- OpenGL 3.0: works with the majority of graphics chips/cards (from 2010 onwards). default on Linux.
- OpenGL 2.0: use if you have a card without OpenGL 3.0 support.
@ -54,7 +55,9 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
- **Remember last values**
- **Store instrument name in .fui**: when enabled, saving an instrument will store its name. this may increase file size.
- **Load instrument name from .fui**: when enabled, loading an instrument will use the stored name (if present). otherwise, it will use the file name.
- **Auto-fill file name when saving**: pre-fill the file name field with an appropriate name when saving or exporting.
- **Auto-fill file name when saving**: pre-fill the file name field when saving or exporting.
- when saving a module, the existing file name will be auto-filled.
- when saving an instrument or sample, its name will be auto-filled.
### New Song
@ -88,7 +91,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
### Configuration
- **Import**: select an exported `.ini` config file to overwrite current settings.
- **Export**: select an `.ini` file to save current settings.
- **Factory Reset**: resets all settings to default.
- **Factory Reset**: resets all settings to default and purges settings backups.
## Audio
@ -575,12 +578,12 @@ below all the binds, select a key from the dropdown list to add it. it will appe
- **Enable backup system**: turn on automatic backups of the current open file.
- **Interval (in seconds)**: time between automatic backups.
- **Backups per file**: maximum number of backups to store for each file.
- **Backups per file**: maximum number of backups to store for each file. oldest backups are deleted first.
### Backup Management
- **Purge before**:
- **Go**: purge backups whose filenames precede the selected date.
- **Go**: purge all backups from before the selected date.
- total space used by all backups:
- **Refresh**: recalculate space.
- **Delete All**: purge all backups.

View file

@ -3,7 +3,7 @@
- **Name**: the track's title.
- **Author**: the author(s) of this track.
- **Album**: the associated album name (or the name of the game the song is from).
- **System**: the game console or computer the track is designed for. this is automatically set when creating a new tune, but can be changed to anything. the **Auto** button will provide a guess based on the chips in use.
- **System**: the name of the game console or computer the track is designed for. this is automatically set when creating a new tune, but can be changed to anything. the **Auto** button will provide a guess based on the chips in use.
all of this metadata will be included in a VGM export. this isn't the case for an audio export, however.