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: @@
-Here's a list of the things Zynthian can do: [[Zynthian Features]]
+==Official User 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 configuration tool.
+. [[Configuration Users Guide]]: Web Configuration Tool.
-. [[MOD Users Guide]]: Web UI for LV2 plugin host)
+. [[MOD Users Guide|MOD-UI Users Guide]]: MOD Plugin-Host UI.
-. The Zynthian UI (the hardware itself)
+. [[Command Line User Guide]]: If you need to manually setup/configure things.
-=Zynthian User Interface=
-The Zynthian 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]]
+[[Understanding LINUX Audio]] Help in understanding all those acronyms mentioned in this Wiki
-Currently there are two screen layouts:
+==Beginners==
-# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+'''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage''
-# '''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:
+'''[[Quick Start]]''': ''A beginners tutorial on how to make a piano snapshot''
-* '''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.
+==Video Guides==
-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.
+====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>
-For a detailed description, see the next flowcharts:
+====French====
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Interface utilisateur, by Benoit Bouchez">https://www.youtube.com/watch?v=4jb-8cQQQgQ</embedvideo>
-[[File:zynthian_ui_workflow_1.png]]
+<embedvideo alignment="inline" dimensions="300" service="youtube" description="Edition SFZ et SF2, by Benoit Bouchez">https://www.youtube.com/watch?v=odfyOLWh93k</embedvideo>
-[[File:zynthian_ui_workflow_2.png]]
-=Admin menu=
-Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu. The last item is how you safely power off the Zynthian without corrupting data files.
-[[File:UI-1.JPG|400px]]
-=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]]
-=Engine List=
-Once you have chosen/created a Layer, you see the list of synth engines to choose from. The waveform image on the right is animated while software is loading.
-[[File:UI-EngineMenu.JPG|400px]]
-=MIDI Channel selection=
-This screen appears after you have chosen a synth engine. Choose the MIDI channel the synth will respond to.
-[[File:UI-2.JPG|400px]]
-= Bank selection=
-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.
-[[File:UI-3.JPG|400px]]
-Here we choose the Organ bank.
-[[File:UI-4.JPG|400px]]
-=Preset selection=
-This screen appears after you have chosen the Organ bank. Choose a Preset to select the instrument/sound you want.
-[[File:UI-5.JPG|400px]]
-=Controller screen=
-This screen appears after you have chosen a Preset. Your instrument is now playable.
-Turning each of the 4 knobs change the values of the synth parameters displayed in the squares at the sides of the screen. The Controller list in the center of the screen allows you to choose sets of parameters to view and alter.
-Press the Back knob to return to previous screens.
-[[File:UI-6.JPG|400px]]
-= UI with only a touch screen and no encoders=
-You can navigate and control the Zynthian UI without knobs/encoders/switches at all, using only the 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]