https://github.com/calebabg/musicvisualizerv2
The awesome Music Visualizer is back and better!
https://github.com/calebabg/musicvisualizerv2
java kotlin music-player music-visualizer processing visualizer
Last synced: 12 months ago
JSON representation
The awesome Music Visualizer is back and better!
- Host: GitHub
- URL: https://github.com/calebabg/musicvisualizerv2
- Owner: CalebABG
- License: mit
- Created: 2020-10-01T20:05:46.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T18:32:51.000Z (about 2 years ago)
- Last Synced: 2025-04-14T16:00:39.831Z (about 1 year ago)
- Topics: java, kotlin, music-player, music-visualizer, processing, visualizer
- Language: Kotlin
- Homepage:
- Size: 12.8 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Synopsis
The prodigal Music Visualizer returns, and it's even better. Version 2 of Music-Visualizer is finally here!
V2 brings a much better codebase and more ease for addition, and will only improve over time.
---
## Releases?
Yes, yes, I know! Unlike the previous version, for now, V2 releases of the ```.jar``` will be a stand-alone player. SoundCloud integration will be hidden unless a valid SoundCloud ```ClientId``` is set via environment variable.
To protect the ```ClientId``` which SoundCloud uses to authenticate requests to its API, the best way (I've found for now) from it being decompiled out of the ```.jar``` is to set an environment variable and retrieve it at run time.
---
## Working with the Source
### What you'll need to build and run from the source code
```
Java JDK + IntelliJ + Kotlin
```
#### The codebase is an IntelliJ IDEA project, so I'd recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/). This project also uses [Kotlin](https://kotlinlang.org/?fromMenu), which is an incredible language! I'd also recommend using the ```Adoptium```: [Eclipse Temurin 17 (LTS)](https://adoptium.net/temurin/releases/?version=17)
### Project Needed Setup
#### SoundCloud ```ClientId``` Token:
- To avoid the token being packaged into the ```.jar``` during the Maven package Lifecycle, for now, I thought setting an environment variable would be the best way to secure the token.
- I've created a convenience scripts for setting the environment variable! In a terminal window change into the ```tools``` folder of this repo, then execute the script for your OS:
- Note: Replace `````` with your actual SoundCloud ClientId
#### For Windows
1. ```
./tokenhelper.ps1
```
#### For Mac and Linux
1. ```python
./tokenhelper.sh
```
1. Note: If you mess up setting the token, you'll need to manually edit your ```.bashrc``` file to correct the export value
2. And Boom! You should be all set to go!
#### Maven Setup
- If using [IntelliJ IDEA](https://www.jetbrains.com/idea/) IDE, when opening the project, hit the popup about the ```pom.xml``` file that says something like: ```Add as Maven Project```
- This will make sure IntelliJ recognizes the project as being a Maven project!
### Maven Tools
- To build the .jar, in the Maven Lifecycle, use the ```package``` command
- To install local needed dependencies for .jars in the ```lib``` folder, and to clean the project ('target' in root project dir) use the ```clean``` command
---
## Issues? Features? More???
Create an ```issue``` for the repo if you encounter any errors or strange behavior/functionality with the application.
Please feel free to fork and submit bug fixes or feature requests!
---
## Errors / Gotchas?
1. If you're using IntelliJ, if you happen to get this exception: ```NoClassFoundException - Main```, try the following:
1. Close the project
2. In the root of the repo, delete the ```.idea``` folder (this is the folder IntelliJ uses for the IDE)
3. Re-open the project in IntelliJ and then rebuild and debug
4. Hopefully that fixes that exception, if not please open an issue for it.
---
## Libraries and API's Used
- [Processing 4](https://processing.org/) - Graphics library
- [Minim](https://github.com/ddf/Minim) - Audio library
- [ControlP5](https://www.sojamo.de/libraries/controlP5/) - Awesome GUI controls
- [Apache Commons IO](https://commons.apache.org/proper/commons-io/) - IO Utility library
- [Unirest](https://kong.github.io/unirest-java/) - Java http-client library
- [Gson](https://github.com/google/gson) - Java JSON library
---
## Closing Comments
Thank you for checking out my work/experiment! I'll be pushing updates to this project as often as I can. Please feel free to fork or port this to other languages! Have fun and keep on creating!