furnace/doc/2-interface/menu-bar.md

170 lines
8.4 KiB
Markdown
Raw Normal View History

2023-06-04 07:13:30 +00:00
# menu bar
2023-07-16 18:14:47 +00:00
the menu bar allows you to select from five menus: file, edit, settings, window and help.
2023-06-04 07:13:30 +00:00
2023-09-09 01:16:43 +00:00
items in _italic_ don't appear in basic mode and are only available in advanced mode.
2023-09-11 00:34:13 +00:00
## file
2023-06-04 07:13:30 +00:00
2023-08-25 06:14:06 +00:00
- **new...**: creates a new song.
2023-06-04 07:13:30 +00:00
- **open...**: opens the file picker, allowing you to select a song to open.
- **open recent**: contains a list of the songs you've opened before.
2023-08-25 06:14:06 +00:00
- **clear history**: erases the file history.
2023-06-04 07:13:30 +00:00
- **save**: saves the current song.
- opens the file picker if this is a new song, or a backup.
- **save as...**: opens the file picker, allowing you to save the song under a different name.
- **save as .dmf (1.1.3+)...**: opens the file picker, allowing you to save your song as a .dmf which is compatible with DefleMask 1.1.3 onwards.
- this will only work with the systems mentioned in the next option, plus:
- Sega Master System (with FM expansion)
- NES + Konami VRC7
- Famicom Disk System
- only use this option if you really need it. there are features which DefleMask does not support, like some effects and FM macros, so these will be lost.
- **save as .dmf (1.0/legacy)...**: opens the file picker, allowing you to save your song as a .dmf which is compatible with DefleMask Legacy (0.12) or 1.0.
- this will only work on the following systems:
- Sega Genesis/Mega Drive (YM2612 + SN76489)
- Sega Genesis/Mega Drive (YM2612 + SN76489, extended channel 3)
- Sega Master System
- Game Boy
- PC Engine
- NES
- Commodore 64
- Arcade (YM2151 + SegaPCM 5-channel compatibility)
- Neo Geo CD (DefleMask 1.0+)
- only use this option if you really need it. there are features which DefleMask does not support, like some effects and FM macros, so these will be lost.
2024-02-04 22:48:46 +00:00
- **export**: allows you to export your song into other formats, such as audio files, VGM and more. see the [export](export.md) page for more information.
2023-08-29 17:52:07 +00:00
- **manage chips**: opens the [Chip Manager](../8-advanced/chip-manager.md) dialog.
2023-08-25 06:14:06 +00:00
- **restore backup**: restores a previously saved backup.
2023-06-04 07:13:30 +00:00
- Furnace keeps up to 5 backups of a song.
- the backup directory is located in:
- Windows: `%USERPROFILE%\AppData\Roaming\furnace\backups`
- macOS: `~/Library/Application Support/Furnace/backups`
- Linux/other: `~/.config/furnace/backups`
- this directory grows in size as you use Furnace. remember to delete old backups periodically to save space.
- **do NOT rely on the backup system as auto-save!** you should save a restored backup because Furnace will not save backups of backups.
2023-09-09 01:16:43 +00:00
- **exit**: closes Furnace.
2023-06-04 07:13:30 +00:00
2023-09-11 00:34:13 +00:00
## edit
2023-06-04 07:13:30 +00:00
2023-08-27 15:55:06 +00:00
- **...**: does nothing except prevent accidental clicks on later menu items if the menu is too tall to fit on the program window.
2023-08-25 06:14:06 +00:00
2023-06-04 07:13:30 +00:00
- **undo**: reverts the last action.
- **redo**: repeats what you undid previously.
2023-06-04 07:13:30 +00:00
- **cut**: moves the current selection in the pattern view to clipboard.
- **copy**: copies the current selection in the pattern view to clipboard.
- **paste**: inserts the clipboard's contents in the cursor position.
2023-12-10 03:53:04 +00:00
- you may be able to paste from OpenMPT as well.
- _**paste special...**:_ variants of the paste feature.
2023-06-04 07:13:30 +00:00
- **paste mix**: inserts the clipboard's contents in the cursor position, but does not erase the occupied region.
- **paste mix (background)**: does the same thing as paste mix, but doesn't alter content which is already there.
- **paste with ins (foreground)**: same thing as paste mix, but changes the instrument.
- **paste with ins (background)**: same thing as paste mix (background), but changes the instrument.
- **paste flood**: inserts the clipboard's contents in the cursor position, and repeats until it hits the end of a pattern.
- **paste overflow**: paste, but it will keep pasting even if it runs over another pattern.
- **delete**: clears the contents in the selection.
- **select all**: changes the selection so it covers a larger area.
- if the selection is wide, it will select the rows in a column.
- if the selection is tall, it will select the entire column.
- if a column is already selected, it will select the entire channel.
- if a channel is already selected, it will select the entire pattern.
- _**operation mask**:_ toggles which columns will be affected by the listed operations. [more information here.](../8-advanced/opmask.md)
- _**input latch**:_ determines which data are placed along with a note. [more information here.](../8-advanced/inputlatch.md)
- **note/octave up/down**: transposes notes in the current selection.
- **values up/down**: changes values in the current selection by ±1 or ±16.
- **transpose**: transpose notes or change values by a specific amount.
2023-06-04 07:13:30 +00:00
- **interpolate**: fills in gaps in the selection by interpolation between values.
- **change instrument**: changes the instrument number in a selection.
- **gradient/fade**: replace the selection with a "gradient" that goes from the beginning of the selection to the end.
- does not affect the note column.
- **Nibble mode**: when enabled, the fade will be per-nibble (0 to F) rather than per-value (00 to FF).
- use for effects like `04xy` (vibrato).
- **scale**: scales values in the selection by a specific amount.
- use to change volume in a selection for example.
- **randomize**: replaces the selection with random values.
- does not affect the note column.
- **invert values**: `00` becomes `FF`, `01` becomes `FE`, `02` becomes `FD` and so on.
2023-06-04 07:13:30 +00:00
- **flip selection**: flips the selection so it is backwards.
2023-07-16 20:37:29 +00:00
- **collapse/expand amount**: allows you to specify how much to collapse/expand in the next two menu items.
2023-06-04 07:13:30 +00:00
- **collapse**: shrinks the selected contents.
- **expand**: expands the selected contents.
2023-06-04 07:13:30 +00:00
- **collapse pattern**: same as collapse, but affects the entire pattern.
- **expand pattern**: same as expand, but affects the entire pattern.
2023-06-04 07:13:30 +00:00
- **collapse song**: same as collapse, but affects the entire song.
- it also changes speeds and pattern length to compensate.
- **expand song**: same as expand, but affects the entire song.
- it also changes speeds and pattern length to compensate.
- _**find/replace**:_ shows [the Find/Replace window](../8-advanced/find-replace.md).
2023-09-08 19:18:35 +00:00
- **clear**: opens a window that allows you to mass-delete things like songs, unused instruments, and the like.
2023-06-04 07:13:30 +00:00
2023-09-11 00:34:13 +00:00
## settings
2023-06-04 07:13:30 +00:00
- **full screen**: expands the Furnace window so it covers your screen.
- **lock layout**: prevents you from dragging/resizing docked windows, or docking more.
- **basic mode**: toggles [Basic Mode](basic-mode.md).
- **visualizer**: toggles pattern view particle effects when the song plays.
- **reset layout**: resets the workspace to its defaults.
2023-07-16 18:00:20 +00:00
- **settings...**: shows the Settings window. these are detailed in [settings.md].
2023-06-04 07:13:30 +00:00
2023-09-11 00:34:13 +00:00
## window
2023-06-04 07:13:30 +00:00
2023-07-16 20:37:29 +00:00
all these menu items show or hide their associated windows.
2023-07-16 18:00:20 +00:00
- [song information](song-info.md)
- [subsongs](song-info.md)
- [speed](song-info.md)
- [instruments](../4-instrument/README.md)
- [wavetables](../5-wave/README.md)
- [samples](../6-sample/README.md)
- [orders](order-list.md)
- [pattern](../3-pattern/README.md)
2023-09-10 09:41:15 +00:00
- _[mixer](../8-advanced/mixer.md)_
- _[grooves](../8-advanced/grooves.md)_
- _[channels](../8-advanced/channels.md)_
- _[pattern manager](../8-advanced/pat-manager.md)_
- _[chip manager](../8-advanced/chip-manager.md)_
- _[compatibility flags](../8-advanced/compat-flags.md)_
- [song comments](../8-advanced/comments.md)
- [piano](../8-advanced/piano.md)
- [oscilloscope](../8-advanced/osc.md)
- [oscilloscopes (per-channel)](../8-advanced/chanosc.md)
- [clock](../8-advanced/clock.md)
- [register view](../8-advanced/regview.md)
- [log viewer](../8-advanced/log-viewer.md)
- [stats](../8-advanced/stats.md)
2023-06-04 07:13:30 +00:00
2023-09-11 00:34:13 +00:00
## help
2023-06-04 07:13:30 +00:00
- **effect list**: displays the effect list.
- **debug menu**: this menu contains various debug utilities.
- unless you are working with the Furnace codebase, it's not useful.
2023-07-16 18:00:20 +00:00
- **inspector**: this option shows the Dear ImGui Metrics/Debugger window.
2023-06-04 07:13:30 +00:00
- unless you are working with the Furnace codebase, it's not useful.
- **panic**: this resets all chips while the song is playing, effectively silencing everything.
- **about...**: displays the About screen.
2023-07-16 18:14:47 +00:00
at the end of the menu bar, more information may be shown:
- during editing, information about the data under the cursor will be shown here:
- note or note modifier.
- instrument number and name.
- volume in decimal, hex, and percentage.
- effect type and description.
2023-09-11 00:12:56 +00:00
- during playback, these values will be displayed:
- `speed/groove @ tick rate (BPM) | order | row | elapsed time`
2023-07-16 18:14:47 +00:00
- if any changes or edits have been made but not yet saved, "modified" will appear.