Difference between revisions of "Zynthian Users Guide"

Revision as of 15:36, 3 July 2020

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

Adding LV2 plugins: Adding LV2 engines 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.

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: @@
-The Zynthian has 3 user interfaces:
+==Official UI Guides==
-. [[Configuration]] (web browser UI)
-. MOD-UI (web browser UI)
-. The device UI (the hardware itself)
-=Device User Interface=
+Zynthian has 4 user interfaces that we have documented separately:
-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]]
+. '''[[Zynthian UI Users Guide]]''': The Hardware UI. '''<= You should start here!'''
-Currently there are two screen layouts:
+. [[Configuration Users Guide]]: Web Configuration Tool.
-# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+. [[MOD Users Guide|MOD-UI Users Guide]]: MOD Plugin-Host Web UI.
-# '''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:
+. [[Command Line User Guide]]: If you need to manually setup/configure things.
-* '''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:
+==Specific Guides==
-[[File:zynthian_ui_workflow_1.png]]
+* [[Adding LV2 plugins]]: Adding LV2 engines to the system.
-[[File:zynthian_ui_workflow_2.png]]
+* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
-''Need to describe how the UserInterface works with no rotary-encoders and only a touchscreen.''
+* [[Understanding LINUX Audio]]: will help you understand the acronyms mentioned in this Wiki
-If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
+* [[Aligning Zynthian Touchscreens]]: Guidance on the alignment of non-standard zynthian screens.
- - [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
+==Beginners==
- - [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
+'''[[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==
+====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>
+====French====
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="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>