Skip to content

Commit 422af46

Browse files
committed
Updated several parts of the ReadMe and added a VLC screenshot.
Users reported broken/empty links for several frontends, added the proper pre-release links until the situation improves. Also replaced the no longer available "SilentRadiance" player with VLC.
1 parent 97880cb commit 422af46

File tree

2 files changed

+65
-37
lines changed

2 files changed

+65
-37
lines changed

README.md

+65-37
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
## projectM - The most advanced open-source music visualizer
88

9-
10-
119
**Experience psychedelic and mesmerizing visuals by transforming music into equations that render into a limitless array
1210
of user-contributed visualizations.**
1311

@@ -25,49 +23,68 @@ outsourced into separate repositories. If you're not a developer and just look f
2523
your machine or device, please use one of the links listed below. The releases section in this repository only contains
2624
source-code and binary releases of the projectM development libraries and headers, which aren't useful for end users.
2725

28-
### Available For
26+
### End-User Applications
27+
28+
**Important**: projectM is currently undergoing heavy development, so the available end-user frontends are either
29+
outdated or unavailable. We've released a few development previews, which are not feature-complete and may have bugs. As
30+
soon as we've finished the current modernization of libprojectM, we'll release new and tested versions of most of the
31+
frontends listed below, while we may remove or replace some of those which are no longer maintained by their original
32+
developers.
2933

3034
##### Windows
3135

32-
- [Standalone](https://github.com/projectM-visualizer/frontend-sdl2/releases) ([latest build](https://ci.appveyor.com/project/revmischa/projectm/build/artifacts))
33-
(Requires the
34-
latest [Visual C++ redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
35-
to run)
36-
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/)
37-
- [Windows Store](https://www.microsoft.com/store/apps/9NDCVH0VCWJN)
36+
- Standalone (currently only available as
37+
a [development preview](https://github.com/kblaschke/frontend-sdl2/releases/tag/2.0-windows-pre1))
38+
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/) (Same as standalone development
39+
preview)
40+
- [Windows Store](https://www.microsoft.com/store/apps/9NDCVH0VCWJN) (Old 3.1.12 release )
3841

3942
#### macOS
4043

41-
- [Standalone](https://github.com/projectM-visualizer/frontend-sdl2/releases)
42-
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/)
43-
- [Music.app Plugin](https://github.com/projectM-visualizer/frontend-music-plug-in/releases)
44-
- [Brew](https://formulae.brew.sh/formula/projectm)
44+
- Standalone (currently only available as
45+
a [development preview](https://github.com/kblaschke/frontend-sdl2/releases/tag/2.0-macos-pre1))
46+
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/) (Old 3.1.12 release)
47+
- Music.app Plugin (currently only available as an
48+
_unsigned_ [development preview](https://github.com/kblaschke/frontend-music-plug-in/releases/tag/v3.0-pre1))
49+
- [Brew](https://formulae.brew.sh/formula/projectm) (Old 3.1.12 release)
4550

4651
#### Linux
4752

48-
- [Standalone](https://github.com/projectM-visualizer/frontend-sdl2/releases)
49-
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/)
50-
- Check your distribution's package manager for a binary release.
53+
- Standalone (currently only available as
54+
a [development preview](https://github.com/kblaschke/frontend-sdl2/releases/tag/2.0-linux-pre1) for Ubuntu 22.04 and
55+
compatible distributions)
56+
- [Steam](https://store.steampowered.com/app/1358800/projectM_Music_Visualizer/) (Same as standalone development
57+
preview)
58+
59+
Or check your distribution's package manager for a binary release. If it is outdated, please contact the package
60+
maintainer, as the projectM development team does not maintain any of the distribution-specific packages.
5161

5262
#### Android
5363

54-
- [Google Play](https://play.google.com/store/apps/details?id=com.psperl.prjM) (**Note**: This app is _not_ created or
55-
supported by the projectM developers!)
64+
- [Google Play](https://play.google.com/store/apps/details?id=com.psperl.prjM)
65+
66+
**Note**: Both the free and paid apps plus the Android TV app are _not_ created or supported by the projectM developers!
67+
If you have technical troubles or other inquiries, please contact the app author via the means provided in the Play
68+
Store. Any bug reports in the projectM issue tracker regarding the apps will be closed immediately.
5669

5770
#### Xbox / Windows Phone
5871

59-
- [Windows Store](https://www.microsoft.com/store/apps/9NDCVH0VCWJN)
72+
- [Windows Store](https://www.microsoft.com/store/apps/9NDCVH0VCWJN) (Old 3.1.12 release)
6073

6174
#### Other
6275

63-
- [Library source code](https://github.com/projectM-visualizer/projectm/)
76+
Source code and other resources, mostly aimed at developers.
77+
78+
- [Library source code](https://github.com/projectM-visualizer/projectm/) (this repository)
6479
- [Qt5](https://www.qt.io/) based [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) and JACK desktop
65-
apps [as source code for Linux](https://github.com/projectM-visualizer/frontend-qt)
66-
- [ALSA, XMMS, Winamp, JACK](https://sourceforge.net/projects/projectm/files/) (source, unmaintained)
80+
apps [as source code for Linux](https://github.com/projectM-visualizer/frontend-qt), currently broken and needs some
81+
updating (help wanted!).
82+
- [ALSA, XMMS, Winamp, JACK](https://sourceforge.net/projects/projectm/files/) (legacy 2.x sources for historic
83+
purposes, unmaintained since 2012)
6784

6885
### Discord chat
6986

70-
[Chat with us on Discord.](https://discord.gg/mMrxAqaa3W)
87+
[Chat with us on Discord!](https://discord.gg/mMrxAqaa3W)
7188

7289
### Demo Video
7390

@@ -80,8 +97,15 @@ The preset files define the visualizations via pixel shaders and Milkdrop-style
8097
The projectM library does not ship with any presets. The frontends come with varying preset packs which can be found in
8198
separate repositories in the projectM repository list:
8299

83-
- [Base Milkdrop texture pack](https://github.com/projectM-visualizer/presets-milkdrop-texture-pack)
84-
-
100+
- [Base Milkdrop texture pack](https://github.com/projectM-visualizer/presets-milkdrop-texture-pack) - Recommended for
101+
use with _any_ preset pack!
102+
- [Cream of the Crop Pack](https://github.com/projectM-visualizer/presets-cream-of-the-crop) - A collection of about 10K
103+
presets compiled by Jason Fletcher. Currently, projectM's default preset pack.
104+
- [Classic projectM Presets](https://github.com/projectM-visualizer/presets-projectm-classic) - A bit over 4K presets
105+
shipped with previous versions of projectM.
106+
- [Milkdrop 2 Presets](https://github.com/projectM-visualizer/presets-milkdrop-original) - The original preset
107+
collection shipped with Milkdrop and Winamp.
108+
- [En D Presets](https://github.com/projectM-visualizer/presets-en-d) - About 50 presets created by "En D".
85109

86110
Included with projectM are the bltc201, Milkdrop 1 and 2, projectM, tryptonaut and yin collections. You can grab these
87111
presets [here](http://spiegelmc.com/pub/projectm_presets.zip).
@@ -91,13 +115,16 @@ presets [here](https://mischa.lol/projectM/presets_community.zip) (123MB zipped)
91115

92116
### Also Featured In
93117

94-
[![Kodi](https://github.com/projectM-visualizer/projectm/raw/master/web/kodi.png) Kodi (formerly XBMC)](https://kodi.tv/)
118+
[![Kodi](web/kodi.png) Kodi (formerly XBMC)](https://kodi.tv/)
119+
120+
[![Helix](web/helix.jpg) Helix](https://web.archive.org/web/20180628174410/http://ghostfiregames.com/helixhome.html)
95121

96-
[![Helix](https://github.com/projectM-visualizer/projectm/raw/master/web/helix.jpg) Helix](https://web.archive.org/web/20180628174410/http://ghostfiregames.com/helixhome.html)
122+
[![Silverjuke](web/silverjuke.png) Silverjuke (FOSS Jukebox)](https://www.silverjuke.net)
97123

98-
[![Silverjuke](https://github.com/projectM-visualizer/projectm/raw/master/web/silverjuke.png) Silverjuke (FOSS Jukebox)](https://www.silverjuke.net)
124+
[![VLC Media Player](web/vlc.png) VLC Media Player (AKA VideoLAN Client)](https://www.videolan.org/vlc/)
99125

100-
[<img src="https://silentradiance.com/demos/projectM_vr/projectm_vr.png" width="200" > Silent Radiance Distance Disco](https://silentradiance.com)
126+
Reminder: These are all third-party integrations of libprojectM and not developed or supported by the projectM
127+
development team. Please report bugs in those applications to their respective developers.
101128

102129
---
103130

@@ -147,7 +174,7 @@ the [projectM organization's repositories](https://github.com/projectM-visualize
147174

148175
# Todo
149176

150-
- Steal cool stuff from the recently-released Milkdrop source.
177+
- Improve projectM using the recently-released Milkdrop source (WIP).
151178
- Update the various implementations using libprojectM.
152179
- Update downstream projects with new versions.
153180

@@ -164,9 +191,10 @@ Report issues on GitHub in the respective repositories:
164191
- Issues regarding the **projectM Android apps in the Play Store**, please contact the app author via the Play Store. We
165192
cannot help with any problems or requests.
166193

167-
If unsure, post your issue in the main [libprojectM repository](https://github.com/projectM-visualizer/projectm/issues).
194+
If unsure, post your issue in the
195+
main [libprojectM issue tracker](https://github.com/projectM-visualizer/projectm/issues).
168196
Please always check any existing issues if your problem has already been posted by another user. If so, add your logs
169-
and findings to the existing issue instead of opening a new one.
197+
and findings to the existing issue instead of opening a new ticket.
170198

171199
## Get in contact with us
172200

@@ -181,7 +209,7 @@ Before starting to write code, please take your time to read
181209
the [contribution guidelines](https://github.com/projectM-visualizer/projectm/wiki#contributing-to-projectm) in our
182210
wiki.
183211

184-
## Maintainers
212+
## Package Maintainers
185213

186214
If you maintain packages of libprojectM, we are happy to work with you! Please note well:
187215

@@ -201,11 +229,11 @@ If you maintain packages of libprojectM, we are happy to work with you! Please n
201229

202230
## License
203231

204-
projectM is released under
232+
The core projectM library is released under
205233
the [GNU Lesser General Public License 2.1](https://github.com/projectM-visualizer/projectm/raw/master/LICENSE.txt) to
206-
keep any changes to the core library open-sourced, but also enable the use of libprojectM in closed-source
207-
applications (as a shared library)
208-
as long as the license terms are adhered to.
234+
keep any changes open-sourced, but also enable the use of libprojectM in closed-source applications (as a shared
235+
library) as long as the license terms are adhered to. The up- and downstream projects may use different licenses -
236+
please check all parts of the software to be compatible with your specific project if you plan an integration.
209237

210238
## Wiki
211239

web/vlc.png

27.6 KB
Loading

0 commit comments

Comments
 (0)