Zynthian Development

1 Developer Info (A sort of a Bestiary)

1.1 Contributing guidelines and basics

• Contributing to Zynthian Development
• Reporting and Tracking: Probably outdated, you can report issues here.
• Coding Guidlines: Guidance on coding styles, naming conventions, file location, etc.

1.2 Setup your developing workbench

• 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.
• Setup Development/Emulation Environment: Learn how to emulate the Zynthian UI on a linux desktop.
• Discussion on using various Python IDEs for Zynthian development https://discourse.zynthian.org/t/setting-up-dev-testing-environment-mac/2041/22

1.3 How does the Zynthian system work

• 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': Learn on which services the Zynthian UI relies on.
• Zynthian SystemD Startup: Learn how Zynthian interacts with the systemd service

1.4 Zynthian codebase and how to work with it

• Zynthian Webconf debug with Visual Studio Code

1.5 Supported external devices

• Supported_MIDI_controllers
• Writing a Ctrldev component to process zynthian data with python

1.6 Customizing and coding plugins for Zynthian

• Creating a new Zynthian LV2 plugin
• How to create modgui images for MOD-UI

2 Testing Documentation

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

• Zynthian UI Users Guide
• Text To Speech Interface guide