Disabled a debug message.
[epichord.git] / doc / manual.txt
blob539db8414500f7a9fbc59443b16cdc3f4e1a8dc3
1 Song View Widgets
3 1 pattern block arranger - this canvas area allows you to create, move, resize, delete, copy, 
4 join, split, recolor, mute and unmute blocks, among other things.
6 2 song timeline - it shows you where in the song you are putting blocks. Use the mouse buttons 
7 to change the loop endpoints and change the song position.
9 3 track info panel - contains a lot of info about tracks. Press the + button to toggle more 
10 track settings.
12 4 track selector - the piano keys next to a track means that recording and keyboard input will 
13 use this track.
15 5 track name - you can put whatever you want here. epichord uses fltk2's unicode support.
17 6 track settings - these widgets display the track settings and allow you to edit their values. 
18 Volume, pan, solo, and mute widgets are displayed by default. Press + at the top of the track 
19 info panel to toggle the program, bank, channel, and port settings. Drag your mouse on a widget 
20 to change the value or use the mouse wheel.
22 7 color tool - when the color tool button is activated, your mouse will edit the color of 
23 blocks. Drag on a block to change the color. Click on a block to copy color. Middle click on a 
24 block to paste color. Right click on a block to paste color on the entire channel. Your last 
25 used color will be used as a basis for future block insertions.
27 8 unclone tool - when blocks are copied the default behavior is to make clones. Any changes to 
28 a clone block will affect the pattern in other clones. Use the clone tool to make a clone unique 
29 with its own copy of a pattern.
31 9 join tool - after pressing join, click on two blocks that are adjacent. These blocks will be 
32 joined. If either are clones, they will be uncloned first.
34 10 split tool - after pressing split, click on a block at a position you want to split it. The 
35 block will be split into two new blocks. If it is a clone it will be uncloned first.
39 Global Widgets
41 1 play/pause - Press this to make the sequencer start playing the song from the current play 
42 position. Press it again to pause playback at current play position. Pause sends all notes off 
43 and all sound off midi messages.
45 2 stop - Press this to stop the sequencer and reset the play position to zero. Any time the play 
46 position becomes zero by any means, tracks will be reset to values shown in their track 
47 settings. Stop sends all notes off and all sound off on all tracks. This can be used as a panic 
48 button.
50 3 record - When this is pressed and the sequencer is playing, midi input, keyboard input, and 
51 virtual keyboard input will be recorded. The default is to insert events into existing blocks 
52 only. More advanced behavior is described in the manual section on recording.
54 4 metronome - A graphical metronome to help keep rhythm.
56 5 loop toggle - When pressed the song will loop between loop points.
58 6 configuration - Opens the configuration panel.
60 7 scope - Opens the midi scope panel.
62 8 file - Opens the file menu so you can save or load your work.
64 9 help - Opens the info panel with help docs and song info.
67 Pattern Editor Widgets
69 1 piano roll - This canvas area lets you insert, move, resize, copy, and delete notes.
71 2 virtual keyboard - Lets you see where you are placing the notes. You can also click on it with 
72 the mouse to play notes. Space bar acts as a sustain pedal. The + button above the virtual keyboard 
73 does nothing.
75 3 pattern timeline - Equivalent to the arranger timeline except zero is the start of the block 
76 rather than the start of the song, and it counts beats rather than measures. Use the mouse to 
77 set loop endpoints or change the song position.
79 4 event editor - Shows you the value of many midi messages that are stored in the pattern. By 
80 default it shows the note on velocity, but you can change that with the mouse wheel or by 
81 opening the event type menu with the E button on the right. You can also create, delete, or 
82 modify event values with the mouse.
84 5 back button - Exist the pattern editor and return to the block arranger.
86 6 quantization settings - Inserting, moving, and resizing operations will be snapped to the grid 
87 using granularity chosen by these buttons. The shorter the note length, the smaller the grid 
88 snap width. Simply imagine placing quarter notes or eighth notes when you click on the canvas. 
89 Press the blank button to turn off snapping altogether.
91 7 quantize note on - Quantize the selected notes so they snap to the grid using the current 
92 quantization settings.
94 8 quantize note off - This is the same as quantize note on, but it effectively quantizes the 
95 length of the note.