Skip to content

Commit

Permalink
docs work
Browse files Browse the repository at this point in the history
  • Loading branch information
Unreal-Dan committed Jul 16, 2024
1 parent 9da7c2d commit 304ca31
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 8 deletions.
18 changes: 13 additions & 5 deletions docs/basic_usage.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
---
layout: default
title: Basic Usage
title: Vortex Device Basic Usage
nav_order: 3
parent: Vortex Engine
---

# Basic Usage
# Vortex Device Basic Usage
The Vortex Wired Gloves and Omega Handles are each equipped with a power switch and at least one button (the orbit has two, the outer button is _primary_).

have one primary button while a few others sport a secondary button. The primary (or main) button on all devices will behave the same and the secondary button will have varying functionality across menus.
Find the power switch on your device and turn it on, the leds should activate and start playing the first _mode_.

Most devices have a hardware switch to control power, find this switch on your device and turn it on.
## The Mode List
Vortex devices start on the _mode list_, you can think of a _mode_ as the colorful blinking pattern that is playing on the leds.

The amount of modes depends on the led count and storage space of the device, more leds means less modes.

### Navigating
Use the button(s) to _click_ through the _mode list_, when the end of the list is reached it will wrap around to the first.

If you hold down the button for a second or two the leds will start alternating white blinks, this has opened [The Menus](menus.html).

Once the vortex device is running, the primary button will cycle through the various [modes](modes.html). The 'modes' that come with the device are the defaults and they can be restored at any time.
4 changes: 1 addition & 3 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,13 @@ Below is an animated guide provided by StoneOrbits:
<iframe src="https://docs.google.com/presentation/d/e/2PACX-1vRLsq6i3h9JlYHX0wS3SG9eDZ1vzIsRIU8GAZ9C2QW80uRoexr6_MAmvv_RAu7yuKxZiHy0dH9s2c3q/embed?start=false&loop=false&delayms=3000" frameborder="0" width="100%" height="569" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
{% endraw %}

Continue reading

# Getting to Know the Device

If this is your first time with a Vortex Device then congratulations and welcome to the Vortex Engine tutorial.

Regardless of which device you have, Orbit, Handles, Wired Gloves, or others, most devices work and function almost entirely the same.

The first thing you should do is connect your device to the PC and install updates to avoid any potential known bugs or problems, continue reading below for instructions to do this.
The first thing you should do is connect your device to the PC and install updates to avoid any potentially known bugs or problems, continue reading below for instructions to do this.

However, if you'd rather live life on the edge and want to jump straight into things then head over to [Basic Usage](basic_usage.html) to start using your device now.

Expand Down
29 changes: 29 additions & 0 deletions docs/menus.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,35 @@ has_children: true
.red .content { background: linear-gradient(to bottom, rgba(255, 0, 0, 0.3), transparent); }
</style>



### Entering Menus
When the menus open, the last _mode_ that was playing becomes the 'target' of the menu operations.




specific menus associated with it, accessible by holding down the button for a few seconds:
- **Mode-Specific Menus:** These menus allow you to adjust settings that apply only to the current mode. For example, you might change the color set or modify pattern parameters.
- **Universal Menus:** These menus affect the entire device and include options like factory reset or global brightness settings.

## Common Menus and Settings
### Mode-Specific Menus
Each mode may have its own set of menus, accessible by holding the button. Some common options you might find include:
- **Color Set Selection:** Choose from a variety of pre-defined color sets.
- **Pattern Parameters:** Adjust the speed, intensity, or other parameters specific to the pattern in the current mode.

### Universal Menus
Universal menus apply to the entire device, regardless of the current mode. These can be accessed in a similar way by holding the button, and include options such as:
- **Factory Reset:** Restore the device to its original factory settings.
- **Global Brightness:** Adjust the brightness level for all modes.

## Summary
Understanding the basic usage of Vortex Engine devices allows you to fully utilize their capabilities. Remember, all devices feature power switches and one or two buttons for mode cycling and menu access. With these controls, you can customize your lightshow experience and explore the full potential of your Vortex Engine device.

For more detailed instructions on specific modes and advanced features, refer to the user manual or visit the support section of our website.


# Menus

Each of these menus serves a specific purpose and allows you to customize your Vortex Device in different ways. When you open the menus on any Vortex Device, whichever mode slot was selected and playing when you open the menus will be targeted as the mode to be configured by whichever menu you may enter.
Expand Down

0 comments on commit 304ca31

Please sign in to comment.