From 36084ccb8ef80c1559b824c4cc5dac4819fc0416 Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Wed, 14 Jan 2026 19:10:39 -0800 Subject: [PATCH] A bunch of tweaks to docs. --- doc/1-intro/README.md | 8 ++++---- doc/1-intro/quickstart.md | 8 ++++++-- doc/3-pattern/effects.md | 4 ++-- doc/4-instrument/README.md | 2 +- doc/6-sample/README.md | 2 +- doc/7-systems/ay8910.md | 4 ++-- doc/README.md | 2 +- 7 files changed, 17 insertions(+), 13 deletions(-) diff --git a/doc/1-intro/README.md b/doc/1-intro/README.md index fef6fb590..49514a0cf 100644 --- a/doc/1-intro/README.md +++ b/doc/1-intro/README.md @@ -16,7 +16,7 @@ Furnace uses hexadecimal (abbreviated as "hex") numbers frequently. see [this gu ## interface -Furnace uses a music tracker interface. think of a table with music notes written on it. then that table scrolls up and plays the notes. +Furnace uses a music tracker interface. it can be thought of as a spreadsheet for notes. for an introduction to a tracker interface, see [tracker concepts and terms](concepts.md) before using Furnace. there's also a [glossary of common terms](glossary.md). @@ -26,9 +26,9 @@ once familiar with the tracker, look to [9-guides](../9-guides/README.md) for us ## tutorial? -[How to Learn Chiptune Trackers](https://www.youtube.com/watch?v=Q37XuOLz0jw): video tutorial created by Button Masher. covers the basic mechanics of chiptune tracking using Furnace for demonstration. - -[Furnace Tutorials](https://youtube.com/playlist?list=PLCELB6AsTZUnwv0PC5AAGHjvg47F44YQ1): video tutorials created by Spinning Square Waves. be noted that these may not apply to the current version. +- the [quick start guide](quickstart.md): text and images tutorial. offers a learn-by-doing approach. always up to date. +- [How to Learn Chiptune Trackers](https://www.youtube.com/watch?v=Q37XuOLz0jw): video tutorial created by Button Masher. covers the basic mechanics of chiptune tracking using Furnace for demonstration. +- [Furnace Tutorials](https://youtube.com/playlist?list=PLCELB6AsTZUnwv0PC5AAGHjvg47F44YQ1): video tutorials created by Spinning Square Waves. be noted that these may not apply to the current version. ## for more information diff --git a/doc/1-intro/quickstart.md b/doc/1-intro/quickstart.md index 9928e0c08..1be34fae4 100644 --- a/doc/1-intro/quickstart.md +++ b/doc/1-intro/quickstart.md @@ -3,7 +3,7 @@ Furnace is amazingly versatile, but it can also be intimidating, even for those already familiar with trackers. this quick start guide will get you on the road to making the chiptunes of your dreams! if you're a beginner, it will probably take about an hour from start to finish. this guide makes a few assumptions: -* you've already installed Furnace and know where to find the demo files that come with it. look for `quickstart.fur` but don't open it yet. +* you've already installed Furnace and know where to find the `demos` folder that comes with it. look for `quickstart.fur` but don't open it yet. * you haven't changed any configuration or layout yet. it should start up with the default Sega Genesis system. * you're working with a PC keyboard, US English, QWERTY layout. Mac users should already know the equivalents to the `Ctrl` and `Alt` keys. * you're comfortable with keyboard shortcuts. if not, a lot of this can also be done using buttons or menus, but please try the keyboard first. it's worth it to smooth out the tracking workflow. @@ -211,7 +211,7 @@ in the pattern view, add a few notes spaced far enough apart that the whole rise ![volume macro with release](qs-macro-release.png) -about ten rows after the last note in our song, place a note off. the final note rises to maximum, then is suddenly cut off! to get the rest of the macro to play, move your cursor over the note off and use the `~` key to replace it with a **macro release** instead, which will appear as `REL`. now when the song is played back, the final note will rise and hold steady until it reaches the macro release, then we'll hear the rest of the macro play out. +about ten rows after the last note in our song, place a note off. the final note rises to maximum, then is suddenly cut off! to get the rest of the macro to play, move your cursor over the note off and use the `` ` `` key ("backtick") to replace it with a **macro release** instead, which will appear as `REL`. now when the song is played back, the final note will rise and hold steady until it reaches the macro release, then we'll hear the rest of the macro play out. macros are absurdly powerful tools. read the [macro documentation](../4-instrument/README.md) to make the most of them! @@ -219,4 +219,8 @@ macros are absurdly powerful tools. read the [macro documentation](../4-instrume now you know the basics of how to make music with Furnace. from here, the rest of the documentation should make more sense, and it should be your primary reference. if you have questions that aren't answered there, feel free to ask in the [Discussions section](https://github.com/tildearrow/furnace/discussions) on Furnace's GitHub repository. +a great way to learn how to make your own music is to study how others have done it. try the demo modules! not only do they sound good and show off Furnace's capabilities, but they're also great for learning tracking techniques. one recommended method is this: open a demo track you like, open a second copy, save it to a new file, use the menu option "edit > clear..." and click "clear all subsongs", and remake the track by transcribing from the original. + +remember that everything in the `instruments` folder is free for you to use in your own music, as well as instruments found in the demo songs. + most of all, don't be afraid to experiment. go play! diff --git a/doc/3-pattern/effects.md b/doc/3-pattern/effects.md index dacf4e1cc..288bb5bac 100644 --- a/doc/3-pattern/effects.md +++ b/doc/3-pattern/effects.md @@ -111,7 +111,7 @@ not all chips support these effects. - `0Cxx`: **Retrigger.** repeats current note every `xx` ticks. - this effect is not continuous; it must be entered on every row. -- `ECxx`: **Note cut.** triggers note off after `xx` ticks. this triggers key off in FM/hardware envelope chips, or cuts note otherwise. +- `ECxx`: **Note cut.** triggers note off after `xx` ticks. this triggers key off in FM/hardware envelope chips, or cuts the note otherwise. - `EDxx`: **Note delay.** delays note by `x` ticks. - `FCxx`: **Note release.** releases current note after `xx` ticks. this releases macros and triggers key off in FM/hardware envelope chips. - `E7xx`: **Macro release.** releases macros after `xx` ticks. this does not trigger key off. @@ -129,7 +129,7 @@ sample offset is a 24-bit (3 byte) number. you may use these effects simultaneously in a row. -if you do not set a byte, its last value will be used. +if you do not set a byte, its its most recent value will be used. in previous versions of Furnace a `9xxx` effect existed which set the sample position to `$xxx00` (`xxx` was effectively multiplied by 256). this maps to `920x 91xx` in current Furnace. diff --git a/doc/4-instrument/README.md b/doc/4-instrument/README.md index 760daa6d2..4bb23deff 100644 --- a/doc/4-instrument/README.md +++ b/doc/4-instrument/README.md @@ -3,7 +3,7 @@ the instrument editor allows you to edit instruments. it can be activated by double-clicking on an instrument in the instrument list. -alternatively, window > instrument editor displays it. +alternatively, the menu item "window > assets > instrument editor" displays it. ## main diff --git a/doc/6-sample/README.md b/doc/6-sample/README.md index 64b3de9d9..d10ed6ae3 100644 --- a/doc/6-sample/README.md +++ b/doc/6-sample/README.md @@ -65,7 +65,7 @@ due to limitations in some of those sound chips, some restrictions exist: - Seta/Allumer X1-010: frequency resolution is terrible in the lower end. your sample can't be longer than 131072. - C219: sample lengths and loop will be set to an even number, and your sample can't be longer than 131070. -furthermore, many of these chips have a limited amount of sample memory. check memory usage with the Memory Composition window (found in the "debug" submenu of the "window" menu). +furthermore, many of these chips have a limited amount of sample memory. check memory usage with the Memory Composition window (menu item "window > debug > memory composition"). ## the sample editor diff --git a/doc/7-systems/ay8910.md b/doc/7-systems/ay8910.md index 67c842f52..32b0133b9 100644 --- a/doc/7-systems/ay8910.md +++ b/doc/7-systems/ay8910.md @@ -60,8 +60,8 @@ its origin is a wavetable that comes in DefleMask that happens to be called Obel AY-3-810 was an absurdly popular chip that was blessed with many third-party clones, licensed or not. - the AY-3-8914 variant was used in Intellivision, which is pretty much an 8910 with 4 level envelope volume per channel and different register format. -- Yamaha YM2149 was an AY-3-8910 clone released in 1983. it's almost identical to AY with minor differences being: higher hardware envelope step resolution (16 vs 32), half-clock mode when voltage level is low, much stronger DC offset and cleaner, but softer output. -- Sunsoft 5B is YM2149 clone with half-clock mode forced on. +- Yamaha YM2149 is an AY-3-8910 clone released in 1983. it's almost identical to AY with minor differences being: higher hardware envelope step resolution (16 vs 32), half-clock mode when voltage level is low, much stronger DC offset and cleaner, but softer output. +- Sunsoft 5B is a YM2149 clone with half-clock mode forced on. ## info diff --git a/doc/README.md b/doc/README.md index 8683a64dc..f04eb712f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -29,7 +29,7 @@ the index follows. ## information -copyright © 2024 tildearrow and other authors. +copyright © 2026 tildearrow and other authors. this documentation is under the [Creative Commons Attribution 3.0 Unported](https://creativecommons.org/licenses/by/3.0/) license. you may reproduce, modify and/or distribute this documentation provided this copyright notice (including license and attribution) is present and any necessary disclaimers whether modifications have been made.