Difference between revisions of "Zynthian Development"

From ZynthianWiki
Jump to navigation Jump to search
(Adds documentation staging links)
(Some comments.)
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
=Developer Info=
+
=Developer Info ( A sort of a Bestiary) =
* [[Zynthian_Reporting_and_Tracking|Reporting and Tracking]]
+
 
* [[Contributing to Zynthian Development|Contributing to Zynthian Development]]
+
==Contributing guidelines and basics==
* [[Creating a new Zynthian Synth Engine|Creating a new Zynthian Synth Engine]]
+
* [[Contributing to Zynthian Development 1|Contributing to Zynthian Development]]
* [[Zynthian MOD-GUI Guide|How to create modgui images for MOD-UI]]
+
* [[Zynthian_Reporting_and_Tracking|Reporting and Tracking]]: Probably outdated, you can report issues [https://github.com/zynthian/zynthian-issue-tracking here].
* [[Zynthian_Emulator Setup for Development|Setup Development/Emulation Environment]]
+
 
* [[Zynthian_PyCharm_Config|A PyCharm development Environment]]
+
==Setup your developing workbench==
* [[Zynthian GUI start up walkthrou'|Zynthian GUI start up walkthrou']]
+
* [[Integrated_Development_Environments_(IDE)| Integrated Development Environments (IDE) Visual Studio Code (VSC) ]]: Learn how to set up your IDE and how to work with the Zynthian code base with it.
* [[Zynthian Engine Preset Structure|Zynthian Engine Preset Structure]]
+
* [[Zynthian_Emulator Setup for Development|Setup Development/Emulation Environment]]: Learn how to emulate the Zynthian UI on a linux desktop.
* [[Zynthian SystemD Startup|Zynthian SystemD Startup]]
+
* Discussion on using various Python IDEs for Zynthian development https://discourse.zynthian.org/t/setting-up-dev-testing-environment-mac/2041/22
 +
 
 +
==How does the Zynthian system work==
 +
* [[Zynthian Engine Preset Structure|Zynthian Engine Preset Structure]]: Learn how Zynthian/jalv handles engine presets.
 +
* [[Zynthian file formats]]: Learn how Zynthian specific file formats (zss Snapshots/zs3 Sub Snapshots) work.
 +
* [[Zynthian GUI start up walkthrou'|Zynthian GUI start up walkthrou']]: Learn on which services the Zynthian UI relies on.
 +
* [[Zynthian SystemD Startup|Zynthian SystemD Startup]]: Learn how Zynthian interacts with the systemd service
 +
 
 +
==Zynthian codebase and how to work with it==
 
* [[Zynthian Webconf debug with Visual Studio Code (VSC) |Zynthian Webconf debug with Visual Studio Code]]
 
* [[Zynthian Webconf debug with Visual Studio Code (VSC) |Zynthian Webconf debug with Visual Studio Code]]
* Discussion on using various Python IDEs for Zynthian development https://discourse.zynthian.org/t/setting-up-dev-testing-environment-mac/2041/22
 
  
 +
==Supported external devices==
 +
* [[Supported MIDI controllers|Supported_MIDI_controllers]]
 +
* [[Ctrldev| Writing a Ctrldev component to process zynthian data with python]]
 +
 +
==Customizing and coding plugins for Zynthian==
 +
* [[LV2|Creating a new Zynthian LV2 plugin]]
 +
* [[Zynthian MOD-GUI Guide|How to create modgui images for MOD-UI]]
  
 
=Testing Documentation=
 
=Testing Documentation=

Latest revision as of 17:15, 5 September 2025

1 Developer Info ( A sort of a Bestiary)

1.1 Contributing guidelines and basics

1.2 Setup your developing workbench

1.3 How does the Zynthian system work

1.4 Zynthian codebase and how to work with it

1.5 Supported external devices

1.6 Customizing and coding plugins for Zynthian

2 Testing Documentation

These pages document the development version of Zynthian and are used to stage documentation before the next stable release.