Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

manual-xt ch04 style, ch03 tweaks #354

Merged
merged 12 commits into from
Mar 21, 2024
15 changes: 10 additions & 5 deletions src/content/manual_xt/01-getting_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ order: 1

![](/images/manual-xt/Pictures/surge.png)

# Getting Started
# Getting started

If you're using Surge 1.9, see the [Manual for Surge 1.9](/manual).
If you're using Surge 1.9, use the [Manual for Surge 1.9](/manual).

Surge XT is a virtual synthesizer originally released as "Surge" as open source by creator Claes Johanson in September 2018. Since then, it's maintained by the Surge Synth Team, a group of volunteers.

Expand All @@ -18,8 +18,13 @@ This manual has main sections:
- [Accessibility](#accessibility)
- [Technical Reference](#technical-reference), with specifications and details of the synthesis engine.

Most of the images and descriptions use the default **Classic** skin, and this manual uses macOS conventions (**Title Case**) for labels in the UI.

For tutorials, tips, and more content, see the [Surge wiki](https://github.com/surge-synthesizer/surge-synthesizer.github.io/wiki).

To ask questions, report bugs or issues, or help develop Surge XT, visit the [Surge Synth Team Discord server](https://discord.com/invite/spGANHw).
To ask questions, report bugs or issues, or help develop Surge XT, visit the [Surge Synth Team Discord server](https://discord.com/invite/spGANHw).

Most of the images and descriptions use the default **Classic** skin, and this manual uses macOS conventions (**Title Case**) for labels in the UI, and Windows keyboard labels.

Trademarks:

- Audio Units, AU is a trademark of Apple Computer, Inc
- VST is a trademark of Steinberg Media Technologies GmbH
28 changes: 14 additions & 14 deletions src/content/manual_xt/02_installing_or_building.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,7 @@ slug: installing-or-building
order: 2
---

# Installing or Building Surge XT

Trademarks:

- Audio Units, AU is a trademark of Apple Computer, Inc
- VST is a trademark of Steinberg Media Technologies GmbH
# Installing or building Surge XT

Download the Surge XT installer from [https://surge-synthesizer.github.io](https://surge-synthesizer.github.io).

Expand Down Expand Up @@ -71,27 +66,29 @@ It is also offered as a standalone application.

The system requirements can be hard to determine, as there are many Linux distributions, and other factors.

- The installation package on the **Surge XT website** is a Debian package.
- The distribution package is built on Ubuntu 18.04.
- A list of required packages is listed in the source and in the deb file.
The installation package on the **Surge XT website** is a Debian package.

The distribution package is built on Ubuntu 18.04.

A list of required packages is listed in the source and in the deb file.

**Note:** Some actions in Surge XT use Alt + Drag or the scroll wheel, which can conflict with the desktop
environment. To solve that issue, disable the global gesture in the desktop environment.


## Building from Source
## Building from source

To build Surge XT from source, see
[our Github repository](https://github.com/surge-synthesizer/surge).


## Installing Alongside Older Versions
## Installing alongside older versions

Surge and Surge XT are different plug-ins. This means that you can install Surge XT alongside Surge 1.9 or earlier.
Keep Surge 1.9 installed to open projects that use older versions of Surge.


## Standalone Version Options
## Standalone version options

If you are running Surge XT as a standalone executable, options at the top-left:
- configure MIDI and audio inputs and outputs
Expand All @@ -113,22 +110,25 @@ The Surge XT installer never changes files the user area, so save your files the
### Windows

The patch library and wavetables are at `C:ProgramData\Surge XT`.

The user patches are at `C:\Users\your username\My Documents\Surge XT`.

### macOS

The patch library and wavetables are at `/Library/Application Support/Surge XT`.

The user patches are at `~/Documents/Surge XT`.

### Linux

The patch library and wavetables are at `/usr/share/surge-xt` with a standard install.

The user patches are at `~/Documents/Surge XT`. Surge XT creates this directory when you store a patch
or change the user default settings for the first time.


## Playing Your First Note
## Playing your first note

Surge XT is best used with a [DAW](https://en.wikipedia.org/wiki/Digital_audio_workstation), or a physical device
like a keyboard. To get started, you can open the virtual keyboard from `Menu > Workflow > Virtual keyboard`,
like a keyboard. To get started, you can open the virtual keyboard from the main menu > **Workflow** > **Virtual Keyboard**,
or Alt + K. See [Workflow](#workflow).
30 changes: 15 additions & 15 deletions src/content/manual_xt/03-user-interface-basics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ slug: user-interface-basics
order: 3
---

# User Interface Basics
# User interface basics

Surge XT displays four main sections: header, scene controls, modulation and routing, and effects.

![Illustration 1: The four sections of the Surge XT display.](/images/manual-xt/Pictures/sections.png)

_The four sections of Surge XT._

## The Scene Concept
## <a name="the-scene-concept"></a>Scenes

Every patch in Surge XT contains two scenes (A & B) and an effects section.
A scene is similar to a traditional synthesizer patch that stores all the information used to synthesize a voice.
Expand All @@ -29,9 +29,9 @@ When loaded into a DAW, each instance of Surge XT has 3 audio outputs:
- Scene A Out
- Scene B Out

You can route and process those outputs separately if your host allows it.
If your host allows, you can route and process those outputs separately.

## Sliders and Controls
## Sliders and controls

Surge XT parameters display as number fields, value fields, buttons, button groups, or sliders.

Expand All @@ -56,23 +56,23 @@ Other slider actions:
### Undo and Redo

To undo or redo your latest changes, select the curved arrow buttons to the left of the **Save** button
below the [Patch Browser](#patch-browser). You can also use default keyboard shortcuts: Ctrl + Z to undo,
below the [Patch Browser](#patch-browser). You can also press Ctrl + Z to undo,
and Ctrl + Y to redo.

### Parameter Context Menu
### Parameter context menu

To display a parameter context menu, right-click.

![Illustration 3: Slider context menu](/images/manual-xt/Pictures/slider_context_menu.png)

#### Name and Contextual Help
#### Name and contextual help

For help with a parameter, select the **?** option, or hover the parameter and press F1.

#### Edit Value

Select **Edit Value** then enter a value. There is no need to enter the unit of the entered value.
Press Enter to commit the change. To exit without committing the change, press Escape or move another parameter.
Press Enter to commit the change. To exit without committing the change, press Escape or focus elsewhere.

![Illustration 4: Type-in window](/images/manual-xt/Pictures/typein_window.png)

Expand All @@ -82,11 +82,11 @@ For a discrete parameter, like **Unison Voices** or a button row, select a value

#### Extend Range

You can extend the range of some parameters, like **Pitch**. Select **Extend Range** from their context menu.
You can extend the range of some parameters, like **Pitch**. Select **Extend Range** from its context menu.

#### Tempo Sync

You can synchronize some parameters to the host tempo by toggling **Tempo Sync**. With **Tempo Sync** enabled,
You can synchronize some parameters to the host tempo. Toggle **Tempo Sync**. With **Tempo Sync** enabled,
a slider displays "TS".

![Illustration 6: Tempo sync slider](/images/manual-xt/Pictures/ts_slider.png)
Expand All @@ -96,7 +96,7 @@ a slider displays "TS".
#### Enabled

You can enable or disable some parameters. Toggle **Enabled** in its context menu. A disabled slider
displays faintly or has no handle.
displays dimmed or has no handle.

#### Modulations

Expand All @@ -106,16 +106,16 @@ See [Routing](#routing). For a modulation row:

- To clear a modulation routing, select the red **X** icon.
- To toggle bypassing a modulation routing, select the speaker icon.
- To edit the modulation amout, select the pencil icon and type a value. See [Edit Value](#edit-value).
- To edit the modulation amount, select the pencil icon and type a value. See [Edit Value](#edit-value).

#### Add Modulation From

To select a new modulation source, select **Add Modulation From**, then select a modulation source and
enter the modulation value.
enter a modulation value.

#### Assign To MIDI CC

To assign a parameter to a MIDI controller:
To assign the parameter a MIDI controller:

1. Select **Assign to MIDI CC** from the parameter context menu.
2. Select a MIDI controller code. You can select codes 0 to 127, but some codes are reserved for other uses.
Expand All @@ -139,7 +139,7 @@ The assigned or learned MIDI controller displays next to **Clear Learned MIDI**

To clear the assigned or learned MIDI controller, select **Clear Learned MIDI**.

#### VST3 Options
#### VST3 options

If you use the VST version of Surge XT, options from your host display at the end of the context menu.
These options might help with automation, MIDI, or parameter values.
Loading