projectM Wiki
Welcome to the projectM documentation Wiki!
Here you'll find important resources about both using and developing for and with projectM.
The Wiki is organized into three main sections:
- For projectM users, anyone using the official projectM applications released on different platforms.
- For developers using/integrating projectM in their applications.
- For developers interested in supporting projectM's core development.
projectM user manuals
If you're looking for manuals and information on one of the "official" projectM applications maintained by this project, you can find documentation for those applications in their respective repository wikis:
- SDL-based standalone and Steam applications
- Qt-based standalone UI
- EyeTune (Windows Store)
- Apple Music.app plug-in
If you're unsure whether your application is actually affiliated with us, please check the applications list first. Only those listed as "provided by the projectM team" are covered here and can be supported by the maintainers. For all other applications, please refer to their respective project pages or contact their authors directly for support inquiries.
projectM still has some rendering and compatibility issues in comparison to the original Milkdrop. We have a guide listing all currently known differences and issues, so please read this before opening a new bug report.
Guides for presets and other user-provided content
If you're looking into authoring your own presets, editing existing ones or tampering with preset transitions in projectM, you'll find some information here:
Integrating projectM into applications
If you are a developer and want to use projectM in your own application or project, that's great! Below you will find all the required information to get started with the projectM API.
Before starting, also make sure you have read the LGPL license and understood which obligations you need to follow to legally use and distribute projectM with your application.
- Download and build projectM for application development
- Quickstart guide for integrating projectM into your application
- projectM API reference
- Build troubleshooting
- Licensing obligations
Contributing to projectM
projectM is developed as an open source application and thus anyone can contribute to it! Possible contributions are not limited to core C++ code though. You can help with documentation, adding new presets, testing reported bugs and many other things.
The pages below will help you get an overview of the projectM architecture, roadmap and guidelines.
- Getting started with projectM development - Read this first if you're new to projectM and/or OSS development in general.
- Architectural overview
- Coding and contribution guidelines