diff --git a/doc/2-interface/menu-bar.md b/doc/2-interface/menu-bar.md index b53aa5f78..9a5c2d17b 100644 --- a/doc/2-interface/menu-bar.md +++ b/doc/2-interface/menu-bar.md @@ -2,6 +2,8 @@ the menu bar allows you to select from five menus: file, edit, settings, window and help. +items in _italics_ don't appear in basic mode and are only available in advanced mode. + # file - **new...**: create a new song. @@ -38,12 +40,12 @@ the menu bar allows you to select from five menus: file, edit, settings, window - **export command stream...**: export song data to a command stream file. see next section for more details. - this option is for developers. -- **add chip...**: add a chip to the current song. -- **configure chip...**: set a chip's parameters. +- _**add chip...**:_ add a chip to the current song. +- _**configure chip...**:_ set a chip's parameters. - for a list of parameters, see [7-systems](../7-systems/README.md). -- **change chip...**: change a chip to another. +- _**change chip...**:_ change a chip to another. - **Preserve channel positions**: enable this option to make sure Furnace does not auto-arrange/delete channels to compensate for differing channel counts. this can be useful for doing ports, e.g. from Genesis to PC-98. -- **remove chip...**: remove a chip. +- _**remove chip...**_: remove a chip. - **Preserve channel positions**: same thing as above. - **restore backup**: restore a previously saved backup. @@ -99,10 +101,10 @@ the following settings exist: - 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 - - oo: order - - rr: initial row (a 0Dxx effect is able to select a different row) - - pp: pattern index (one per channel) + - `ll`: length, a 32-bit little-endian number + - `oo`: order + - `rr`: initial row (a 0Dxx effect is able to select a different row) + - `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. @@ -140,7 +142,7 @@ it's not really useful, unless you're a developer and want to use a command stre - **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. -- **paste special...**: variants of the paste feature. +- _**paste special...**:_ variants of the paste feature. - **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. @@ -154,8 +156,8 @@ it's not really useful, unless you're a developer and want to use a command stre - 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) +- _**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. @@ -188,7 +190,7 @@ it's not really useful, unless you're a developer and want to use a command stre - **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). +- _**find/replace**:_ shows [the Find/Replace window](../8-advanced/find-replace.md). - **clear**: allows you to mass-delete things like songs, instruments and the like. @@ -213,12 +215,12 @@ all these menu items show or hide their associated windows. - [samples](../6-sample/README.md) - [orders](order-list.md) - [pattern](../3-pattern/README.md) -- [mixer](mixer.md) -- [grooves](grooves.md) -- [channels](channels.md) -- [pattern manager](pat-manager.md) -- [chip manager](chip-manager.md) -- [compatibility flags](compat-flags.md) +- _[mixer](mixer.md)_ +- _[grooves](grooves.md)_ +- _[channels](channels.md)_ +- _[pattern manager](pat-manager.md)_ +- _[chip manager](chip-manager.md)_ +- _[compatibility flags](compat-flags.md)_ - [song comments](comments.md) - [piano](piano.md) @@ -246,5 +248,5 @@ at the end of the menu bar, more information may be shown: - volume in decimal, hex, and percentage. - effect type and description. - during playback, the current values of the following will be listed:\ - speed/groove @ tick rate (BPM) | order | row | elapsed time. + > speed/groove @ tick rate (BPM) | order | row | elapsed time. - if any changes or edits have been made but not yet saved, "modified" will appear. diff --git a/doc/2-interface/song-info.md b/doc/2-interface/song-info.md index 7919e7bec..03d698576 100644 --- a/doc/2-interface/song-info.md +++ b/doc/2-interface/song-info.md @@ -1,13 +1,13 @@ # song info - **Name**: The track's title. -- **Author**: List of contributors to a song. If the song is a cover of someone else's track, it's customary to list their name first, followed by `[cv. YourName]`. +- **Author**: List of contributors to a song. If the song is a cover of someone else's work, it's customary to list their name first, followed by `[cv. YourName]`. - **Album**: The associated album name, the name of the game the song is from, or whatever. -- **System**: The game console or computer the track is designed for. This is automatically set when creating a new tune, but it can be changed to anything one wants. The **Auto** button will provide a guess based on the chips in use. +- **System**: The game console or computer the track is designed for. This is automatically set when creating a new tune, but in advanced mode, it can be changed to anything one wants. 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 a WAV export, however. -**Tuning (A-4)**: Set tuning based on the note A-4, which should be 440 in most cases. Opening an Amiga MOD will set it to 436 for hardware compatibility. +- _**Tuning (A-4)**:_ Set tuning based on the note A-4, which should be 440 in most cases. Opening an Amiga MOD will set it to 436 for hardware compatibility. Available only in advanced mode. # subsongs @@ -23,6 +23,8 @@ This window allows one to create **subsongs** - multiple individual songs within There are multiple ways to set the tempo of a song. +Items in _italics_ don't appear in basic mode and are only available in advanced mode. + **Tick Rate**: The frequency of ticks per second, thus the rate at which notes and effects are processed. - All values are allowed for all chips, though most chips have hardware limitations that mean they should stay at either 60 (approximately NTSC) or 50 (exactly PAL). - Clicking the Tick Rate button switches to a more traditional **Base Tempo** BPM setting. @@ -30,14 +32,14 @@ There are multiple ways to set the tempo of a song. **Speed**: The number of ticks per row. - Clicking the "Speed" button changes to more complex modes covered in the [grooves] page. -**Virtual Tempo**: Simulates any arbitrary tempo without altering the tick rate. It does this by adding or skipping ticks to approximate the tempo. The two numbers represent a ratio applied to the actual tick rate. Example: +_**Virtual Tempo**:_ Simulates any arbitrary tempo without altering the tick rate. It does this by adding or skipping ticks to approximate the tempo. The two numbers represent a ratio applied to the actual tick rate. Example: - Set tick rate to 150 BPM (60 Hz) and speed to 6. - Set the first virtual tempo number (numerator) to 200. - Set the second virtual tempo number (denominator) to 150. - The track will play at 200 BPM. - The ratio doesn't have to match BPM numbers. Set the numerator to 4 and the denominator to 5, and the virtual BPM becomes 150 × 4/5 = 120. -**Divider**: Changes the effective tick rate. A tick rate of 60Hz and a divisor of 6 will result in ticks lasting a tenth of a second each! +_**Divider**:_ Changes the effective tick rate. A tick rate of 60Hz and a divisor of 6 will result in ticks lasting a tenth of a second each! **Highlight**: Sets the pattern row highlights: - The first value represents the number of rows per beat. @@ -46,4 +48,4 @@ There are multiple ways to set the tempo of a song. **Pattern Length**: The length of each pattern in rows. This affects all patterns in the song, and every pattern must be the same length. (Individual patterns can be cut short by `0Bxx`, `0Dxx`, and `FFxx` commands.) -**Song Length**: How many orders are in the order list. Decreasing it will hide the orders at the bottom. Increasing it will restore those orders; increasing it further will add new orders of all `00` patterns. +_**Song Length**:_ How many orders are in the order list. Decreasing it will hide the orders at the bottom. Increasing it will restore those orders; increasing it further will add new orders of all `00` patterns. diff --git a/doc/3-pattern/README.md b/doc/3-pattern/README.md index d3e0b86f4..8cbf66f80 100644 --- a/doc/3-pattern/README.md +++ b/doc/3-pattern/README.md @@ -74,7 +74,7 @@ Space | toggle note input (edit) ![keyboard](keyboard.png) - pressing any of the respective keys will insert a note at the cursor's location, and then advance it by the Edit Step. -- note off turns off the last played note in that channel (key off on FM; note cut otherwise). +- note off turns off the last played note in that channel (key off for FM; note cut otherwise). - note release triggers macro release (and in FM channels it also triggers key off). - macro release does the same as above, but does not trigger key off in FM channels. @@ -91,4 +91,8 @@ if the effect value is not present, it is treated as `00`. most effects run until canceled using an effect of the same type with effect value `00`, with some exceptions. -for a list of effects [click here](effects.md). +here's [a list of effects](effects.md). + +# pop-up menu + +right-clicking within the pattern view brings up a pop-up menu with everything in the [edit menu](../2-interface/menu-bar.md) that makes sense for entering data or altering a selected area. diff --git a/doc/8-advanced/clock.png b/doc/8-advanced/clock.png index c051c5fd1..47ca4fd60 100644 Binary files a/doc/8-advanced/clock.png and b/doc/8-advanced/clock.png differ diff --git a/doc/8-advanced/piano.png b/doc/8-advanced/piano.png index 9bf53cf60..ee04dd442 100644 Binary files a/doc/8-advanced/piano.png and b/doc/8-advanced/piano.png differ