Difference between revisions of "Zynthian Users Guide"

Revision as of 10:54, 25 September 2019

1 Official User 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 UI.

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

Understanding LINUX Audio Help in understanding all those acronyms mentioned in this Wiki

2 Beginners

First Steps: A brief tutorial on basic UI usage

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

3 Video Guides

3.1 English

First Steps, by Sébastien Marty

MIDI Basics, by Sébastien Marty

3.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 User Guides==
-. [[Configuration Users Guide]] (web browser UI)
+Zynthian has 4 user interfaces that we have documented separately:
-. [[MOD Users Guide]] (web browser UI)
+. '''[[Zynthian UI Users Guide]]''': The Hardware UI. '''<= You should start here!'''
-. The device UI (the hardware itself)
+. [[Configuration Users Guide]]: Web Configuration Tool.
-=Device User Interface=
+. [[MOD Users Guide|MOD-UI Users Guide]]: MOD Plugin-Host UI.
-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]]
+. [[Command Line User Guide]]: If you need to manually setup/configure things.
-Currently there are two screen layouts:
-# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+[[Understanding LINUX Audio]] Help in understanding all those acronyms mentioned in this Wiki
-# '''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:
+==Beginners==
-* '''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:
+'''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage''
-[[File:zynthian_ui_workflow_1.png]]
+'''[[Quick Start]]''': ''A beginners tutorial on how to make a piano snapshot''
-[[File:zynthian_ui_workflow_2.png]]
+==Video Guides==
-''Need to describe how the UserInterface works with no rotary-encoders and only a 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>
-If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
+====French====
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Interface utilisateur, by Benoit Bouchez">https://www.youtube.com/watch?v=4jb-8cQQQgQ</embedvideo>
- - [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Edition SFZ et SF2, by Benoit Bouchez">https://www.youtube.com/watch?v=odfyOLWh93k</embedvideo>
- - [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]