From 7eb68e77a9812ede697d609c4547d9ff7f99e930 Mon Sep 17 00:00:00 2001 From: Dan Date: Sat, 13 Jul 2024 13:14:44 -0700 Subject: [PATCH] updated some docs --- docs/colorsets.md | 2 +- docs/editor.md | 2 +- docs/emulator.md | 2 +- docs/getting_started.md | 12 ++++++++++ docs/index.md | 39 ++++++++++++++------------------ docs/menus.md | 2 +- docs/modes.md | 2 +- docs/patterns.md | 2 +- docs/savefile_format.md | 2 +- docs/source_code.md | 3 ++- docs/upgrade_guide.md | 8 +++++++ docs/vortex_devices.md | 2 +- docs/vortex_engine.md | 50 +++++++++++++++++++++++++++++++++++++++++ docs/vortex_software.md | 8 +++++++ 14 files changed, 105 insertions(+), 31 deletions(-) create mode 100644 docs/getting_started.md create mode 100644 docs/upgrade_guide.md create mode 100644 docs/vortex_engine.md create mode 100644 docs/vortex_software.md diff --git a/docs/colorsets.md b/docs/colorsets.md index 181bf7cc56..ee03ee657c 100644 --- a/docs/colorsets.md +++ b/docs/colorsets.md @@ -1,7 +1,7 @@ --- layout: default title: Colorsets -nav_order: 3 +nav_order: 4 parent: Vortex Engine --- diff --git a/docs/editor.md b/docs/editor.md index 20e1bd6256..614034c21d 100644 --- a/docs/editor.md +++ b/docs/editor.md @@ -1,7 +1,7 @@ --- layout: default title: Vortex Editor -nav_order: 3 +nav_order: 4 --- # Vortex Editor diff --git a/docs/emulator.md b/docs/emulator.md index 7ce2a7409f..3bbbfded2b 100644 --- a/docs/emulator.md +++ b/docs/emulator.md @@ -1,7 +1,7 @@ --- layout: default title: Vortex Emulator -nav_order: 4 +nav_order: 5 --- # Vortex Emulator diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 0000000000..9ab6ebcaaf --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,12 @@ +--- +layout: default +title: Modes +nav_order: 1 +parent: Vortex Engine +--- + +# Getting Started + +test + + diff --git a/docs/index.md b/docs/index.md index 0b22d6392a..28cc3a65bd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,42 +7,37 @@ has_children: true # Vortex Engine -Welcome to the Vortex Engine Documentation! This page covers all aspects of the project and its features. +Welcome to the Vortex Engine Wiki! Here you can find documentation covering all aspects of the Vortex Engine project. -## What is Vortex Engine? +Here are some great starting points: -Vortex Engine is a powerful and flexible software designed for 'Vortex Devices'. It enables these devices to produce stunning light shows by controlling LEDs in a variety of ways. The engine provides a robust framework that supports everything necessary for a Vortex Device to function. This means that each new Vortex Device needs only minor modifications to the core engine to be fully functional. +## Getting Started -All devices running the Vortex Engine are compatible with each other. They can share configurations for their patterns and colors, and the engine ensures compatibility regardless of the number of LEDs on each device. +Are you a new or existing Vortex Device owner looking to get started? -## What is a Vortex Device? +Follow the [Getting Started Guide](getting_started.html) -Currently, the only Vortex Devices in existence are the innovative lightshow products from [StoneOrbits](https://www.stoneorbits.com). However, any computer with at least one LED could potentially become a Vortex Device. This means you can create your own Vortex Device if you assemble the necessary hardware and make the integration changes to the core engine. +## Upgrade Guide -The four devices currently available include: +Are you an existing Vortex Device owner looking to upgrade your device? - - [StoneOrbits Vortex Gloves](https://stoneorbits.com/products/the-vortex-gloves-1): The single best wired gloveset - - [StoneOrbits Vortex Orbit](https://stoneorbits.com/products/copy-of-the-vortex-with-customs): A compact 28 led orbit - - [StoneOrbits Vortex Omega Handle](https://stoneorbits.com/products/omega-handles): Weighted 3 led Orbit handles - - [StoneOrbits Duo Chip (Coming soon)](): The new best modular orbit chip. +Follow the [Vortex Engine Upgrade Guide](upgrade_guide.html) -You can read more about the Vortex Devices [here](vortex_devices.html). +## How Vortex Works -## The Vortex Editor +Are you looking to learn how Vortex Engine works and how to get the most out of your Vortex Device? -The Vortex Engine doesn't just power embedded Vortex Devices. It can also be built for desktop computers to implement virtual Vortex Devices. An example of a virtual Vortex Device is the Vortex Editor, a Windows-only desktop software that can connect to Vortex Devices and program them via USB. +Learn about Vortex and how it works with these articles: -The editor allows for configurations that are otherwise unobtainable through the device menus. You can read more about the editor [here](editor.html). - -## The Vortex Emulator - -Much like the Vortex Editor, the Vortex Emulator is a desktop-based Vortex Device that aims to emulate the behavior of the four embedded Vortex Devices. This Vortex Device Emulator mainly acts as a rapid development and testing ground, but it can also be used to demonstrate the capability and behavior of the Vortex Engine without owning a Vortex Device. - -You can read more about the emulator [here](emulator.html). + - [Modes](modes.html) + - [Patterns](patterns.html) + - [Colorsets](colorsets.html) + - [Using Menus](menus.html) + - [Savefile Format](savefile_format.html) ## The Vortex Community and Ecosystem -All Vortex Devices can transmit and receive their configurations via some form of wired or wireless data transfer (rapid blinks of infrared or visible light). This creates an interactive ecosystem where users can configure one device and transfer the settings to another for matching patterns and colorsets. +All Vortex Devices can transmit and receive their configurations in some way. This allows for an ecosystem where users can transfer to other devices to create matching patterns and colorsets. Explore the official Vortex Community Hub where you can upload and share configurations and modes with friends and other lightshow artists. diff --git a/docs/menus.md b/docs/menus.md index c0676eb225..f31428dc6d 100644 --- a/docs/menus.md +++ b/docs/menus.md @@ -1,7 +1,7 @@ --- layout: default title: Menus -nav_order: 4 +nav_order: 5 parent: Vortex Engine has_children: true --- diff --git a/docs/modes.md b/docs/modes.md index 32c154c70c..45fe9df373 100644 --- a/docs/modes.md +++ b/docs/modes.md @@ -1,7 +1,7 @@ --- layout: default title: Modes -nav_order: 1 +nav_order: 3 parent: Vortex Engine --- diff --git a/docs/patterns.md b/docs/patterns.md index 8dd771f7ae..b755ee535f 100644 --- a/docs/patterns.md +++ b/docs/patterns.md @@ -1,7 +1,7 @@ --- layout: default title: Patterns -nav_order: 2 +nav_order: 3 parent: Vortex Engine --- diff --git a/docs/savefile_format.md b/docs/savefile_format.md index 01566985e8..3141cb3de6 100644 --- a/docs/savefile_format.md +++ b/docs/savefile_format.md @@ -1,7 +1,7 @@ --- layout: default title: Savefiles -nav_order: 5 +nav_order: 6 parent: Vortex Engine --- diff --git a/docs/source_code.md b/docs/source_code.md index 1c92677874..92a9d3cef3 100644 --- a/docs/source_code.md +++ b/docs/source_code.md @@ -1,7 +1,7 @@ --- layout: default title: Source Code -nav_order: 5 +nav_order: 6 --- # Source Code @@ -21,4 +21,5 @@ You can find generated Doxygen documentation for all devices and the core here - [Handle](handle) - [Duo](duo) - [Chromadeck](chromadeck) + - [Spark](spark) diff --git a/docs/upgrade_guide.md b/docs/upgrade_guide.md new file mode 100644 index 0000000000..6ac82fa8de --- /dev/null +++ b/docs/upgrade_guide.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Modes +nav_order: 2 +parent: Vortex Engine +--- + +# Upgrading a Device to Latest Vortex \ No newline at end of file diff --git a/docs/vortex_devices.md b/docs/vortex_devices.md index b1a6f86974..f468c0e05d 100644 --- a/docs/vortex_devices.md +++ b/docs/vortex_devices.md @@ -1,7 +1,7 @@ --- layout: default title: Vortex Devices -nav_order: 2 +nav_order: 4 has_children: true --- diff --git a/docs/vortex_engine.md b/docs/vortex_engine.md new file mode 100644 index 0000000000..c348848192 --- /dev/null +++ b/docs/vortex_engine.md @@ -0,0 +1,50 @@ +--- +layout: default +title: Vortex Engine +nav_order: 2 +has_children: true +--- + +## What is Vortex Engine? + +The purpose of Vortex Engine, and the reason for it's creation, is devices with arrays of leds used to produce visually appealing lightshows when a user spins, manipulates or dances with the device. Vortex Engine is the core piece of software which allows the users to configure the patterns, colors, and settings to produce consistent colorful patterns based on their preferences. + +The engine provides the framework of everything necessary for a 'Vortex Device' to function (input, storage, timing, pattern format) while ensuring that all of the devices are compatible with one another. For example, regardless of how many leds a device has, Vortex Engine will ensure the pattern and colorset configurations can be shared with any other Vortex Device. + +## What is a Vortex Device? + +Currently, the only Vortex Devices in existence are the lightshow products from [StoneOrbits](https://www.stoneorbits.com). However, any device with at least one LED could become a 'Vortex Device'. This means in theory anybody could create their own Vortex Devices by assembling some hardware and configuring vortex engine. + +The four devices currently available include: + + - [StoneOrbits Vortex Gloves](https://stoneorbits.com/products/the-vortex-gloves-1): The single best wired gloveset + - [StoneOrbits Vortex Orbit](https://stoneorbits.com/products/copy-of-the-vortex-with-customs): A compact 28 led orbit + - [StoneOrbits Vortex Omega Handle](https://stoneorbits.com/products/omega-handles): Weighted 3 led Orbit handles + - [StoneOrbits Duo Chip](https://stoneorbits.com/products/duo-orbit-light): The new best modular orbit chip. + - [StoneOrbits Chromadeck (Coming Son)](): The super hub to answer all your needs + - [StoneOrbits Spark Orbit (Coming Son)](): The next generation of integrated orbit + +You can read more about the Vortex Devices [here](vortex_devices.html). + +## The Vortex Editors + +Vortex Engine doesn't just power embedded lightshow devices. The software can also be built for desktop computers to implement 'virtual Vortex Devices'. A 'virtual Vortex Device', although sounding complicated, is actually the best way to provide a PC-based savefile editor for Vortex devices. + +The best example of a 'virtual Vortex Device' is the website [lightshow.lol](https://lightshow.lol), here you see the output of a single-led 'virtual device' with a series of controls to edit the pattern and colorset in realtime. + +Another example of a , a Windows-only desktop software that can connect to Vortex Devices and program them via USB. + +The editor allows for configurations that are otherwise unobtainable through the device menus. You can read more about the editor [here](editor.html). + +## The Vortex Community and Ecosystem + +All Vortex Devices can transmit and receive their configurations in some way. This allows for an ecosystem where users device configurations can transfer to other devices to create matching patterns and colorsets. + +Explore the official Vortex Community Hub where you can upload and share configurations and modes with friends and other lightshow artists. + +[Visit Vortex Community Hub](https://vortex.community) + +Join the Vortex Community Discord to share your experiences, enhance your use of the Vortex Engine, and discuss Vortex with other enthusiasts. + +[Join Vortex Community Discord](https://discord.gg/FnbKjPgy) + diff --git a/docs/vortex_software.md b/docs/vortex_software.md new file mode 100644 index 0000000000..8f387adcfe --- /dev/null +++ b/docs/vortex_software.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Vortex Software +nav_order: 5 +has_children: true +--- + +