Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 3.83 KB

README.md

File metadata and controls

56 lines (40 loc) · 3.83 KB

Vortex Engine

Welcome to the Vortex Engine firmware repository! This open-source project is designed to run as a firmware on any kind of lightshow or led toy.

The firmware enables users to create mesmerizing light shows by allowing any flashing patterns, colorsets, or effects to be programmed onto their devices.

It uses a standardized format for savefiles and transferring data which allows all devices running vortex to share colorsets, patterns and modes. Menus and user interface is standardized with color schemes so users only need to learn how to program one device and they will know how to program all devices running Vortex.

You can find here the core Vortex Engine codebase along with branches for all devices from StoneOrbits including: Orbit, Gloves, Handle, and Duo chip.

You can read more detailed project documentation here

Repository Structure

The repository branches are each dedicated to a specific device's firmware.

Core (Master Engine)

Core
This branch holds the master firmware that forms the foundation for all other branches.

Desktop (Dynamic Desktop Library)

Desktop
Desktop Version
This is a sophisticated enhancement of the core to turn Vortex into a powerful desktop library that can be used to design various desktop applications like the Vortex Editor.

Orbit (Vortex Classic Orbit)

Orbit
Orbit Version
The firmware specifically designed for the Vortex Classic Orbit resides here.

Handle (Vortex Omega Handles)

Handle
Handle Version
This branch hosts the firmware designed for the Vortex Omega Handles.

Gloves (Vortex Wired Gloveset)

Gloves
Gloves Version
Here, you'll find the firmware for the Vortex Wired Gloveset.

Duo (Vortex Duo Modular Chip)

Duo
Duo Version
This branch contains the firmware for the Vortex Duo Modular Chip.

Chromadeck (Vortex Chromadeck Mode Bank)

Chromadeck
Chromadeck Version
This branch contains the firmware for the Vortex Chromadeck dynamic storage and transfer tool.

Spark (Spark Orbit and Handle)

Spark
Spark Version
This branch contains the firmware for the Vortex Spark firmware, this powers multiple devices: the Spark Orbit and Spark Handle.

To access a device's firmware, simply switch to its corresponding branch.