Difference between revisions of "Zynthian Users Guide"

Revision as of 23:23, 28 July 2024

1 Main Guides

Zynthian UI User Guide - V5: The new V5 User Interface. V5 owners should start here.

Zynthian UI User Guide - V1/V4: Legacy & custom zynthian owners should start here.

ZynSeq User Guide: Detailed user's guide for the ZynSeq step sequencer.

Sound & MIDI Engines: Info about the available engines (synths, audio FXs, MIDI processors, etc.)

Web Configuration User Guide: Also known as webconf.

Supported plug & play MIDI controllers: Novation, Akai, Korg, ...

MOD-UI User Guide: Pedalboard-style graphical interface for patching LV2 plugins.

Command Line User Guide: If you need to manually setup/configure things.

Legacy Zynthian UI User Guide (old stable-2109)

2 Testing Version Guides

Zynthian UI User's Guide - Oram (work in progress): Oram is the current testing image, based Debian Bookworm 64-bits
Notes on Oram: some differences and new features

3 Specific Guides

Adding LV2 plugins: Adding LV2 plugins to the system.

MIDI Network: Receive/Send MIDI with RTP-MIDI & QMidiNet

Adding Extra I/O with the Zynaptik Module: Adding the Zynaptik extra I/O Option

Aligning Zynthian Touchscreens: Guidance on the alignment of non-standard zynthian screens.

Understanding LINUX Audio: will help you understand the acronyms mentioned in this Wiki

Zynthian Hardware: information about using custom hardware with Zynthian for DIY setups.

4 Beginners

First Steps: A brief tutorial on basic UI usage

Quick Start: A beginners tutorial on how to make a piano snapshot

Making some sounds: A beginners tutorial on how to make your Zynthian make some sounds

5 Video Guides

5.1 English

Zynthian Demo, by Floyd Steinberg

SooperLooper, by Floyd Steinberg

First Steps, by Sébastien Marty

MIDI Basics, by Sébastien Marty

Editing SFZ & SF2, by Benoit Bouchez

5.2 French

V5: Interface utilisateur, by Benoit Bouchez

V3: Interface utilisateur, by Benoit Bouchez

Edition SFZ et SF2, by Benoit Bouchez

@@ Line 1: / Line 1: @@
-Here's a list of the things Zynthian can do: [[Zynthian Features]]
+==Main Guides==
-The Zynthian has 4 user interfaces:
+[[File:Zynthian-mixer-blackboard.jpeg|600px|right]]
-. [[Command Line User Guide]] If you need to manually setup/configure.
+*'''[[Zynthian UI User Guide - V5]]''': The new V5 User Interface. V5 owners should start here.
-. [[Configuration Users Guide]] (web browser configuration tool)
+*'''[[Zynthian UI User Guide - V1/V4]]''': Legacy & custom zynthian owners should start here.
-. [[MOD Users Guide]] (web browser UI for LV2 plugin host)
+*'''[[ZynSeq User Guide]]''': Detailed user's guide for the ZynSeq step sequencer.
-. The device UI (the hardware itself)
+*'''[[Engines | Sound & MIDI Engines]]''': Info about the available engines (synths, audio FXs, MIDI processors, etc.)
-=Device User Interface=
+*'''[[Web Configuration User Guide]]''': Also known as '''''webconf'''''.
-The Zynthian device User Interface is displayed on a TFT display and controlled by 4 rotary-encoders with push switches.
-The encoders/switch knobs are used to navigate between the different screens/menus, select options and change the instrument parameters, acting as MIDI/OSC controllers.
-[[File:zynthian_ui_legend.png]]
+*'''[[Supported plug & play MIDI controllers]]''': Novation, Akai, Korg, ...
-Currently there are two screen layouts:
+*[[MOD-UI User Guide]]: Pedalboard-style graphical interface for patching LV2 plugins.
-# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+*[[Command Line User Guide]]: If you need to manually setup/configure things.
-# '''Controller Screen''': In the corners, 4 control widgets (one for each knob), with label and value indicator (graphic and numeric). In the middle, a list of controller maps which you can use to change or rotate using the SELECT(4) knob.
-And there are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob:
+*[[Zynthian UI User Guide (oldstable-2109)|Legacy Zynthian UI User Guide]] (old stable-2109)
-* '''short:''' less than 0.3 seconds
-* '''bold:''' between 0.3 and 2 seconds
-* '''long:''' more than 2 seconds
-Actions for each knob and click type are context dependent. Generally, the SELECT knob and a short click is used to navigate and select items on a "Selector Screen". On a "Controller Screen", short clicks can be used to rotate between channels (CH) or between controller maps (SELECT). "Bold" clicks are intended as shortcuts for jumping to some specific screens. Clicking the BACK knob generally jumps to the previous screen in the sequence.
+==Testing Version Guides==
+* [[Zynthian UI User's Guide - Oram]] (work in progress): Oram is the current testing image, based Debian Bookworm 64-bits
+* [[Notes on Oram: some differences and new features]]
-Loading and Saving: You have to push the LS (Load/Save) knob (3). If you click once, you get the Load menu, another click and you are in the Save menu. Normal click opens the engine's LS menu, that lists the current engine's snapshots, but if you bold-click LS when an engine is active, then you get the global LS menu, that lists the snapshots for all the engines.
+==Specific Guides==
-For a detailed description, see the next flowcharts:
+* [[Adding LV2 plugins]]: Adding LV2 plugins to the system.
-[[File:zynthian_ui_workflow_1.png]]
+* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
-[[File:zynthian_ui_workflow_2.png]]
+* [[Adding Extra I/O with the Zynaptik Module]]: Adding the Zynaptik extra I/O Option
-=Admin menu=
+* [[Aligning Zynthian Touchscreens]]: Guidance on the alignment of non-standard zynthian screens.
-Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu.
-[[File:UI-1.JPG|400px]]
+* [[Understanding LINUX Audio]]: will help you understand the acronyms mentioned in this Wiki
-=Layer List=
-This is the first screen you see when you power on.
-Choose New Layer to get started. A layer is a stored configuration of one synth engine and all its parameters.
-[[File:UI-LayerMenu.JPG|400px]]
+* [[Zynthian Hardware]]: information about using custom hardware with Zynthian for DIY setups.
-=Engine List=
+==Beginners==
-Once you have chosen/created a Layer, you see the list of synth engines to choose from.
-[[File:UI-EngineMenu.JPG|400px]]
+* '''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage''
-=MIDI Channel selection=
+* '''[[Quick Start]]''': ''A beginners tutorial on how to make a piano snapshot''
-This screen appears after you have chosen a synth engine. Choose the MIDI channel the synth will respond to.
-[[File:UI-2.JPG|400px]
+* '''[[Making some sounds]]''': ''A beginners tutorial on how to make your Zynthian make some sounds''
-= Bank selection=
+==Video Guides==
-Presets (instruments or sound designs or patches) for a synth engine are grouped/organized into banks. Choose a bank to see the list of presets you can pick from in that bank.
+====English====
+<embedvideo alignment="inline" dimensions="451" service="youtube" description="Zynthian Demo, by Floyd Steinberg" urlargs="start=553">https://www.youtube.com/watch?v=dtdIqBiWdjk</embedvideo>
+<embedvideo alignment="inline" dimensions="451" service="youtube" description="SooperLooper, by Floyd Steinberg">https://www.youtube.com/watch?v=QPQT5gviZbo</embedvideo>
+<br>
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="First Steps, by Sébastien Marty">https://www.youtube.com/watch?v=avUdv1uxYT4</embedvideo>
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="MIDI Basics, by Sébastien Marty">https://www.youtube.com/watch?v=U58qZze5hTA</embedvideo>
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Editing SFZ & SF2, by Benoit Bouchez">https://youtube.com/watch?v=FXFTnPrz4Pw</embedvideo>
+<br>
-[[File:UI-3.JPG|400px]
+====French====
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="V5: Interface utilisateur, by Benoit Bouchez">https://www.youtube.com/watch?v=w25bdRBB9og</embedvideo>
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="V3: Interface utilisateur, by Benoit Bouchez">https://www.youtube.com/watch?v=4jb-8cQQQgQ</embedvideo>
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Edition SFZ et SF2, by Benoit Bouchez">https://www.youtube.com/watch?v=odfyOLWh93k</embedvideo>
-=Preset selection=
+<!--
-This screen appears after you have chosen a bank. Choose the Preset to select the instrument/sound you want.
+====German====
+<embedvideo alignment="inline" dimensions="906" service="youtube" description="V5: Tutorial zum Einstieg, by Martin Gerken">https://www.youtube.com/watch?v=8iIv0w_2PsA</embedvideo>
-[[File:UI-4.JPG|400px]
+-->
-=Preset selection=
-This screen appears after you have chosen a synth engine. Choose the MIDI channel the synth will resond to.
-[[File:UI-5.JPG|400px]
-=Controller screen=
-This screen appears after you have chosen a Preset. Turning the 4 knobs now change the values of the synth parameters shown in the squares at the corners of the screen. The Controller list in the center of the screen allows you to choose sets of parameters to view and alter.
-[[File:UI-6.JPG|400px]
-= UI with only a touch screen and no encoders=
-You can navigate and control the Zynthian UI without encoders/switches at all, only touchscreen.
-You can "emulate" the switches by tapping the controller widgets (squares in the 4 corners of a Controller screen). There are short, bold and long actions. Exactly the same workflow as with hardware knobs. When the "back" widget is not available, you can go back by tapping the top bar.
-You can change the values of the controllers by "sliding" over the widgets. This is the same as turning the knob.
-When clicking (tapping/touching) the topbar, a "back" event is triggered. It's a quick & dirty fix and probably it will change in the future, but meanwhile it will enable you to fully control Zynthian using the touchscreen if you don't have knob hardware. [[File:Topbar.png]]
-=Help improve this documentation=
-If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
- - [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
- - [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]