Difference between revisions of "Zynthian Users Guide"

Revision as of 19:16, 2 February 2021

1 Official UI Guides

Zynthian has 4 user interfaces that we have documented separately:

1. Zynthian UI Users Guide: The Hardware UI. <= You should start here!

2. Configuration Users Guide: Web Configuration Tool.

3. MOD-UI Users Guide: MOD Plugin-Host Web UI.

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

2 Specific Guides

Installing LV2 Engines: Adding LV2 engines to the system.

Adding LV2 plugins: Adding LV2 fx plugins to the system.

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

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

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

Using ZynSeq: Tutorial on using ZynSeq step sequencer.

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

3 Beginners

First Steps: A brief tutorial on basic UI usage

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

4 Video Guides

4.1 English

First Steps, by Sébastien Marty

MIDI Basics, by Sébastien Marty

Editing SFZ & SF2, by Benoit Bouchez

4.2 French

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]]
+==Official UI Guides==
-The Zynthian has 4 user interfaces:
+Zynthian has 4 user interfaces that we have documented separately:
-. [[Command Line User Guide]] If you need to manually setup/configure.
+. '''[[Zynthian UI Users Guide]]''': The Hardware UI. '''<= You should start here!'''
-. [[Configuration Users Guide]] (web browser configuration tool)
+. [[Configuration Users Guide]]: Web Configuration Tool.
-. [[MOD Users Guide]] (web browser UI for LV2 plugin host)
+. [[MOD Users Guide|MOD-UI Users Guide]]: MOD Plugin-Host Web UI.
-. The device UI (the hardware itself)
+. [[Command Line User Guide]]: If you need to manually setup/configure things.
-=Device User Interface=
+==Specific Guides==
-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]]
+* [[Installing LV2 Engines]]: Adding LV2 engines to the system.
-Currently there are two screen layouts:
+* [[Adding LV2 plugins]]: Adding LV2 fx plugins to the system.
-# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
-# '''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:
+* [[Understanding LINUX Audio]]: will help you understand the acronyms mentioned in this Wiki
-* '''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:
+* [[Aligning Zynthian Touchscreens]]: Guidance on the alignment of non-standard zynthian screens.
-[[File:zynthian_ui_workflow_1.png]]
+* [[Using ZynSeq]]: Tutorial on using ZynSeq step sequencer.
-[[File:zynthian_ui_workflow_2.png]]
+* [[Adding Extra I/O with the Zynaptik Module]]: Adding the Zynaptik extra I/O Option
-= UI with only a touch screen and no encoders=
+==Beginners==
-''Need to describe how the UserInterface works with no rotary-encoders and only a touchscreen.''
+'''[[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''
+==Video Guides==
-Now you can navigate and control the Zynthian UI without encoders/switches at all. Only touchscreen.
+====English====
+<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>
-You can "emulate" the switches by pushing in the controller widgets. There are short, bold and long actions. Exactly the same workflow than ever. When the "back" widget is not available, you can go back by clicking the top bar.
+====French====
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Interface utilisateur, by Benoit Bouchez">https://www.youtube.com/watch?v=4jb-8cQQQgQ</embedvideo>
-Also, as i explained in another post, you can move the controllers by "sliding" over the widgets.
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Edition SFZ et SF2, by Benoit Bouchez">https://www.youtube.com/watch?v=odfyOLWh93k</embedvideo>
-When clicking (touching) the topbar, a "back" event is triggered. It's quick&dirty fix and probably it will change in the future, but meanwhile it will allow to have a basic functionality using the touchscreen without controllers. [[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]