Flesh out manual · hUGETracker

Modifiedmanual/src/SUMMARY.md +23−17

`@@ -1,21 +1,27 @@`
1	`[Introduction](./introduction.md)`	1	`[Introduction](./introduction.md)`
2		2
3	`# Contents`	3	`# hUGETracker`
4		4
5	`- [Glossary](./glossary.md)`	5	`- [Glossary](hUGETracker/glossary.md)`
6	`- [Interface](./interface.md)`	6	`- [Interface](hUGETracker/interface.md)`
7	`- [VU meters and oscilloscopes](./vu-meters-oscilloscopes.md)`	7	`- [VU meters and oscilloscopes](hUGETracker/vu-meters-oscilloscopes.md)`
8	`- [Tracker grid](./tracker-grid.md)`	8	`- [Tracker grid](hUGETracker/tracker-grid.md)`
9	`- [Order editor](./order-editor.md)`	9	`- [Order editor](hUGETracker/order-editor.md)`
10	`- [Song components](./song-components.md)`	10	`- [Song components](hUGETracker/song-components.md)`
11	`- [Toolbar](./toolbar.md)`	11	`- [Toolbar](hUGETracker/toolbar.md)`
12	`- [Tabs]()`	12	`- [Tabs]()`
13	`- [General](./tabs/general.md)`	13	`- [General](hUGETracker/tabs/general.md)`
14	`- [Instruments](./tabs/instruments.md)`	14	`- [Instruments](hUGETracker/tabs/instruments.md)`
15	`- [Waves](./tabs/waves.md)`	15	`- [Waves](hUGETracker/tabs/waves.md)`
16	`- [Comments](./tabs/comments.md)`	16	`- [Comments](hUGETracker/tabs/comments.md)`
17	`- [Effect editor](./effect-editor.md)`	17	`- [Effect editor](hUGETracker/effect-editor.md)`
18	`- [Effect reference](./effect-reference.md)`	18	`- [Effect reference](hUGETracker/effect-reference.md)`
19	`- [Hotkeys](./hotkeys.md)`	19	`- [Hotkeys](hUGETracker/hotkeys.md)`
20	`- [Routines](./routines.md)`	20	`- [Subpatterns](hUGETracker/subpatterns.md)`
21	`- [Miscellaneous](./miscellaneous.md)`	21	`- [Routines](hUGETracker/routines.md)`
		22	`- [Miscellaneous](hUGETracker/miscellaneous.md)`
		23
		24	`# hUGEDriver`
		25
		26	`- [What is hUGEDriver](hUGEDriver/what-is-hugedriver.md)`
		27	`- [Integration](hUGEDriver/integration.md)`

Deletedmanual/src/effect-reference.md +0−27

`@@ -1,27 +0,0 @@`
1	`# Effect reference`
2
3	`The hUGETracker effect codes are intentionally similar to ProTracker and FastTracker's.`
4	`If you know those, then many of these effects will look familiar to you.`
5
6	`Effect \| Name \| Description`
7	`-------\|-------------------\|------------`
8	`0xy` \| Arpeggio \| On every tick switch between the playing note, <math><mi>note</mi> <mo>+</mo> <mi>x</mi></math>, and <math><mi>note</mi> <mo>+</mo> <mi>y</mi></math>, where <var>x</var> and <var>y</var> are values in semitones. Can be used to create "chords" or a strum effect.
9	`1xx` \| Portamento up \| Slide the pitch up by <var>xx</var> units every tick.
10	`2xx` \| Portamento down \| Slide the pitch down by <var>xx</var> units every tick.
11	`3xx` \| Tone portamento \| Instead of playing the cell's note, slide the pitch towards that note by <var>xx</var> units every tick. Stop when the note is reached. This effect cannot be used in a cell with an instrument value.
12	`4xy` \| Vibrato \| Rapidly switch between the playing note and <math><mi>note</mi> <mo>+</mo> <mi>y</mi></math>, at the rate of <var>x</var>, where <var>y</var> is a value in units. Valid values for <var>x</var> are 0, 1, 3, 7, and F. This is similar to arpeggio, except you can control the frequency, and the amount is specified in units rather than semitones.
13	`5xx` \| Set master volume \| Set the [master volume control][NR50] of the Game Boy for the left and right speakers. Use the effect editor to create one of these effects. Note that a volume of 0 is not completely silent!
14	`6xx` \| Call routine \| Call a user-defined [routine](./routines.md). Will crash if an invalid routine is specified.
15	`7xx` \| Note delay \| Wait <var>xx</var> ticks before playing the note in this cell. The note won't be played at all if `xx` is strictly greater than the tempo!
16	`8xx` \| Set panning \| Set [which channels play on which speakers][NR51]. Use the effect editor to create one of these effects. Can also be used as a mute for a channel, by setting it to output on neither left nor right.
17	`9xx` \| Set duty cycle \| Select the duty cycle for either channel 1 or channel 2. If this effect appears on the noise or wave channels, it will affect channel 2. Valid values for <var>xx</var> are `00`, `40`, `80`, or `C0`. Under the hood, the <var>xx</var> value is written directly into CH1 or CH2's [length register][NR11], so you could theoretically achieve other effects than just duty cycle changing.
18	`Axy` \| Volume slide \| Slide the note's volume up by <var>x</var> units, and then down by <var>y</var> units. This effect actually retriggers the note on each tick, which might not be noticeable for instruments without length or envelope, but may sound bad if those are present. It is recommended to use either instrument envelopes, or the `C` command instead, if you can. This effect does not work in the same cell as a note/instrument!
19	`Bxx` \| Position jump \| Jump to order <var>xx</var>.
20	`Cxx` \| Set volume \| Set the volume of the channel to <var>xx</var>. Must be accompanied by a note and instrument to work (except on channel 3). Valid values range from `00` to `0F`.
21	`Dxx` \| Pattern break \| Jump to the next order, and start on row <var>xx</var>.
22	`Exx` \| Note cut \| Cut the note short after <var>xx</var> ticks.
23	`Fxx` \| Set tempo \| Set the number of ticks per row to <var>xx</var>. Can be used in an alternating fashion to create a swing beat.
24
25	`[NR11]: https://eldred.fr/pandocs/Audio_Registers.html#ff11--nr11-channel-1-length-timer--duty-cycle`
26	`[NR50]: https://eldred.fr/pandocs/Audio_Registers.html#ff24--nr50-master-volume--vin-panning`
27	`[NR51]: https://eldred.fr/pandocs/Audio_Registers.html#ff25--nr51-sound-panning`

Addedmanual/src/hUGEDriver/integration.md +5−0

`@@ -0,0 +1,5 @@`
	1	`# Integration`
	2
	3	`## SFX`
	4
	5	`Note that "global" SFX (5, 8, B, D, and F) still play even if muted`

Addedmanual/src/hUGEDriver/what-is-hugedriver.md +1−0

`@@ -0,0 +1 @@`
		1	`# What is hUGEDriver`

Renamedmanual/src/effect-editor.md → manual/src/hUGETracker/effect-editor.md +0−0