Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
m
Tags: Mobile web edit Mobile edit
 
(108 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. [[Command Line User Guide]] If you need to manually setup/configure.
+
*'''[[Zynthian UI User's Guide - Oram]]''' (work in progress): Oram is the current stable version.
  
−
2. [[Configuration Users Guide]] (web browser configuration tool)
+
*'''[[ZynSeq User Guide]]''': Zynthian's built-in step sequencer.
  
−
2. [[MOD Users Guide]] (web browser UI for LV2 plugin host)
+
*'''[[ZynSampler User Guide]]''': Zynthian's built-in non-destructive audio sampler.
  
−
4. The device UI (the hardware itself)
+
*'''[[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.
+
==Engines/Plugin Specific 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.
+
There are some guides on specific engines 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]]
  
−
For a detailed description, see the next flowcharts:
+
*[[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]]
  
−
[[File:zynthian_ui_workflow_1.png]]
+
==Un-official Guides==
 +
* [[Notes on Oram: some differences and new features]]
  
−
[[File:zynthian_ui_workflow_2.png]]
+
==Legacy Guides==
  
−
=Admin menu=
+
*[[Zynthian UI User Guide - V5|Legacy Zynthian UI - V5 User Guide]] (old stable-2401)
−
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]]
+
*[[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)
  
−
=Layer List=
+
==Advanced Guides==
−
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]]
+
* [[Zynthian Hardware]]: Using custom hardware with Zynthian for DIY setups (audio, displays, rotary encoders etc.)
  
−
=Engine List=
+
* [[Adding Extra I/O with the Zynaptik Module]]: Adding the Zynaptik extra I/O Option
−
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]]
+
* [[Adding LV2 plugins]]: Adding LV2 plugins to the system.
  
−
=MIDI Channel selection=
+
* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
−
This screen appears after you have chosen a synth engine. Choose the MIDI channel the synth will respond to.
 
  
−
[[File:UI-2.JPG|400px]]
+
* [[Understanding LINUX Audio]]: will help you understand the acronyms mentioned in this Wiki
  
−
= Bank selection=
+
* [[Aligning Zynthian Touchscreens]]: Guidance for non-standard Zynthian screens. (Update: For reference, touchscreen calibration now available within the UI)
−
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]]
+
==Beginners==
  
−
Here we choose the Organ bank.
+
* '''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage for Version 3''
  
−
[[File:UI-4.JPG|400px]]  
+
* '''[[Quick Start]]''': ''A beginners tutorial on how to make a piano snapshot''
  
−
=Preset selection=
+
* '''[[Making some sounds]]''': ''A beginners tutorial on how to make your Zynthian make some sounds''
−
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]]
+
==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>
  
−
=Controller screen=
+
====French====
−
This screen appears after you have chosen a Preset. Your instrument is now playable.  
+
<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>
  
−
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.
+
<!--
−
 
+
====German====
−
Press the Back knob to return to previous screens.
+
<embedvideo alignment="inline" dimensions="906" service="youtube" description="V5: Tutorial zum Einstieg, by Martin Gerken">https://www.youtube.com/watch?v=8iIv0w_2PsA</embedvideo>
−
 
+
-->
−
[[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]
 

Latest revision as of 08:39, 9 July 2025

1 Main Guides

Zynthian-mixer-blackboard.jpeg

2 Engines/Plugin Specific Guides

There are some guides on specific engines 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

3 Un-official Guides

4 Legacy Guides

5 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)

6 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

7 Video Guides

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


7.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=15583"