mirror of
https://github.com/projectM-visualizer/projectm.git
synced 2026-02-10 18:45:56 +00:00
214 lines
9.4 KiB
Markdown
214 lines
9.4 KiB
Markdown
[](https://travis-ci.org/projectM-visualizer/projectm)
|
|
|
|
[Chat with us on Discord](https://discord.gg/mMrxAqaa3W)
|
|
|
|
|
|
|
|
## projectM - The most advanced open-source music visualizer
|
|
|
|
|
|
|
|
**Experience psychedelic and mesmerizing visuals by transforming music into equations that render into a limitless array
|
|
of user-contributed visualizations.**
|
|
|
|
projectM is an open-source project that reimplements the
|
|
esteemed [Winamp Milkdrop](https://en.wikipedia.org/wiki/MilkDrop) by Geiss in a more modern, cross-platform reusable
|
|
library.
|
|
|
|
Its purpose in life is to read an audio input and to produce mesmerizing visuals, detecting tempo, and rendering
|
|
advanced equations into a limitless array of user-contributed visualizations.
|
|
|
|
### Important: This repository only contains libprojectM for use in application development!
|
|
|
|
This repository now only contains the projectM shared/static library. All frontends, plug-ins and other tools were
|
|
outsourced into separate repositories. If you're not a developer and just look for a download to run projectM visuals on
|
|
your machine or device, please use one of the links listed below. The releases section in this repository only contains
|
|
source-code and binary releases of the projectM development libraries and headers, which aren't useful for end users.
|
|
|
|
### Available For
|
|
|
|
##### Windows
|
|
|
|
- [Standalone](https://github.com/projectM-visualizer/frontend-sdl2/releases) ([latest build](https://ci.appveyor.com/project/revmischa/projectm/build/artifacts))
|
|
(Requires the
|
|
latest [Visual C++ redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
|
|
to run)
|
|
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/)
|
|
- [Windows Store](https://www.microsoft.com/store/apps/9NDCVH0VCWJN)
|
|
|
|
#### macOS
|
|
|
|
- [Standalone](https://github.com/projectM-visualizer/frontend-sdl2/releases)
|
|
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/)
|
|
- [Music.app Plugin](https://github.com/projectM-visualizer/frontend-music-plug-in/releases)
|
|
- [Brew](https://formulae.brew.sh/formula/projectm)
|
|
|
|
#### Linux
|
|
|
|
- [Standalone](https://github.com/projectM-visualizer/frontend-sdl2/releases)
|
|
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/)
|
|
- Check your distribution's package manager for a binary release.
|
|
|
|
#### Android
|
|
|
|
- [Google Play](https://play.google.com/store/apps/details?id=com.psperl.prjM) (**Note**: This app is _not_ created or
|
|
supported by the projectM developers!)
|
|
|
|
#### Xbox / Windows Phone
|
|
|
|
- [Windows Store](https://www.microsoft.com/store/apps/9NDCVH0VCWJN)
|
|
|
|
#### Other
|
|
|
|
- [Library source code](https://github.com/projectM-visualizer/projectm/)
|
|
- [Qt5](https://www.qt.io/) based [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) and JACK desktop
|
|
apps [as source code for Linux](https://github.com/projectM-visualizer/frontend-qt)
|
|
- [ALSA, XMMS, Winamp, JACK](https://sourceforge.net/projects/projectm/files/) (source, unmaintained)
|
|
|
|
### Discord chat
|
|
|
|
[Chat with us on Discord.](https://discord.gg/mMrxAqaa3W)
|
|
|
|
### Demo Video
|
|
|
|
[](http://www.youtube.com/watch?v=2dSam8zwSFw "Demo")
|
|
|
|
### Presets
|
|
|
|
The preset files define the visualizations via pixel shaders and Milkdrop-style equations and parameters.
|
|
|
|
The projectM library does not ship with any presets. The frontends come with varying preset packs which can be found in
|
|
separate repositories in the projectM repository list:
|
|
|
|
- [Base Milkdrop texture pack](https://github.com/projectM-visualizer/presets-milkdrop-texture-pack)
|
|
-
|
|
|
|
Included with projectM are the bltc201, Milkdrop 1 and 2, projectM, tryptonaut and yin collections. You can grab these
|
|
presets [here](http://spiegelmc.com/pub/projectm_presets.zip).
|
|
|
|
You can also download an enormous 41,000 preset pack of
|
|
presets [here](https://mischa.lol/projectM/presets_community.zip) (123MB zipped).
|
|
|
|
### Also Featured In
|
|
|
|
[ Kodi (formerly XBMC)](https://kodi.tv/)
|
|
|
|
[ Helix](https://web.archive.org/web/20180628174410/http://ghostfiregames.com/helixhome.html)
|
|
|
|
[ Silverjuke (FOSS Jukebox)](https://www.silverjuke.net)
|
|
|
|
[<img src="https://silentradiance.com/demos/projectM_vr/projectm_vr.png" width="200" > Silent Radiance Distance Disco](https://silentradiance.com)
|
|
|
|
---
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
## Architecture
|
|
|
|
- [Article](https://lwn.net/Articles/750152/)
|
|
|
|
# Building from source
|
|
|
|
See [BUILDING.md](BUILDING.md) and
|
|
the [developer documentation in the wiki](https://github.com/projectM-visualizer/projectm/wiki/Building-libprojectM).
|
|
|
|
# Using the library
|
|
|
|
At its core projectM is a library, [libprojectM](src/libprojectM). This library is responsible for parsing presets,
|
|
analyzing audio PCM data with beat detection and FFT, applying the preset to the audio feature data and rendering the
|
|
resulting output with OpenGL. It can render to a dedicated OpenGL context or a texture.
|
|
|
|
To get started using projectM in your own projects, please go to the wiki and read
|
|
the [developer documentation](https://github.com/projectM-visualizer/projectm/wiki#integrating-projectm-into-applications)
|
|
available there.
|
|
|
|
There are some open-source applications that make use of libprojectM which can be found in
|
|
the [projectM organization's repositories](https://github.com/projectM-visualizer) and elsewhere.
|
|
|
|
---
|
|
|
|
# Todo
|
|
|
|
- Steal cool stuff from the recently-released Milkdrop source.
|
|
- Update the various implementations using libprojectM.
|
|
- Update downstream projects with new versions.
|
|
|
|
---
|
|
|
|
## Help
|
|
|
|
Report issues on GitHub in the respective repositories:
|
|
|
|
- [Rendering issues, crashes or the libprojectM core/API](https://github.com/projectM-visualizer/projectm/issues)
|
|
- [Standalone SDL app](https://github.com/projectM-visualizer/frontend-sdl2/issues) (including the Steam release)
|
|
- [Windows Store App](https://github.com/projectM-visualizer/frontend-uwp/issues)
|
|
- [Apple Music plug-in](https://github.com/projectM-visualizer/frontend-music-plug-in/issues)
|
|
- Issues regarding the **projectM Android apps in the Play Store**, please contact the app author via the Play Store. We
|
|
cannot help with any problems or requests.
|
|
|
|
If unsure, post your issue in the main [libprojectM repository](https://github.com/projectM-visualizer/projectm/issues).
|
|
Please always check any existing issues if your problem has already been posted by another user. If so, add your logs
|
|
and findings to the existing issue instead of opening a new one.
|
|
|
|
## Get in contact with us
|
|
|
|
[Chat with us on Discord.](https://discord.gg/mMrxAqaa3W)
|
|
|
|
## Contribute to projectM
|
|
|
|
If you would like to help improve this project, either with documentation, code, porting, hardware or anything else
|
|
please let us know! We gladly accept pull requests and issues.
|
|
|
|
Before starting to write code, please take your time to read
|
|
the [contribution guidelines](https://github.com/projectM-visualizer/projectm/wiki#contributing-to-projectm) in our
|
|
wiki.
|
|
|
|
## Maintainers
|
|
|
|
If you maintain packages of libprojectM, we are happy to work with you! Please note well:
|
|
|
|
- The main focus of this project is libprojectM. It's a library that only really depends on OpenGL. The other
|
|
applications are more like examples and demos.
|
|
- Many of the frontend applications are likely outdated and of less utility than the core library. If you desire to use
|
|
them or depend on them, please file an issue in the respective repository so we can help update them.
|
|
- The "canonical" application for actually viewing the visualizations is
|
|
now [projectM-SDL](https://github.com/projectM-visualizer/frontend-sdl2), based on libSDL2 because it supports audio
|
|
input and is completely cross-platform.
|
|
- This is an open source project! If you don't like something, feel free to contribute improvements!
|
|
- Yes, you are looking at the official version. This is not a fork.
|
|
|
|
## Authors
|
|
|
|
[Authors](https://github.com/projectM-visualizer/projectm/raw/master/AUTHORS.txt)
|
|
|
|
## License
|
|
|
|
projectM is released under
|
|
the [GNU Lesser General Public License 2.1](https://github.com/projectM-visualizer/projectm/raw/master/LICENSE.txt) to
|
|
keep any changes to the core library open-sourced, but also enable the use of libprojectM in closed-source
|
|
applications (as a shared library)
|
|
as long as the license terms are adhered to.
|
|
|
|
## Wiki
|
|
|
|
More information for developers is available from
|
|
the [projectM Wiki](https://github.com/projectM-visualizer/projectm/wiki).
|