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: @@
-The Zynthian has 3 user interfaces:
+==Main Guides==
-. [[Configuration Users Guide]] (web browser UI)
+[[File:Zynthian-mixer-blackboard.jpeg|600px|right]]
-. [[MOD Users Guide]] (web browser UI)
+*'''[[Zynthian UI User Guide - V5]]''': The new V5 User Interface. V5 owners should start here.
-. The device UI (the hardware itself)
+*'''[[Zynthian UI User Guide - V1/V4]]''': Legacy & custom zynthian owners should start here.
-=Device User Interface=
+*'''[[ZynSeq User Guide]]''': Detailed user's guide for the ZynSeq step sequencer.
-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]]
+*'''[[Engines | Sound & MIDI Engines]]''': Info about the available engines (synths, audio FXs, MIDI processors, etc.)
-Currently there are two screen layouts:
+*'''[[Web Configuration User Guide]]''': Also known as '''''webconf'''''.
-# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+*'''[[Supported plug & play MIDI controllers]]''': Novation, Akai, Korg, ...
-# '''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:
+*[[MOD-UI User Guide]]: Pedalboard-style graphical interface for patching LV2 plugins.
-* '''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. For a detailed description, see the next flowcharts:
+*[[Command Line User Guide]]: If you need to manually setup/configure things.
-[[File:zynthian_ui_workflow_1.png]]
+*[[Zynthian UI User Guide (oldstable-2109)|Legacy Zynthian UI User Guide]] (old stable-2109)
-[[File:zynthian_ui_workflow_2.png]]
+==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]]
-''Need to describe how the UserInterface works with no rotary-encoders and only a touchscreen.''
+==Specific Guides==
-If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
+* [[Adding LV2 plugins]]: Adding LV2 plugins to the system.
- - [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
+* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
- - [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
+* [[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.
+==Beginners==
+* '''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|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''
+==Video Guides==
+====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>
+====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>
+<!--
+====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>
+-->