Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
 
(128 intermediate revisions by 7 users not shown)
Line 1: Line 1:
  
The Zynthian User Interface is formed by 4 rotary encoders with switch and one TFT display.
+
==Main Guides==
The encoders/switches 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]]
+
[[File:Zynthian-mixer-blackboard.jpeg|600px|right]]
  
Currently there are two screen patterns:
+
*'''[[Zynthian UI User's Guide - Oram]]''' (work in progress): Oram is the current stable version.
  
- '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) encoder/switch
+
*'''[[ZynSeq User Guide]]''': Zynthian's built-in step sequencer.
- '''Controller Screen''': In the corners, 4 control widgets (one for each encoder/switch), with label and value indicator (graphic and numeric). In the middle, a list of controller maps to which you can change or rotate using the SELECT(4) encoder/switch.
 
  
And there are 3 types of clicks (push) action that can be realized on every switch:
+
*'''[[ZynSampler User Guide]]''': Zynthian's built-in non-destructive audio sampler.
  
- '''short:''' less than 0.3 seconds
+
*'''[[Engines | Sound & MIDI Engines]]''': Info about the available engines (synths, audio FXs, MIDI processors, etc.)
- '''bold:''' between 0.3 and 2 seconds
 
- '''long:''' more than 2 seconds
 
  
Actions bond to every different switch and click type are context dependent. Generally, SELECT rotary and short click is used to navigate and select items in a "Selector Screen". From "Controller Screen", short click 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 BACK generally jumps to the previous screen in the sequence. For a detailed description, see the next flowcharts:
+
*'''[[Web Configuration User Guide]]''': Zynthian's built-in web interface, also known as '''''webconf'''''.
  
 +
*'''[[Supported plug & play MIDI controllers]]''': Zynthian has default mapping configs for Novation, Akai, Korg and other controllers...
  
[[File:zynthian_ui_workflow_1.png]]
+
*'''[[Adding Encoders]]''': 4 Encoders can be added to a Zynthian ...
  
[[File:zynthian_ui_workflow_2.png]]
+
*[[MOD-UI User Guide]]: Pedalboard-style graphical interface for patching LV2 plugins.
  
If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
+
*[[Command Line User Guide]]: If you need to manually setup/configure things.
  
  - [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
+
==Un-official Guides==
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
+
* [[Notes on Oram: some differences and new features]]
 +
 
 +
==Legacy Guides==
 +
 
 +
*[[Zynthian UI User Guide - V5|Legacy Zynthian UI - V5 User Guide]] (old stable-2401)
 +
 
 +
*[[Zynthian UI User Guide - V1/V4|Legacy Zynthian UI - V1/V4 User Guide]] (old stable-2401)
 +
   
 +
*[[Zynthian UI User Guide (oldstable-2109)|Legacy Zynthian UI User Guide]] (old stable-2109)
 +
 
 +
==Advanced Guides==
 +
 
 +
* [[Zynthian Hardware]]: Using custom hardware with Zynthian for DIY setups (audio, displays, rotary encoders etc.)
 +
 
 +
* [[Adding Extra I/O with the Zynaptik Module]]: Adding the Zynaptik extra I/O Option
 +
 
 +
* [[Adding LV2 plugins]]: Adding LV2 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 for non-standard Zynthian screens. (Update: For reference, touchscreen calibration now available within the UI)
 +
 
 +
==Beginners==
 +
 
 +
* '''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage for Version 3''
 +
 
 +
* '''[[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>
 +
-->

Latest revision as of 13:40, 16 February 2025

1 Main Guides

Zynthian-mixer-blackboard.jpeg

2 Un-official Guides

3 Legacy Guides

4 Advanced Guides

  • Zynthian Hardware: Using custom hardware with Zynthian for DIY setups (audio, displays, rotary encoders etc.)
  • Aligning Zynthian Touchscreens: Guidance for non-standard Zynthian screens. (Update: For reference, touchscreen calibration now available within the UI)

5 Beginners

  • First Steps: A brief tutorial on basic UI usage for Version 3
  • Quick Start: A beginners tutorial on how to make a piano snapshot

6 Video Guides

6.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


6.2 French

V5: Interface utilisateur, by Benoit Bouchez
V3: Interface utilisateur, by Benoit Bouchez
Edition SFZ et SF2, by Benoit Bouchez