Commit 0364a86

Nick Faro committed on
Add screenshots to the documents
commit 0364a86372a549fc49bedd3f1813abbc257c14d5 parent 7772eb1
10 changed files +11−10
Modifiedmanual/src/SUMMARY.md +0−1
@@ -5,7 +5,6 @@
5 5
6 - [Glossary](hUGETracker/glossary.md) 6 - [Glossary](hUGETracker/glossary.md)
7 - [Interface](hUGETracker/interface.md) 7 - [Interface](hUGETracker/interface.md)
8 - [VU meters and oscilloscopes](hUGETracker/vu-meters-oscilloscopes.md)
9 - [Tracker grid](hUGETracker/tracker-grid.md) 8 - [Tracker grid](hUGETracker/tracker-grid.md)
10 - [Order editor](hUGETracker/order-editor.md) 9 - [Order editor](hUGETracker/order-editor.md)
11 - [Song components](hUGETracker/song-components.md) 10 - [Song components](hUGETracker/song-components.md)
Modifiedmanual/src/hUGEDriver/integration.md +1−1
@@ -60,7 +60,7 @@ The function `hUGE_dosound` plays a single tick of the current song when called.
60 60
61 First and foremost, *how often* should that function be called? That actually depends on what the song expects! 61 First and foremost, *how often* should that function be called? That actually depends on what the song expects!
62 62
63 **TODO: screenshot** 63 ![Screenshot of the tempo settings](../img/timer_tempo.png)
64 64
65 If the song does not use "timer playback", then `hUGE_dosound` must be called once per frame. 65 If the song does not use "timer playback", then `hUGE_dosound` must be called once per frame.
66 This is usually done either by calling it from your game's main loop, or by calling it from your VBlank interrupt handler. 66 This is usually done either by calling it from your game's main loop, or by calling it from your VBlank interrupt handler.
Modifiedmanual/src/hUGETracker/effect-editor.md +1−1
@@ -1,6 +1,6 @@
1 # Effect editor 1 # Effect editor
2 2
3 **TODO: updated screenshots** 3 ![Screenshot of the effect editor](../img/effect_editor.png)
4 4
5 The effect editor is a tool for creating effect values in the tracker grid. 5 The effect editor is a tool for creating effect values in the tracker grid.
6 This is especially useful for things like panning, or master volume, which operate on a bit level and may be difficult to input manually. 6 This is especially useful for things like panning, or master volume, which operate on a bit level and may be difficult to input manually.
Modifiedmanual/src/hUGETracker/interface.md +1−1
@@ -3,7 +3,7 @@
3 The hUGETracker interface is styled similarly to conventional trackers such as [ModPlug Tracker](https://www.modplug.com) / [OpenMPT](https://openmpt.org) or [ProTracker](https://en.wikipedia.org/wiki/ProTracker). 3 The hUGETracker interface is styled similarly to conventional trackers such as [ModPlug Tracker](https://www.modplug.com) / [OpenMPT](https://openmpt.org) or [ProTracker](https://en.wikipedia.org/wiki/ProTracker).
4 If you're comfortable composing in a tracker interface, then you'll feel right at home. 4 If you're comfortable composing in a tracker interface, then you'll feel right at home.
5 5
6 **TODO: screenshot of the pattern interface** 6 ![Screenshot of the hUGETracker main interface](../img/interface.png)
7 7
8 Legend: 8 Legend:
9 1. [VU meters and oscilloscopes](./vu-meters-oscilloscopes.md) 9 1. [VU meters and oscilloscopes](./vu-meters-oscilloscopes.md)
Modifiedmanual/src/hUGETracker/subpatterns.md +2−1
@@ -13,7 +13,8 @@ What are subpatterns useful for?
13 - Changing timbre really quickly! (Use effect `9`) 13 - Changing timbre really quickly! (Use effect `9`)
14 - And much more! 14 - And much more!
15 15
16 **TODO: insert screenshot** 16 ![Screenshot of a subpattern with offsets and jumps](../img/subpattern1.png)
17 ![Screenshot of a subpattern with effects](../img/subpattern2.png)
17 18
18 Rows are composed of three columns, similiar *but not identical* to the tracker grid's: 19 Rows are composed of three columns, similiar *but not identical* to the tracker grid's:
19 - an offset, 20 - an offset,
Modifiedmanual/src/hUGETracker/tabs/comments.md +1−1
@@ -1,6 +1,6 @@
1 # Comments 1 # Comments
2 2
3 **TODO: updated screenshot** 3 ![Screenshot of the comments tab](../../img/comment_tab.png)
4 4
5 The **comments** tab allows you to include a comment section with your song, which you can use for acknowledgements, contact information, or anything you want. 5 The **comments** tab allows you to include a comment section with your song, which you can use for acknowledgements, contact information, or anything you want.
6 The comment is limited to 255 characters. 6 The comment is limited to 255 characters.
Modifiedmanual/src/hUGETracker/tabs/general.md +1−1
@@ -1,6 +1,6 @@
1 # General 1 # General
2 2
3 **TODO: updated screenshot** 3 ![Screenshot of the general tab](../../img/general_tab.png)
4 4
5 The **general** tab allows specifying the name, artist, and tempo of your song. 5 The **general** tab allows specifying the name, artist, and tempo of your song.
6 Name and artist are limited to 255 characters each. 6 Name and artist are limited to 255 characters each.
Modifiedmanual/src/hUGETracker/tabs/instruments.md +3−1
@@ -1,6 +1,8 @@
1 # Instruments 1 # Instruments
2 2
3 **TODO: updated screenshot** 3 ![Screenshot of the instruments tab, editing a square instrument](../../img/square_inst_tab.png)
4 ![Screenshot of the instruments tab, editing a wave instrument](../../img/wave_inst_tab.png)
5 ![Screenshot of the instruments tab, editing a noise instrument](../../img/noise_inst_tab.png)
4 6
5 Legend: 7 Legend:
6 8
Modifiedmanual/src/hUGETracker/tabs/waves.md +1−1
@@ -1,6 +1,6 @@
1 # Waves 1 # Waves
2 2
3 **TODO: updated screenshot** 3 ![Screenshot of the waves tab](../../img/wave_tab.png)
4 4
5 The **waves** tab allows you to edit **waveforms** for use by instruments. 5 The **waves** tab allows you to edit **waveforms** for use by instruments.
6 Use the spinner to select which wave you want to edit, and draw manually with the mouse in the displayed waveform viewer. 6 Use the spinner to select which wave you want to edit, and draw manually with the mouse in the displayed waveform viewer.
Deletedmanual/src/hUGETracker/vu-meters-oscilloscopes.md +0−1
@@ -1 +0,0 @@
1 # VU meters and oscilloscopes