From 60b968168e8b3debff854a11ac7ed7879d0fea62 Mon Sep 17 00:00:00 2001 From: Shane Aronson Date: Thu, 16 Jan 2025 01:03:59 -0800 Subject: [PATCH] Vortex Devices section --- docs/getting_started.md | 8 ++- docs/lightshow_lol_examples.md | 121 +-------------------------------- docs/vortex_devices.md | 34 +++++++++ 3 files changed, 40 insertions(+), 123 deletions(-) create mode 100644 docs/vortex_devices.md diff --git a/docs/getting_started.md b/docs/getting_started.md index 390a1dcc5e..2a9bc2a65f 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -32,10 +32,12 @@ You can expect to find navigation buttons an Spark Handle Chromadeck -## Duo -The Duo's navigation button also doubles as it's power switch. +##
Duo
- Duo +
+

The Duo's navigation button also doubles as its power switch.

+ Duo +
## Next Steps diff --git a/docs/lightshow_lol_examples.md b/docs/lightshow_lol_examples.md index 0460604282..934f860dc3 100644 --- a/docs/lightshow_lol_examples.md +++ b/docs/lightshow_lol_examples.md @@ -6,126 +6,7 @@ parent: Lightshow.lol has_children: true --- - - - - - -# Lightshow.lol - -This page details how to use the web-based Vortex Editor [lightshow.lol](https://lightshow.lol). - -## Basics - -Lightshow.lol is an online tool that allows you to design, preview, and export custom [modes](modes.html) for any Vortex devices. - -The lightshow preview is the main focus of the page, with various control panels serving to modify the pattern, colorset, and preview animation. - -{: .warning } -Although the preview is an exact simulation of a real device, due to the difference in the way color is produced by LEDs and displays **the preview will never look exactly the same as real LEDs** - -### What is a Vortex Editor - -In the **Vortex Engine** ecosystem a [mode](modes.html) consists of a [pattern](patterns.html) and a [colorset](colorsets.html) for each LED on a device. - -For example, the **Spark Orbit** has **6 LEDs** which means **6 Patterns** and **6 Colorsets** -- one for each LED. - -A **Vortex Editor** is any kind of software designed to edit the **Patterns** or **Colorsets** in the **Modes** of a **Vortex Device**. - -### Panel Breakdown -In order to get familiar with how lightshow.lol works it is important to first familiarize yourself with each UI Panel. - -Select one of the Panels below to learn more about it: - -
- - 🔗 Animation Panel → - - - - 🔗 Device Control → - - - - 🔗 Modes Panel → - - - - 🔗 Led Selection → - - - - 🔗 Pattern Panel → - - - - 🔗 Colorset Panel → - - - - 🔗 Color Picker → - - - - 🔗 Update Panel → - - - - 🔗 Chromalink Panel → - - -
+# Lightshow.lol Examples ### Example Workflows diff --git a/docs/vortex_devices.md b/docs/vortex_devices.md new file mode 100644 index 0000000000..f6a37efefe --- /dev/null +++ b/docs/vortex_devices.md @@ -0,0 +1,34 @@ +--- +layout: default +title: Vortex Devices +nav_order: 2 +has_children: true +--- + +# Vortex Devices + +The Votex Engine is a open-source project designed to manage LEDs driven by microcontrollers. These are the products currently built to run the Vortex Engine with more to come in the future as it continues to grow. + +## Spark Orbit + +A 6-LED, USB-C rechargeable orbit designed for begginers. +- [Spark Orbit](Spark_Orbit_guide) + +## Spark Handles +- [Spark Handle](Spark_Handle_guide) + +## Chromadeck +- [Chromadeck](Chromadeck_guide.html) + +## Duo +mutlipurpose LED +- [Duo](duo_guide) + +## Vortex Orbit +- [Vortex Orbit](orbit_guide) + +## Omega Handle +- [Omega Handle](handles_guide) + +## Vortex Glove +- [Vortex Glove](gloves_guide) \ No newline at end of file