Skip to content

Commit

Permalink
updated some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Unreal-Dan committed Jul 13, 2024
1 parent 4181208 commit 7eb68e7
Show file tree
Hide file tree
Showing 14 changed files with 105 additions and 31 deletions.
2 changes: 1 addition & 1 deletion docs/colorsets.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Colorsets
nav_order: 3
nav_order: 4
parent: Vortex Engine
---

Expand Down
2 changes: 1 addition & 1 deletion docs/editor.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Vortex Editor
nav_order: 3
nav_order: 4
---

# Vortex Editor
Expand Down
2 changes: 1 addition & 1 deletion docs/emulator.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Vortex Emulator
nav_order: 4
nav_order: 5
---

# Vortex Emulator
Expand Down
12 changes: 12 additions & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: default
title: Modes
nav_order: 1
parent: Vortex Engine
---

# Getting Started

test


39 changes: 17 additions & 22 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/menus.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Menus
nav_order: 4
nav_order: 5
parent: Vortex Engine
has_children: true
---
Expand Down
2 changes: 1 addition & 1 deletion docs/modes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Modes
nav_order: 1
nav_order: 3
parent: Vortex Engine
---

Expand Down
2 changes: 1 addition & 1 deletion docs/patterns.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Patterns
nav_order: 2
nav_order: 3
parent: Vortex Engine
---

Expand Down
2 changes: 1 addition & 1 deletion docs/savefile_format.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Savefiles
nav_order: 5
nav_order: 6
parent: Vortex Engine
---

Expand Down
3 changes: 2 additions & 1 deletion docs/source_code.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Source Code
nav_order: 5
nav_order: 6
---

# Source Code
Expand All @@ -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)

8 changes: 8 additions & 0 deletions docs/upgrade_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: Modes
nav_order: 2
parent: Vortex Engine
---

# Upgrading a Device to Latest Vortex
2 changes: 1 addition & 1 deletion docs/vortex_devices.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Vortex Devices
nav_order: 2
nav_order: 4
has_children: true
---

Expand Down
50 changes: 50 additions & 0 deletions docs/vortex_engine.md
Original file line number Diff line number Diff line change
@@ -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)

8 changes: 8 additions & 0 deletions docs/vortex_software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: Vortex Software
nav_order: 5
has_children: true
---


0 comments on commit 7eb68e7

Please sign in to comment.