Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
m (Reorganise categories and pages)
 
(145 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 User Guides - Start Here==
The encoders/switches are used to navigate between the different screens/menus, select options and change the instrument parameters, acting as MIDI/OSC controllers.
 
  
Currently there are two screen patterns:
+
[[File:Zynthian-mixer-blackboard.jpeg|600px|right]]
  
- '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) encoder/switch
+
*'''[[Zynthian UI User's Guide - Oram]]''' (incomplete but frozen): Oram is the current stable version.
- '''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.
 
  
There are 3 types of clicks (press):
+
*'''[[Zynthian UI User's Guide - Vangelis]]''' (work in progress): Vangelis is the development version.
  
- '''short:''' less than 0.3 seconds
+
*'''[[Assistive Technology and accessibility - Vangelis]]''': A guide of Vangelis accessibility features.
- '''bold:''' between 0.3 and 2 seconds
 
- '''long:''' more than 2 seconds
 
  
The short click is used to rotate between channels (CHAN(1)) or between controller maps (SELECT(4)). For better understanding, see the next flowchart:
+
*'''[[Learning Pills - Vangelis]]''': Short tutorials, usually under 5 minute view / listen / read.
  
 +
*'''[[ZynSeq User Guide]]''': Zynthian's built-in step sequencer.
  
[[File:Visio-Diagrama flux v2.png]]
+
*'''[[ZynSampler User Guide]]''': Zynthian's built-in non-destructive audio sampler.
  
The screens are:
+
==Midi Controller Guides==
  
- ADMIN: Updating zynthian software, updating system, ...
+
*'''[[Supported plug & play MIDI controllers]]''': Zynthian has default mapping configs for Novation, Akai, Korg and other controllers...
- ENGINE: Synth engine selection
+
 
- CHAN: MIDI Channel selection
+
==Software Configuration Guides==
- BANK: Bank selection
+
 
- INSTRUMENT SELECT: Preset Selection
+
*'''[[Web Configuration User Guide]]''': Zynthian's built-in web interface, also known as '''''webconf'''''.
- INSTRUMENT CONTROL: Main Controller Screen
+
 
  - CONTROLLERS: Controller Map Selection
+
*[[Command Line User Guide]]: If you need to manually setup/configure things.
- LOAD/SAVE CONFIGURATION: Load or save configuration snapshots
+
 
 +
* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
 +
 
 +
==Engines/Plugin Specific Guides==
 +
 
 +
There are some guides on specific engines (plugins) available in Zynthian. They cover topics such as configuration, managing and importing presets etc. Some of them are listed below, for a full list see [[Engines|Zynthian Native Engines]]
 +
 
 +
*[[SooperLooper]] Flexible audio looper with functionality similar to the [https://loopers-delight.com/tools/echoplex/echoplex.html Echoplex Digital Pro]
 +
*[[MOD-UI User Guide]]: Pedalboard-style graphical interface for patching LV2 plugins
 +
*[[DrumGizmo]] Open source, multichannel, multilayered, drum plugin
 +
*[[GeonKick]] Free software for generating a wide range of percussive sounds
 +
*[[Perfomix]] Automated build-up audio effects with looper function.
 +
*[[Drum Kits as LV2 plugins]]
 +
 
 +
==Testing/Development Version Un-official Guides==
 +
* '''[[Vangelis Technology Preview Guide]]'''
 +
* [[Notes on Oram: some differences and new features]]
 +
 
 +
==Software & Hardware DIY Guides==
 +
 
 +
* [[Zynthian Hardware]]: Using custom hardware with Zynthian for DIY setups (audio, displays, rotary encoders etc.)
 +
 
 +
* [[Adding Encoders]]: 4 Encoders can be added to a Zynthian ...
 +
 
 +
* [[Adding Extra I/O with the Zynaptik Module]]: Adding the Zynaptik extra I/O Option
 +
 
 +
* [[Aligning Zynthian Touchscreens]]: Guidance for non-standard Zynthian screens. (Update: For reference, touchscreen calibration now available within the UI)
 +
 
 +
* [[Adding LV2 plugins]]: Adding LV2 plugins to the system.
 +
 
 +
* [[Understanding LINUX Audio]]: will help you understand the acronyms mentioned in this Wiki
 +
 
 +
==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)
 +
 
 +
==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="The best Open Source GrooveBox, by Floyd Steinberg" urlargs="start=553">https://www.youtube.com/watch?v=dtdIqBiWdjk</embedvideo>
 +
<embedvideo alignment="inline" dimensions="451" service="youtube" description="Create your first song, by Floyd Steinberg">https://www.youtube.com/watch?v=TWmrk6LlEyg</embedvideo>
 +
<br>
 +
<embedvideo alignment="inline" dimensions="451" service="youtube" description="SooperLooper, by Floyd Steinberg">https://www.youtube.com/watch?v=QPQT5gviZbo</embedvideo>
 +
<embedvideo alignment="inline" dimensions="451" service="youtube" description="How to Summon Entities with the Zynthian V5">https://www.youtube.com/watch?v=AP71cSRtdJc</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 09:50, 23 July 2026

1 Main User Guides - Start Here

Zynthian-mixer-blackboard.jpeg

2 Midi Controller Guides

3 Software Configuration Guides

4 Engines/Plugin Specific Guides

There are some guides on specific engines (plugins) available in Zynthian. They cover topics such as configuration, managing and importing presets etc. Some of them are listed below, for a full list see Zynthian Native Engines

5 Testing/Development Version Un-official Guides

6 Software & Hardware DIY 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)

7 Legacy Guides

8 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

9 Video Guides

9.1 English

The best Open Source GrooveBox, by Floyd Steinberg
Create your first song, by Floyd Steinberg


SooperLooper, by Floyd Steinberg
How to Summon Entities with the Zynthian V5


First Steps, by Sébastien Marty
MIDI Basics, by Sébastien Marty
Editing SFZ & SF2, by Benoit Bouchez


9.2 French

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