Skip to content

Commit

Permalink
v4.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@MV10
MV10 committed Feb 1, 2024
1 parent c7852b1 commit 5e27191
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

## **Streaming Music Visualizer**

> Version 3.1.0 has been [released](https://github.com/MV10/monkey-hi-hat/releases)!
> Version 4.0.0 has been [released](https://github.com/MV10/monkey-hi-hat/releases)!
Monkey Hi Hat displays colorful, interesting graphics, many of which are audio-reactive -- they move and change in time with whatever music is being played through your PC. The program and all content are 100% free, and I encourage the public to contribute new visualizations.

**NEW:** Version 3 releases include an easy-to-use install script.
As of the version 4 release, there are over 2,000 combinations of visualizations and effects!

Check out my Jan-2024 blog article [Getting Started Tutorial](https://mcguirev10.com/2024/01/20/monkey-hi-hat-getting-started-tutorial.html).
Check out my Jan-2024 blog article [Getting Started Tutorial](https://mcguirev10.com/2024/01/20/monkey-hi-hat-getting-started-tutorial.html). (Note the article refers to an install script; as of version 4, the installer is a stand-alone program that is even faster and easier to use.)

## Basic Details

All important documentation has been moved to the [wiki](https://github.com/MV10/monkey-hi-hat/wiki).

It requires .NET 8, an OpenGL 4.6 GPU and drivers, and it runs under Windows 10, and Windows 11. Linux support was temporarily removed, but a bug has been fixed and Linux x64 testing will begin shortly. A tar.gz archive will be added to the release page once everything is verified working. Setup details are covered in the _Quick Start_ sections of the Wiki.
Note that the program is designed to run full screen, and to be controlled from another PC or Android device. You _can_ launch it in a window (instead of full screen), and use a local console to pull up content (like loading a playlist), then switch it to full screen. But if you have another device, skip down to the _Related Material_ section of the readme for more information, and also check out the instructions in the wiki.

The program intercepts audio using OpenAL and my [eyecandy](https://github.com/MV10/eyecandy) audio-to-texture library, allowing the creation of various audio-reactive OpenGL shaders as interesting visualizations to accompany the music. Playlists of these visualizations can be created with various criteria for rotating among the listed shaders.
Version 4 is an important update which introduces text overlays (including Spotify track information, if you're running the native Windows Spotify client), randomized crossfade transitions, and more. Versions 2 and 3 were also major updates with many new features and effects. The Changelog page in the wiki has all the details if you're interested.

Version 2 was a _major_ update with many new features, architectural improvements and more. In particular, shader crossfade is here, and a new multi-pass shader model is available, allowing for dramatically more complex effects. This version requires OpenGL 4.6 support (which should be widely available, and is apparently the final version of OpenGL now that Khronos is down the rabbit-hole of the "new" Vulkan API).
It requires a reasonably modern video card supporting OpenGL 4.5, and it runs under Windows 10, and Windows 11. It also requires .NET 8 but the installer handles this for you. (Linux support was temporarily removed, but a bug has been fixed and Linux x64 testing will begin shortly. A tar.gz archive will be added to the release page once everything is verified working.)

Version 3 is another _huge_ update which takes full advantage of the big changes in version 2. The addition of post-processing effects (aka "FX") are the most obvious change, but head to the wiki change-log to see the giant list of new features. Additionally, the wiki has been almost completely rewritten with all of the details, and Volt's Laboratory has a huge number of new visualizations and effects.
The program intercepts audio using my [eyecandy](https://github.com/MV10/eyecandy) audio-to-texture library, allowing the creation of various audio-reactive OpenGL shaders as interesting visualizations to accompany the music. Playlists of these visualizations can be created with various criteria for rotating among the listed shaders.

## Sample Video

Expand All @@ -41,5 +41,6 @@ Sample shaders and playlists, accompanying configuration files, icons, and the o
_**v1.2.0 is the final release supporting the Raspberry Pi and ARM32HF.**_ My original goal was to run this on a Raspberry Pi 4B, however the GPU can only handle relatively simple shaders with any decent frame rate, and OpenGL ES can't handle some of the future changes I'm planning, so my target is now a Windows-based mini-PC. However, this should still work on other Linux hardware. The wiki has instructions about OS configuration for audio capture on both platforms.

## Known issues

* None

0 comments on commit 5e27191

Please sign in to comment.