Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
m (Reorganise categories and pages)
 
(43 intermediate revisions by 6 users not shown)
Line 1: Line 1:
  
==Main Guides==
+
==Main User Guides - Start Here==
  
* '''[[Zynthian UI User Guide - V5]]''': The new V5 User Interface. '''V5 owners should start here!'''
+
[[File:Zynthian-mixer-blackboard.jpeg|600px|right]]
  
* '''[[Zynthian UI User Guide - V1/V4]]''': The classic V1-V4 User Interface. '''V1-V4 & custom zynthian owners should start here!'''
+
*'''[[Zynthian UI User's Guide - Oram]]''' (incomplete but frozen): Oram is the current stable version.
  
* '''[[ZynSeq User Guide]]''': Detailed user's guide for the ZynSeq step sequencer.
+
*'''[[Zynthian UI User's Guide - Vangelis]]''' (work in progress): Vangelis is the development version.
  
* '''[[Web Configuration User Guide]]''': Also known as '''''webconf''''', check here to learn about settings in Zynthian's configuration web interface.
+
*'''[[Assistive Technology and accessibility - Vangelis]]''': A guide of Vangelis accessibility features.
  
* '''[[Control Device Drivers]]''': Documentation for zynthian's Plug & Play MIDI controller drivers (Novation LaunchPads, Akai MIDI Mix, Akai APC Key25, etc.)
+
*'''[[Learning Pills - Vangelis]]''': Short tutorials, usually under 5 minute view / listen / read.
  
* [[MOD-UI User Guide]]: Pedalboard style graphical interface for patching LV2 plugins: MOD plugin-host web UI.
+
*'''[[ZynSeq User Guide]]''': Zynthian's built-in step sequencer.
  
* [[Command Line User Guide]]: If you need to manually setup/configure things.
+
*'''[[ZynSampler User Guide]]''': Zynthian's built-in non-destructive audio sampler.
  
* [[Zynthian UI User Guide (oldstable-2109)|Legacy Zynthian UI User Guide]] (old stable-2109)
+
==Midi Controller Guides==
  
==Specific Guides==
+
*'''[[Supported plug & play MIDI controllers]]''': Zynthian has default mapping configs for Novation, Akai, Korg and other controllers...
  
* [[Adding LV2 plugins]]: Adding LV2 plugins to the system.
+
==Software Configuration Guides==
 +
 
 +
*'''[[Web Configuration User Guide]]''': Zynthian's built-in web interface, also known as '''''webconf'''''.
 +
 
 +
*[[Command Line User Guide]]: If you need to manually setup/configure things.
  
 
* [[MIDI Network]]: Receive/Send MIDI with RTP-MIDI & QMidiNet
 
* [[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
 
* [[Adding Extra I/O with the Zynaptik Module]]: Adding the Zynaptik extra I/O Option
  
* [[Aligning Zynthian Touchscreens]]: Guidance on the alignment of non-standard zynthian screens.
+
* [[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
 
* [[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==
 
==Beginners==
  
* '''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage''
+
* '''[[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''
 
* '''[[Quick Start]]''': ''A beginners tutorial on how to make a piano snapshot''
Line 40: Line 75:
 
==Video Guides==
 
==Video Guides==
 
====English====
 
====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="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="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>
 
<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="First Steps, by Sébastien Marty">https://www.youtube.com/watch?v=avUdv1uxYT4</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