You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/Geonkick_User_Guide.md
+22-39Lines changed: 22 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@
25
25
*[Envelope Point Label](#envelope-point-label)
26
26
*[Manually Input Envelope Point Value](#manually-input-envelope-point-value)
27
27
*[Display Current Selected Coordinates of Envelope Point](#display-current-selected-coordinates-of-envelope-point)
28
-
*[Instrument Graph](#instrument-graph)
28
+
*[Instrument Wave Form](#instrument-wave-form)
29
29
*[Instrument Preset](#instrument-preset)
30
30
*[Oscillator](#oscillator)
31
31
*[Noise Generator](#noise-generator)
@@ -111,7 +111,7 @@ The instrument's user interface serves as the primary window of Geonkick, displa
111
111
-**"Reset" button:** Resets the current instrument to default settings.
112
112
-**"Tune" checkbox:** Toggles the tuning of the current instrument. The output instrument sound will be tuned according to the pressed MIDI key.
113
113
114
-
-**Preset label:**Displays the name of the currently selected instrument; by default, shows "Default".
114
+
-**Preset navigator:**The navigator to select preset folders and presets & kit presets.
115
115
-**MIDI Key:** Displays the current MIDI input key for the instrument. Pressing on the label opens a popup to select a MIDI key for the instrument.
116
116
-**Tabs:** "Controls", "Kit", "Presets", and "Samples", "Settings" switch to instrument main controls, kit, presets, and sample browser UI, settings respectively.
117
117
@@ -137,12 +137,14 @@ The instrument's user interface serves as the primary window of Geonkick, displa
137
137
138
138
The instrument envelope area displays:
139
139
140
-
-**Instrument graph:** Shows the real-time synthesized instrument sound graph.
140
+
-**Instrument graph:** Shows the real-time synthesized instrument sound wave form.
141
141
-**Envelopes:** Various types of envelopes displayed on top of the instrument sound graph.
142
142
-**Envelope points:** Can be added, removed, and moved by the user. Display the values of the envelopes points and also have a context input for the value (Ctrl + left mouse double-click on the point).
143
143
-**Envelope Path Label:** Shows the current selected envelope type and category. For example, "L1/OSC1/AMPL" means the amplitude envelope of Layer 1 of Oscillator 1.
144
144
-**Buttons "L1", "L2", "L3":** Set the envelope area to display only the envelopes for Layer 1, 2, or 3.
145
145
- When hovering over/selecting an envelope point, it displays the point's coordinates (value, time) in the bottom right corner area.
146
+
- Scroll up/down to zoom in/out the envelope area along the time axis. Also, drag left/right to move the zoomed area.
147
+
- A label "1:x" that shows the zoom factor.
146
148
147
149
#### Envelope Points
148
150
@@ -172,9 +174,9 @@ Users can set the value of an envelope point manually with a maximum precision o
172
174
173
175
A more exact values of the coordinates of the currently hovered or selected envelope point are shown in the bottom-right area, displaying both value and time in milliseconds.
174
176
175
-
#### Instrument Graph
177
+
#### Instrument Wave Form
176
178
177
-
The instrument graph shows the real-time synthesized instrument sound. Whenever the user changes instrument controls, Geonkick generates a new graph and updates it.
179
+
The instrument wave from shows the real-time synthesized instrument sound. Whenever the user changes instrument controls, Geonkick generates a new graph and updates it.
178
180
179
181
If the sound exceeds the range of -1.0 to 1.0, the sound is hard-limited to these values, visible in the instrument graph.
180
182
@@ -186,46 +188,39 @@ The instrument preset is in JSON format and uses the file extension "*.gkick". I
186
188
187
189
#### Oscillator
188
190
189
-
Each layer consists of two oscillators, the outputs of which are mixed with a noise generator to produce the layer's output. Controls related to oscillators are grouped and arranged vertically.
191
+
Each layer consists of three oscillators, the outputs of which are mixed with a noise generator to produce the layer's output. Controls related to oscillators are grouped and arranged vertically.
190
192
191
-
-**"Oscillator1" and "Oscillator 2":** Checkboxes to toggle the oscillators on/off.
192
-
-**"Osc1->Osc2":** Checkbox that allows Oscillator1 to FM modulate Oscillator2.
193
-
-**Waveform Types:** "Sine," "Square," "Triangle," "Sawtooth" - options for periodic wave functions of the oscillator.
193
+
-**"OSC1", "OSC2", and "OSC3":** Checkboxes to toggle the oscillators on/off.
194
+
-**"OSC1->OSC2":** Checkbox that allows Oscillator 1 to FM modulate Oscillator 2.
195
+
-**Waveform Types:** "Sine," "Square," "Triangle," "Sawtooth," "Noise," "Sample" – options for wave functions of the oscillator.
196
+
-**Noise:** The oscillator will generate noise ("w" – white, "b" – brownian). Also, there is a "seed" spinbox to set the noise seed.
194
197
-**"Sample":** Represents a sampler with a maximum length of 4 seconds.
195
198
-**"...":** Button to browse and load a sample (WAV, FLAC, or OGG).
196
-
-**"Phase":** Adjusts the initial phase of the oscillator. For samples, this moves the start of the sample up to 1/2 of the instrument sound length.
199
+
-**"Phase":** Adjusts the initial phase of the oscillator. For samples, this moves the start of the sample up to 1/2 of the instrument's sound length.
197
200
-**Amplitude Knob:** Sets the maximum current amplitude of the oscillator.
198
201
-**Frequency Knob:** Sets the maximum current frequency of the oscillator.
199
202
-**Pitch Knob:** Sets the pitch shift range when the waveform is set as a sample.
200
-
-**Pitch Buttons:** Show the envelopes for the pitch shift.
203
+
-**Density Knob:** When the noise wave function is selected, this knob controls the density of the noise.
204
+
-**Pitch Button:** Shows the envelopes for the pitch shift.
205
+
-**Density Button:** Shows the envelope of the noise density.
201
206
-**"Filter" Button:** Enables/Disables the filter for the oscillator.
202
207
-**Envelopes Buttons:** "Amplitude," "Frequency," "Pitch," and "Cutoff" to access envelopes for amplitude, frequency, pitch shift, and filter cutoff, respectively.
203
208
204
-
#### Noise Generator
209
+
**Note:** Loading/saving presets preserves the noise pattern, seed, and density patern.
205
210
206
-
The noise generator creates white and brownian noise.
211
+
#### Global Controls
207
212
208
-
-**"Amplitude":** Sets the maximum noise amplitude and the amplitude envelope.
209
-
-**"White" and "Brownian":** Select the noise type.
210
-
-**"Seed":** Slider to set different seeds for the noise generator.
211
-
-**Filter:** Similar controls to oscillators.
212
-
213
-
Loading/saving presets preserves the noise pattern and seed.
214
-
215
-
#### General Controls
216
-
217
-
General controls are applied after the layers mixer. Arranged vertically and applied from top to bottom. The compressor is applied last.
213
+
Global controls are applied after the layers mixer. Arranged vertically and applied from top to bottom.
218
214
219
215
-**Amplitude Knob:** Controls the maximum amplitude after the layers mixer.
220
216
-**"Amplitude" Button:** Shows the general amplitude envelope.
221
217
-**"Length":** Sets the maximum sound length of the instrument.
222
218
-**Filter Controls:** Similar to oscillator controls.
223
219
-**Distortion:** Drive and volume envelopes can be accessed with "Drive" and "Volume" buttons.
224
-
-**Compressor**
225
220
226
221
#### Limiter
227
222
228
-
The limiter control is applied to the audio output of the instrument, controlling only the currently selected instrument.
223
+
The limiter control is applied to the audio output of the instrument, controlling only the currently selected instrument.
229
224
230
225
*Issues:* When playing the instrument and simultaneously changing the limiter quickly, sound artifacts may occur due to abrupt changes in sound. To adjust the total output amplitude, it's better to use the "General" controls for amplitude.
231
226
@@ -254,15 +249,6 @@ The distortion effect is applied after the general filter and has the following
254
249
-**Drive:** Controls the amount of distortion.
255
250
-**Drive Envelope:** Accessed with the "Drive" button.
256
251
257
-
#### Compressor
258
-
259
-
The compressor is applied after distortion and has the following controls:
260
-
261
-
-**"Attack"**
262
-
-**"Threshold"**
263
-
-**"Ratio"**
264
-
-**"Drive"**
265
-
266
252
*Note:* The compressor is not a standard compressor; it only compresses signal amplitude with a zero release time. It is more useful for creating distortion effects. For standard sound compression, it is recommended to use a dedicated compressor.
267
253
268
254
#### Tune
@@ -273,11 +259,9 @@ In the top bar, the "Tune" checkbox toggles tuning for the currently selected in
273
259
274
260
#### Export
275
261
276
-
The Export dialog can be accessed by clicking the "Export" button in the top bar. It includes the following inputs:
262
+
The Export dialog can be accessed by clicking the "Export" button in the top bar.
-**"Stereo" or "Mono":** Exports into a file with one or two identical channels.
282
266
283
267
Geonkick will export only the currently selected instrument.
@@ -304,6 +288,7 @@ The instrument list has a maximum limit of 16 instruments and displays the instr
304
288
-**Buttons at the end of the instrument line:** Popup for selecting the MIDI key.
305
289
-**Spinbox for setting MIDI input channel for an instrument.**
306
290
-**Column labels:** Show the MIDI key the instrument can be mapped to. The "Any" label indicates that the instrument will be played by pressing any key.
291
+
-**noff:** Turns off/on to ignore the NOTE OFF when the MIDI key is released.
307
292
-**Green circle:** Indicates which instrument is mapped to which output channel and can be changed by left-clicking on the grid cell.
308
293
-**Limiter slider:** Controls the limiter for the current instrument.
309
294
-**"M" button:** Mutes the current instrument.
@@ -379,5 +364,3 @@ The standalone version of Geonkick offers the same features as the LV2 or VST3 p
379
364
### Build & Install
380
365
381
366
For instructions on building and installing Geonkick, please refer to the README file.
0 commit comments