Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
(added command line)
 
(117 intermediate revisions by 7 users not shown)
Line 1: Line 1:
  
−
Here's a list of the things Zynthian can do: [[Zynthian Features]]
+
==Main Guides==
  
−
The Zynthian has 4 user interfaces:
+
[[File:Zynthian-mixer-blackboard.jpeg|600px|right]]
  
−
1. [[Configuration Users Guide]] (web browser UI)
+
*'''[[Zynthian UI User's Guide - Oram]]''' (work in progress): Oram is the current stable version.
  
−
2. [[MOD Users Guide]] (web browser UI)
+
*'''[[ZynSeq User Guide]]''': Zynthian's built-in step sequencer.
  
−
3. The device UI (the hardware itself)
+
*'''[[ZynSampler User Guide]]''': Zynthian's built-in non-destructive audio sampler.
  
−
4. [[Command Line User Guide]]
+
*'''[[Engines | Sound & MIDI Engines]]''': Info about the available engines (synths, audio FXs, MIDI processors, etc.)
  
−
=Device User Interface=
+
*'''[[Web Configuration User Guide]]''': Zynthian's built-in web interface, also known as '''''webconf'''''.
−
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]]
+
*'''[[Supported plug & play MIDI controllers]]''': Zynthian has default mapping configs for Novation, Akai, Korg and other controllers...
  
−
Currently there are two screen layouts:
+
*'''[[Adding Encoders]]''': 4 Encoders can be added to a Zynthian ...
  
−
# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+
*[[MOD-UI User Guide]]: Pedalboard-style graphical interface for patching LV2 plugins.
−
# '''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:
+
==Un-official Guides==
 +
* [[Notes on Oram: some differences and new features]]
  
−
[[File:zynthian_ui_workflow_1.png]]
+
==Legacy Guides==
  
−
[[File:zynthian_ui_workflow_2.png]]
+
*[[Zynthian UI User Guide - V5|Legacy Zynthian UI - V5 User Guide]] (old stable-2401)
  
−
= UI with only a touch screen and no encoders=
+
*[[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)
  
−
''Need to describe how the UserInterface works with no rotary-encoders and only a touchscreen.''
+
==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
  
−
Now you can navigate and control the Zynthian UI without encoders/switches at all. Only touchscreen.
+
* [[Adding LV2 plugins]]: Adding LV2 plugins to the system.
  
−
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.
+
* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
  
−
Also, as i explained in another post, you can move the controllers by "sliding" over the widgets.
+
* [[Understanding LINUX Audio]]: will help you understand the acronyms mentioned in this Wiki
  
−
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]]
+
* [[Aligning Zynthian Touchscreens]]: Guidance for non-standard Zynthian screens. (Update: For reference, touchscreen calibration now available within the UI)
  
−
=Help improve this documentation=
+
==Beginners==
−
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]
+
* '''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage for Version 3''
−
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
+
 
 +
* '''[[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


Retrieved from "http://wiki.zynthian.org/index.php?title=Zynthian_Users_Guide&oldid=14997"