Skip to content

Commit

Permalink
Merge pull request #1434 from tildearrow/doc-general
Browse files Browse the repository at this point in the history
Docs update for 0.6pre9.
  • Loading branch information
tildearrow authored Aug 28, 2023
2 parents decd2fd + 0b5afcb commit cfd5131
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 7 deletions.
4 changes: 2 additions & 2 deletions doc/2-interface/asset-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ Everything from the instrument list applies here also, with one major difference

![samples window](samples.png)

Everything from the wavetables list applies here also, with the addition of two buttons before the Delete button:
Everything from the wavetables list applies here also, with the addition of one button before the Delete button:
- **Preview**: Plays the selected sample at its default note.
- **Stop preview**: Stops the sample playback.
- Right-clicking stops the sample playback.
Binary file modified doc/2-interface/samples.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/4-instrument/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ This tab appears for PC Engine, FDS, Namco WSG, and other wavetable-based instru

![wavetable tab](wavetable.png)

When **Enable synthesizer** is off, the only option is to select a wavetable entry with the text entry box beneath the **Wave 1** preview.
When **Enable synthesizer** is off, the wavetable used for the instrument may be selected by creating a Waveform macro with a single value.

To use the wavetable synthesizer, refer to the bottom part of [the wavetable documentation](../5-wave/README.md).

Expand Down
10 changes: 7 additions & 3 deletions doc/4-instrument/fmopll.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,18 @@ The OPLL synthesizer is two-operator, meaning it takes two oscillators to produc
These apply to the instrument as a whole:
- **Feedback (FB)**: Determines how many times operator 1 returns its output to itself. (0-7 range)
- **Sustain (SUS)**: enables the sustain flag (sets the release rate to 5)
- algorithm: shows the connection of operators (though they are always connected the same way).
- Right-click to switch to a preview display of the waveform generated on a new note:
- Left-click restarts the preview.
- Middle-click pauses and unpauses the preview.
- Right-click returns to algorithm view.
- **DC (half-sine carrier)**: Sets the waveform produced by carrier operator to half-sine
- **DM (half-sine modulator)**: Sets the waveform produced by modulator operator to half-sine

To the right, there is a drop down menu for OPLL preset instrument selection.
- preset dropdown: select OPLL preset instrument.

These apply to each operator:
- The crossed-arrows button can be dragged to rearrange operators.
- The **OP1**, **OP2** buttons enable or disable those operators.
- The **OP1** and **OP2** buttons enable or disable those operators.
- **Amplitude Modulation (AM)**: Makes the operator affected by LFO tremolo.
- **Envelope generator sustain flag (EGS)**: When enabled, value of Sustain Level is in effect.
- **Attack Rate (AR)**: determines the rising time for the sound. The bigger the value, the faster the attack. (0-15 range)
Expand Down
10 changes: 9 additions & 1 deletion doc/4-instrument/snes.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,15 @@ these tabs are unique to the editor for SNES instruments.
- **Effective (exponential decrease)**: after release, volume decays exponentially. see [gain chart](../7-systems/snes.md).
- **Delayed (write R on release)**: after release, waits until A and D have completed before starting exponential decrease.

if envelope is off, select gain mode as described below.
if envelope is off:
- **Gain Mode**: select gain mode.
- **Direct**: direct gain from 0 to 127
- **Decrease (linear)**: linear gain from -0 to -31
- **Decrease (logarithmic)**: exponential gain from -0 to -31
- **Increase (linear)**: linear gain from +0 to +31
- **Increase (bent line)**: exponential gain from +0 to +31
- _note:_ using decrease modes will not produce any sound unless a Gain macro is set. The first tick must be the initial gain, and the second tick must be the decrease gain value. gain values are as described in the Macros section below.
- **Gain**: value of gain.



Expand Down
2 changes: 2 additions & 0 deletions doc/5-wave/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ these are useful editing tools to fine-tune the waveform:
- **Amplify**. changes the volume of the waveform. it will clip at the top and bottom.
- **Normalize**: stretches waveform to maximum within the wavetable height.
- **Invert**: flips waveform vertically.
- **Reverse**: flips waveform horizontally.
- **Half**: halves the waveform's frequency by stretching its first half to fill the waveform length.
- **Double**: doubles the waveform's frequency by squashing it to half length then repeating it.
- **Convert Signed/Unsigned**. worth trying if an imported wave sounds corrupted.
Expand All @@ -110,6 +111,7 @@ input waveforms should match the size of the wavetable or unexpected results may
- synthesizer type: selects the synthesis algorithm.
- waveform displays.
- **Wave 1**: selects input waveform.
- this will turn yellow to indicate that a Waveform macro is set; remove the macro to work with the synthesizer.
- **Wave 2**: selects second input waveform. only appears when a dual-waveform synthesizer is selected.
- **Pause preview**: toggles live waveform preview.
- **Restart preview**: restarts preview from initial state.
Expand Down
Binary file modified doc/5-wave/wave-editor-tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cfd5131

Please sign in to comment.