With Sparkled, you get an integrated solution containing:
- A rich web interface for sequencing, previewing and scheduling music-backed LED animations
- A fast UDP service to stream rendered data to Sparkled clients, which use the data to drive LED strips (or whatever you want!)
The Sparkled application is used to design and serve the animations, and one or more Sparkled clients consume this data. More information on Sparkled clients will be made available closer to the initial V1 release.
Before Initial Release
- Move project to Sparkled github account
- Set up official project website
- Rewrite UI in React (In Progress)
- Stage editor, so users can set up their own lighting structures
- Lots of unit & integration testing
- Various bugfixes
After Initial Release
- Add more effect and fill types
- Multithreaded rendering
- Support sequences without music (currently requires a mute MP3 file to be uploaded)
- Ability to replace MP3 files for existing sequences (even with different lengths)
- More Sparkled Clients (ESP8266, Arduino Ethernet)
Sparkled is currently in pre-alpha, so significant chunks of core functionality are still missing or incomplete.
These instructions will get you a copy of the project up and running on your local machine.
The following software and hardware requirements must be met before installing the Sparkled server:
- Java SE 8 JDK (8u151 or later recommended)
- Maven 3 (3.5.2 or later recommended)
- A modern web browser (Chrome 60 or later recommended)
- Internet connectivity to download Maven and NPM artifacts
Fork and clone the repository
SSH: git clone firstname.lastname@example.org:<your_username>/sparkled.git HTTPS: git clone https://github.com/<your_username>/sparkled.git
Build the project
Note: the initial build will take quite a while, as all of the Maven and NPM dependencies need to be downloaded
cd sparkled mvn install
cd sparkled/app/target java -jar sparkled.jar
Wait for the application to start, then connect to the UI in Chrome via the following URL:
Running the tests
maven to run both the frontend and backend unit tests:
cd sparkled mvn test
npm to run just the frontend unit tests:
cd sparkled/webui npm run test
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Chris Parton - chrisparton1991
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details