diff --git a/advanced-topics/animation-editor/index.html b/advanced-topics/animation-editor/index.html index 861b848..c45cab5 100644 --- a/advanced-topics/animation-editor/index.html +++ b/advanced-topics/animation-editor/index.html @@ -1,4 +1,4 @@ Animation Editor • advanced-topics • Aurora Docs
-Aurora User Docs

Animation Editor


Last updated 10.01.2024

The Animation Layer allows you to add your own custom animated effects to your peripheral lights. To edit this animation, the Animation Editor used. This is a powerful tool, and fairly easy to use once you understand how it works. As with all unfamiliar things however, it may be daunting at first.

Concepts and Definitions

Before getting into the guide itself, let me define some of the concepts and features that are required to fully understand how the animations work.

  • Each frame, the animation is drawn onto a Canvas which is then sent to your connected peripherals. The canvas is a rectangle with a height and a width, this size of which depend on the position and size of the peripherals. Anything drawn to the canvas will be drawn at a specific point on the canvas, with x=0, y=0 being the coordinate of the top left.
  • An animation is built up of one or more Animation Tracks. Each of these tracks can represent a single shape (e.g. rectangle, filled circle, etc.)
  • Each shape has a number of Properties, depending on what sort of shape they are. For example, a circle has radius, center x, center y, color and width properties. These properties determine how the shape will be rendered to the canvas.
  • Each animation track will have one or more Keyframes which are points on the timeline where you can set the properties of a shape. The keyframes do not have to line up on each track. For example one track may only have one keyframe while another may have ten.
  • Between keyframes, the properties of a shape on a track will interpolate, forming a smooth transition.

The Editor

With that out of the way, lets move on to the creation of an animation. To open the animation editor, first add an animation layer to your profile. On the layer settings, click on the “Edit Animation” button. When you first open the animation editor you will be presented with a screen that looks like this:

The main screen of the Animation Editor labelled showing the main controls

There are 3 main areas to the editor:

  • The timeline which shows the tracks that currently make up the animation as well as also containing a seek line (the vertical red line) which dictates which how far through the animation the preview is.
  • The preview area which shows a skeleton of your peripheral setup and the various shapes that make up the animation at the given time.
  • The property editor which, when a keypoint is selected, allows for editing the properties of that shape for that keypoint.

Creating an Animation

First we need to add a track by clicking on the “Add Track” button just above and to the left of the timeline, then choosing the type of shape we wish to add. The manual color track allows you to set individual colors of the keyboard (see Closing Notes), rather than using shapes; the other tracks should be self-explanatory. For the purpose of the tutorial, I will add an (unfilled) circle track.

Adding a circle track to the timeline

You should now see a new row has appeared in the timeline. This is the new shape we’ve just created. The left-most grey box shows the name of the track, a delete button and an icon to indicate the type of the track. If you so desire you can double click on the name of the track to change it to something more helpful, though this has no effect on the actual animation itself.

The newly created circle track on the timeline

Next to the grey box you will see a pair of colored rectangles. These represent a keyframe on the track, the color being indicative of the color of the shape at that keyframe. Clicking this keyframe, we can edit the properties of the circle using the properties in the top right. I’m going to set them to the values in the image below.

Properties for the first keyframe

Next, we’ll need another keyframe to animate to, otherwise we will just have a static image! Double click on the timeline inline with the track to insert a new keyframe at that time. Unfortunately the properties are all reset so we have to enter them again from scratch. Like before though, single left click on the keyframe and set the properties in the properties panel. This time, I will use these settings:

Properties for the first keyframe

You can add as many other keyframes as you like and even add new tracks with their own keyframes using the steps from above, but I won’t bother.

Once done, you can close the animation editor window. Finally, to ensure the animation plays smoothly, we need to set the Animation Duration property of the Animation Layer to be the length of the animation you just created. If you set a value too small, your animation will appear to be cut off, but too long and you animation will not replay quickly.

Congratulations, you’ve made your first animation! :tada:

Page authored by
\ No newline at end of file +Aurora User Docs

Animation Editor


Last updated 10.01.2024

The Animation Layer allows you to add your own custom animated effects to your peripheral lights. To edit this animation, the Animation Editor used. This is a powerful tool, and fairly easy to use once you understand how it works. As with all unfamiliar things however, it may be daunting at first.

Concepts and Definitions

Before getting into the guide itself, let me define some of the concepts and features that are required to fully understand how the animations work.

  • Each frame, the animation is drawn onto a Canvas which is then sent to your connected peripherals. The canvas is a rectangle with a height and a width, this size of which depend on the position and size of the peripherals. Anything drawn to the canvas will be drawn at a specific point on the canvas, with x=0, y=0 being the coordinate of the top left.
  • An animation is built up of one or more Animation Tracks. Each of these tracks can represent a single shape (e.g. rectangle, filled circle, etc.)
  • Each shape has a number of Properties, depending on what sort of shape they are. For example, a circle has radius, center x, center y, color and width properties. These properties determine how the shape will be rendered to the canvas.
  • Each animation track will have one or more Keyframes which are points on the timeline where you can set the properties of a shape. The keyframes do not have to line up on each track. For example one track may only have one keyframe while another may have ten.
  • Between keyframes, the properties of a shape on a track will interpolate, forming a smooth transition.

The Editor

With that out of the way, lets move on to the creation of an animation. To open the animation editor, first add an animation layer to your profile. On the layer settings, click on the “Edit Animation” button. When you first open the animation editor you will be presented with a screen that looks like this:

The main screen of the Animation Editor labelled showing the main controls

There are 3 main areas to the editor:

  • The timeline which shows the tracks that currently make up the animation as well as also containing a seek line (the vertical red line) which dictates which how far through the animation the preview is.
  • The preview area which shows a skeleton of your peripheral setup and the various shapes that make up the animation at the given time.
  • The property editor which, when a keypoint is selected, allows for editing the properties of that shape for that keypoint.

Creating an Animation

First we need to add a track by clicking on the “Add Track” button just above and to the left of the timeline, then choosing the type of shape we wish to add. The manual color track allows you to set individual colors of the keyboard (see Closing Notes), rather than using shapes; the other tracks should be self-explanatory. For the purpose of the tutorial, I will add an (unfilled) circle track.

Adding a circle track to the timeline

You should now see a new row has appeared in the timeline. This is the new shape we’ve just created. The left-most grey box shows the name of the track, a delete button and an icon to indicate the type of the track. If you so desire you can double click on the name of the track to change it to something more helpful, though this has no effect on the actual animation itself.

The newly created circle track on the timeline

Next to the grey box you will see a pair of colored rectangles. These represent a keyframe on the track, the color being indicative of the color of the shape at that keyframe. Clicking this keyframe, we can edit the properties of the circle using the properties in the top right. I’m going to set them to the values in the image below.

Properties for the first keyframe

Next, we’ll need another keyframe to animate to, otherwise we will just have a static image! Double click on the timeline inline with the track to insert a new keyframe at that time. Unfortunately the properties are all reset so we have to enter them again from scratch. Like before though, single left click on the keyframe and set the properties in the properties panel. This time, I will use these settings:

Properties for the first keyframe

You can add as many other keyframes as you like and even add new tracks with their own keyframes using the steps from above, but I won’t bother.

Once done, you can close the animation editor window. Finally, to ensure the animation plays smoothly, we need to set the Animation Duration property of the Animation Layer to be the length of the animation you just created. If you set a value too small, your animation will appear to be cut off, but too long and you animation will not replay quickly.

Congratulations, you’ve made your first animation! :tada:

Page authored by
\ No newline at end of file diff --git a/advanced-topics/overrides-system/index.html b/advanced-topics/overrides-system/index.html index fdd304f..478f549 100644 --- a/advanced-topics/overrides-system/index.html +++ b/advanced-topics/overrides-system/index.html @@ -1,4 +1,4 @@ Overrides System • advanced-topics • Aurora Docs
-Aurora User Docs

Overrides System


Last updated 10.01.2024

The overrides system is an an advanced system that allows you to override the properties of layers with other values that are evaluated each frame. This allows for a huge amount of control and customizability with your lighting that layers on their own cannot provide. You can still get fairly customization layers without this system, so do not worry if you don’t understand it. This is a feature mainly for advanced users.

The overrides system works by providing you, the user, the ability to use one of several techniques to override individual properties with custom values. If no override is provided, the value you’ve set on the normal properties editor panel will be used instead. Overrides are done on a per-property basis, so you can use one technique for one property, a different one for another property or no technique for a third for example.

The Editor

To open the overrides editor panel, first select the layer whose properties you want to override then click on the left-most button in the top right of the properties panel.

The button to open the overrides editor

The editor is split into two columns. The left column contains a list of all overridable properties on the selected layer, showing their name and type. Note that not all properties are overridable. The right hand (larger) column is where the main logic editor is. This area is how you choose and edit the override technique. Initially, only a drop down box will be shown with an empty area.

To actually setup an override for a property, select it from the property list, then choose an override mode from the drop down list.

Setting up an override on the Primary Color property of the breathing layer

Override Modes

Dynamic Value

The dynamic value override method allows you to dynamically create a value based on values of other variables.

A simple example for this could be assigning to opacity of a layer to be the health of a player, so it appears to fade in as the health lowers, showing a red warning when your character is close to death. A more complex example could be constructing a color based on the current time, with seconds being red, minutes green and hours blue. Whether you’d actually want this who knows, but it’s possible with this override technique.

Basic example of a dynamic value being used with opacity to make the layer flash in and then fade out

Depending on the type of property being edited, you will be asked to provide one or more expressions of different types. Descriptions of these expressions are available in the “Reference: Expression Types” section of the guide. For example, the “Enabled” property will require a boolean expression and “Opacity” will require a numeric expression.

Lookup Table

The lookup table is a list of condition-value pairs. When using this override technique, Aurora will evaluate the boolean condition expression of each item in the list until it finds one that is true. When it does so, it will override the requested property with the value of the pair.

Example lookup table that sets the color to red every once every three seconds

If you are familiar with the concept of programming, you can think of a lookup table as being like a switch statement or a collection of if else if blocks.

Demos

This profile contains a single solid fill layer that fades in and out every second, each second alternating between red, green and blue.

The demo layer running

You can download the demo profile here.

Page authored by
\ No newline at end of file +Aurora User Docs

Overrides System


Last updated 10.01.2024

The overrides system is an an advanced system that allows you to override the properties of layers with other values that are evaluated each frame. This allows for a huge amount of control and customizability with your lighting that layers on their own cannot provide. You can still get fairly customization layers without this system, so do not worry if you don’t understand it. This is a feature mainly for advanced users.

The overrides system works by providing you, the user, the ability to use one of several techniques to override individual properties with custom values. If no override is provided, the value you’ve set on the normal properties editor panel will be used instead. Overrides are done on a per-property basis, so you can use one technique for one property, a different one for another property or no technique for a third for example.

The Editor

To open the overrides editor panel, first select the layer whose properties you want to override then click on the left-most button in the top right of the properties panel.

The button to open the overrides editor

The editor is split into two columns. The left column contains a list of all overridable properties on the selected layer, showing their name and type. Note that not all properties are overridable. The right hand (larger) column is where the main logic editor is. This area is how you choose and edit the override technique. Initially, only a drop down box will be shown with an empty area.

To actually setup an override for a property, select it from the property list, then choose an override mode from the drop down list.

Setting up an override on the Primary Color property of the breathing layer

Override Modes

Dynamic Value

The dynamic value override method allows you to dynamically create a value based on values of other variables.

A simple example for this could be assigning to opacity of a layer to be the health of a player, so it appears to fade in as the health lowers, showing a red warning when your character is close to death. A more complex example could be constructing a color based on the current time, with seconds being red, minutes green and hours blue. Whether you’d actually want this who knows, but it’s possible with this override technique.

Basic example of a dynamic value being used with opacity to make the layer flash in and then fade out

Depending on the type of property being edited, you will be asked to provide one or more expressions of different types. Descriptions of these expressions are available in the “Reference: Expression Types” section of the guide. For example, the “Enabled” property will require a boolean expression and “Opacity” will require a numeric expression.

Lookup Table

The lookup table is a list of condition-value pairs. When using this override technique, Aurora will evaluate the boolean condition expression of each item in the list until it finds one that is true. When it does so, it will override the requested property with the value of the pair.

Example lookup table that sets the color to red every once every three seconds

If you are familiar with the concept of programming, you can think of a lookup table as being like a switch statement or a collection of if else if blocks.

Demos

This profile contains a single solid fill layer that fades in and out every second, each second alternating between red, green and blue.

The demo layer running

You can download the demo profile here.

Page authored by
\ No newline at end of file diff --git a/advanced-topics/state-variables/index.html b/advanced-topics/state-variables/index.html index c64c449..cbbcd34 100644 --- a/advanced-topics/state-variables/index.html +++ b/advanced-topics/state-variables/index.html @@ -1,4 +1,4 @@ State Variables • advanced-topics • Aurora Docs
-Aurora User Docs

State Variables


Last updated 10.01.2024

What are State Variables?

State Variables are numeric, boolean (true/false) or string (sequence of letters) values that can be obtained and dynamically updated by Aurora as it is running. Layers such as the Percent Effect Layer or the Animation Layer can make use of these values to conditionally set the lights on the keyboard. The values depend on which profile is currently in use, for example the CSGO profile contains State Variables for health, current ammo, max ammo, etc. but these specific ones do not work for other profiles such as Minecraft.

Not all game profiles that come with Aurora have State Integration, and currently custom added profiles also do not support State Variables.

There are some State Variables that are operating system-wide (such as RAM/CPU usage and time values) and these are always available to use, regardless of the application a profile is on.

How do you use State Variables?

Any layers that support the use of State Variables will present you with a drop down box allowing you to select a State Variable from the current application profile.

An example of a drop down containing a list of State Variables for Minecraft

Note that in most circumstances, the drop down list is editable you are able to type a number into the field to use that instead of referencing a State Variable.

Another use for State Variables is in the Overrides System. This system allows you to override property values of the layers when certain conditions are met. These conditions can be based on State Variables, such as showing a layer when your health is less than 25%.

Page authored by
\ No newline at end of file +Aurora User Docs

State Variables


Last updated 10.01.2024

What are State Variables?

State Variables are numeric, boolean (true/false) or string (sequence of letters) values that can be obtained and dynamically updated by Aurora as it is running. Layers such as the Percent Effect Layer or the Animation Layer can make use of these values to conditionally set the lights on the keyboard. The values depend on which profile is currently in use, for example the CSGO profile contains State Variables for health, current ammo, max ammo, etc. but these specific ones do not work for other profiles such as Minecraft.

Not all game profiles that come with Aurora have State Integration, and currently custom added profiles also do not support State Variables.

There are some State Variables that are operating system-wide (such as RAM/CPU usage and time values) and these are always available to use, regardless of the application a profile is on.

How do you use State Variables?

Any layers that support the use of State Variables will present you with a drop down box allowing you to select a State Variable from the current application profile.

An example of a drop down containing a list of State Variables for Minecraft

Note that in most circumstances, the drop down list is editable you are able to type a number into the field to use that instead of referencing a State Variable.

Another use for State Variables is in the Overrides System. This system allows you to override property values of the layers when certain conditions are met. These conditions can be based on State Variables, such as showing a layer when your health is less than 25%.

Page authored by
\ No newline at end of file diff --git a/advanced-topics/visualizer-output/index.html b/advanced-topics/visualizer-output/index.html index 08eabbb..df81893 100644 --- a/advanced-topics/visualizer-output/index.html +++ b/advanced-topics/visualizer-output/index.html @@ -2,10 +2,10 @@
Aurora User Docs

Audio Visualizer Tweaks


Last updated 10.01.2024

The Audio Visualizer layer allows you to display a representation of whatever you’re listening to on your RGB devices.

Isolating applications

Why

One of the things that annoys me about the layer is that every single sound your computer emits will be shown on the keyboard, which isn’t very useful or appealing if you’re talking to someone on Discord for example. So I found a way to isolate a single application (in my case, Spotify) in the same audio output as Aurora.

This makes it so only sound emitted by Spotify is processed and displayed on the keyboard, and does make the visualization change if you change the volume of the music.

Prerequisites

  • Windows 19 build 1809 or above

    • Aurora doesn’t let you pick the audio output device yet. Windows now has a menu where you can force an application to use an output and input device of your choosing.

  • Virtual Audio Cable

    • We need this so we can listen to 2 output devices at once: The default output every application should emit to, and the virtual audio cable we need for Aurora’s visualizer.

How

  1. Open the Windows Settings app (Win + i). -Windows settings app
  2. Click the System button, then select the Sound tab. -Windows Sound tab
  3. Scroll down to the bottom and click “App volume and device preferences”. -App volume and device preferences
  4. Set both Aurora’s and whatever other application you want to be visible’s Output to “CABLE Input”. Then Input option does not need to be changed for this. -App Volumes
  5. Open the legacy Sound settings window. The easiest way is through Control Panel -> Icons view. -Control Panel
  6. Choose the Recording Tab and double-click “CABLE Output”. Select the Listen Tab.
  7. Tick “Listen to this device” and choose your headphones/speakers. You should now be able to listen to music! -Cable Output Properties

(Optional) Install Ear Trumpet from the Windows Store to more easily change the volume of Spotify. This method works best if you leave Spotify’s volume at 100% and adjust using the windows mixer instead. This way, Aurora sees every song at the same volume at all times, producing a more consistent effect. -Ear Trumpet

Page authored by
\ No newline at end of file +Windows settings app
  • Click the System button, then select the Sound tab. +Windows Sound tab
  • Scroll down to the bottom and click “App volume and device preferences”. +App volume and device preferences
  • Set both Aurora’s and whatever other application you want to be visible’s Output to “CABLE Input”. Then Input option does not need to be changed for this. +App Volumes
  • Open the legacy Sound settings window. The easiest way is through Control Panel -> Icons view. +Control Panel
  • Choose the Recording Tab and double-click “CABLE Output”. Select the Listen Tab.
  • Tick “Listen to this device” and choose your headphones/speakers. You should now be able to listen to music! +Cable Output Properties

    • (Optional) Install Ear Trumpet from the Windows Store to more easily change the volume of Spotify. This method works best if you leave Spotify’s volume at 100% and adjust using the windows mixer instead. This way, Aurora sees every song at the same volume at all times, producing a more consistent effect. +Ear Trumpet

    Page authored by \ No newline at end of file diff --git a/basic-topics/getting-started/index.html b/basic-topics/getting-started/index.html index c50f122..355c31e 100644 --- a/basic-topics/getting-started/index.html +++ b/basic-topics/getting-started/index.html @@ -2,5 +2,5 @@
    Aurora User Docs

    Getting Started


    Last updated 10.01.2024

    When you first open Aurora, you will be presented with a window that looks like the following. -Annotated picture of the main Aurora UI

    Applications

    On the far left is the application list, with each application shown as an icon. All the applications and games you will see here by default have some sort of integration or preset profile. You are not limited to just these ones however; by scrolling to the bottom of the list and clicking the plus icon you will be able to specify new applications either by selecting from the running process list or by browsing to the exe. You can disable applications if you don’t want your lighting changing when you open that app by going onto the overview and un-checking the “Enable Aurora to provide lighting effects…” box. You can also right-click on the application icons to hide them if you do not have that game and don’t want it cluttering up the list.

    Aurora works by detecting the application that is currently focused and checking if it has an application entry for that application. If it does, it will render the active profile (we’ll see what a profile is in the next section) to your peripherals. If it does not, it will render the “Desktop” application’s selected profile. -Each application can have one or more profiles, and each profile can have as many layers as you wish

    Profiles

    Profiles are a collection of layers that will be drawn to the keyboard whenever that application is currently open (and in the foreground). An application can have one or more profiles, but only one profile can be active at once. You can assign keys to each profile allowing you to switch between them when a specific button is pressed.

    To view the profiles for the currently selected application, click on the “Profiles” button in the list view buttons near the top left of the window. The list below this button will then show you all the profiles of the application. From here you can:

    • Add a new profile by clicking the “Add” button.
    • Delete profiles by clicking the red “X” button.
    • Import a profile from .cueprofile or .json file.
    • Export your profile as a .json file.
    • Copy/paste profiles to duplicate them or add them to another application.
    • Reset the profile to the default state.
    • Rename a profile by clicking on it, then typing a name in the “Profile name” box in the properties panel
    • Assign a key to select a profile by clicking on it, then clicking “Assign” next to “Keybind to active profile” in the properties panel then pressing the keys on your keyboard you want.

    Layers

    A Layer is an instruction for Aurora to set the color of some specific keys on your keyboard. Each layer has different functionality which is detailed in a later section of this guide. The layers are drawn from bottom-to-top, therefore anything higher up the list will take priority over the colors of anything lower down.

    Annoted picture of the Layer controls

    To show the layers list, click the “Layers” list view button that will be at the top left or bottom left of the window (depending on whether the profile list is open or not). A list will appear below this button showing you all your layers. From here you can:

    • Add new layers by clicking on the “Add” button above the layer list.
    • Select a layer and press the copy and paste buttons (or press Ctrl + C, Ctrl + V) to duplicate it or copy it to another profile.
    • Change the layer properties by clicking on a layer and using the properties panel.
    • Delete the layer by selecting it and clicking the red “X” button.
    • Re-order layers by clicking and dragging the triple horizontal line (burger) button next to the layer.

    Overlay Layers

    Overlay layers are different from regular layers in that they appear whenever a particular process is running (or in the case of desktop overlay layers, always). For example, if you create a profile for Spotify and add a audio visualizer as an overlay, the visualizer will always appear whenever Spotify is open, regardless of whether you have it in the foreground or not.

    Note that the layers and overlay layers for a profile can be enabled/disabled independently. With the Spotify example, if you disable the regular layers for the profile but keep the overlay layers, your desktop profile will stay active when Spotify is in the foreground instead of going blank with only the overlay layers.

    Layer Properties

    Each layer will have a set of properties that you can change such as color or the keys it affects. This can be changed in the bottom right panel, the Properties Panel. The properties available to each layer are listed in the reference section of this guide that can be accessed in the navigation list.

    Page authored by
    \ No newline at end of file +Annotated picture of the main Aurora UI

    Applications

    On the far left is the application list, with each application shown as an icon. All the applications and games you will see here by default have some sort of integration or preset profile. You are not limited to just these ones however; by scrolling to the bottom of the list and clicking the plus icon you will be able to specify new applications either by selecting from the running process list or by browsing to the exe. You can disable applications if you don’t want your lighting changing when you open that app by going onto the overview and un-checking the “Enable Aurora to provide lighting effects…” box. You can also right-click on the application icons to hide them if you do not have that game and don’t want it cluttering up the list.

    Aurora works by detecting the application that is currently focused and checking if it has an application entry for that application. If it does, it will render the active profile (we’ll see what a profile is in the next section) to your peripherals. If it does not, it will render the “Desktop” application’s selected profile. +Each application can have one or more profiles, and each profile can have as many layers as you wish

    Profiles

    Profiles are a collection of layers that will be drawn to the keyboard whenever that application is currently open (and in the foreground). An application can have one or more profiles, but only one profile can be active at once. You can assign keys to each profile allowing you to switch between them when a specific button is pressed.

    To view the profiles for the currently selected application, click on the “Profiles” button in the list view buttons near the top left of the window. The list below this button will then show you all the profiles of the application. From here you can:

    Layers

    A Layer is an instruction for Aurora to set the color of some specific keys on your keyboard. Each layer has different functionality which is detailed in a later section of this guide. The layers are drawn from bottom-to-top, therefore anything higher up the list will take priority over the colors of anything lower down.

    Annoted picture of the Layer controls

    To show the layers list, click the “Layers” list view button that will be at the top left or bottom left of the window (depending on whether the profile list is open or not). A list will appear below this button showing you all your layers. From here you can:

    Overlay Layers

    Overlay layers are different from regular layers in that they appear whenever a particular process is running (or in the case of desktop overlay layers, always). For example, if you create a profile for Spotify and add a audio visualizer as an overlay, the visualizer will always appear whenever Spotify is open, regardless of whether you have it in the foreground or not.

    Note that the layers and overlay layers for a profile can be enabled/disabled independently. With the Spotify example, if you disable the regular layers for the profile but keep the overlay layers, your desktop profile will stay active when Spotify is in the foreground instead of going blank with only the overlay layers.

    Layer Properties

    Each layer will have a set of properties that you can change such as color or the keys it affects. This can be changed in the bottom right panel, the Properties Panel. The properties available to each layer are listed in the reference section of this guide that can be accessed in the navigation list.

    Page authored by \ No newline at end of file diff --git a/basic-topics/index.xml b/basic-topics/index.xml index a2eff93..f72e600 100644 --- a/basic-topics/index.xml +++ b/basic-topics/index.xml @@ -21,7 +21,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/overview.png?v=1bbe94f77e78d95af98555f206db5668" alt="Annotated picture of the main Aurora UI" loading="lazy" height="714" width="1000" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/overview.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Annotated picture of the main Aurora UI" loading="lazy" height="714" width="1000" /> </picture> </p> <h1 id="applications">Applications</h1> @@ -46,6 +46,8 @@ <li>Terraria</li> <li>Rocket League</li> </ul> -<p>See <a href="https://github.com/Aurora-RGB/Aurora/wiki/Supported-Devices">Wiki</a> for details, as some models can be incompatible.</p>User Datahttps://www.project-aurora.com/Docs/basic-topics/user-data/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/basic-topics/user-data/<p>Aurora stores all user data in a directory in the roaming application data folder. This user data includes all your settings (such as preferred devices, bitmap accuracy, etc) as well as all your lighting profiles and recent logs that Aurora has created. You can see the Aurora folder by navigating to <code>%APPDATA%\Aurora</code> in Windows file explorer.</p> +<p>See <a href="https://github.com/Aurora-RGB/Aurora/wiki/Supported-Devices">Wiki</a> for details, as some models can be incompatible.</p>User Datahttps://www.project-aurora.com/Docs/basic-topics/user-data/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/basic-topics/user-data/<p>You can see the Aurora data by navigating to <code>%APPDATA%\Aurora</code> in File Explorer. +This user data includes all your settings as well as all your lighting profiles and recent logs that Aurora has created.</p> <h1 id="importing-profiles">Importing Profiles</h1> -<p>Profiles that others have made can be imported easily into Aurora using the import button on the &ldquo;Profiles&rdquo; section. Pressing this button will open a dialog asking you to choose a file to import. JSON files that have been exported from Aurora (see <a href="#exporting-profiles">exporting profiles</a>) are fully supported through import. In addition, Aurora has partial support for implementing iCUE profiles, however due to the nature of it being a different program with different layers and formats, imported profiles may not look identical.</p> \ No newline at end of file +<p>Profiles that others have made can be imported easily into Aurora using the import button on the &ldquo;Profiles&rdquo; section. Pressing this button will open a dialog asking you to choose a file to import. +JSON files that have been exported from Aurora (see <a href="#exporting-profiles">exporting profiles</a>) are fully supported through import.</p> \ No newline at end of file diff --git a/basic-topics/installation/index.html b/basic-topics/installation/index.html index 5c79054..62a6550 100644 --- a/basic-topics/installation/index.html +++ b/basic-topics/installation/index.html @@ -1,4 +1,4 @@ Installation • basic-topics • Aurora Docs
    -Aurora User Docs

    Installation


    Last updated 16.01.2024

    To install Aurora, the easiest way is to download the installer from our GitHub page and simply run it.

    After this, you will find Aurora in your start menu. Opening the Aurora program will show you some simple steps you will need to take with detected existing RGB to allow Aurora to take priority when it needs to. It’s important you follows these steps otherwise Aurora may not work correctly.

    Dev Version

    The Aurora software is constantly evolving thanks to submissions from various contributors. Before these changes hit the main release, they are added to a special “dev” version of Aurora (after being bug-tested).

    If you would like to, it is possible to download the dev version to access some new additional features and bug fixes.

    Other Versions

    Since there are several contributors contributing to Aurora, there are several different branches of Aurora. A developer will often ask their branch to be tested by users, either through Discord or on a Pull Request on GitHub.

    Because of all the separate versions with different functionality, it is advisable NOT to install these versions using the exe, but instead to download the zip file and extract them to a place other than your main Aurora installation. Like with the dev version, it’s highly recommended to backup profiles and settings.

    Downloading a GitHub Pull Request

    A pull request is where a developer has made changes to Aurora and would like to merge these into the main Aurora release. These pull requests will contain a description of exactly what changes have been made and will automatically create a build of that version. This version will likely be based on a recent dev version of Aurora (as opposed to the main version).

    Once you have found a Pull Request you wish to download and test, you should be presented with a screen such as this.

    PR GitHub page

    Scroll down until you find a section with green ticks (a maybe red crosses). There should be an item that says “All checks have passed”. Next to this item, click on “Show all checks” button to reveal a small panel below this item. Click on the “Details” link. If you do not have an “All checks have passed” option, the automatic build process has failed and you will not be able to download a pre-built version.

    The panel that will take you to the build artefacts

    You should be taken to the website “AppVeyor” and should see a large blue block of text. Just above this text, click the “Artifacts” tab, and you will be presented with the built installer and ZIP file for that PR.

    The download link for the artefacts

    Page authored by
    \ No newline at end of file +Aurora User Docs

    Installation


    Last updated 16.01.2024

    To install Aurora, the easiest way is to download the installer from our GitHub page and simply run it.

    After this, you will find Aurora in your start menu. Opening the Aurora program will show you some simple steps you will need to take with detected existing RGB to allow Aurora to take priority when it needs to. It’s important you follows these steps otherwise Aurora may not work correctly.

    Dev Version

    The Aurora software is constantly evolving thanks to submissions from various contributors. Before these changes hit the main release, they are added to a special “dev” version of Aurora (after being bug-tested).

    If you would like to, it is possible to download the dev version to access some new additional features and bug fixes.

    Other Versions

    Since there are several contributors contributing to Aurora, there are several different branches of Aurora. A developer will often ask their branch to be tested by users, either through Discord or on a Pull Request on GitHub.

    Because of all the separate versions with different functionality, it is advisable NOT to install these versions using the exe, but instead to download the zip file and extract them to a place other than your main Aurora installation. Like with the dev version, it’s highly recommended to backup profiles and settings.

    Downloading a GitHub Pull Request

    A pull request is where a developer has made changes to Aurora and would like to merge these into the main Aurora release. These pull requests will contain a description of exactly what changes have been made and will automatically create a build of that version. This version will likely be based on a recent dev version of Aurora (as opposed to the main version).

    Once you have found a Pull Request you wish to download and test, you should be presented with a screen such as this.

    PR GitHub page

    Scroll down until you find a section with green ticks (a maybe red crosses). There should be an item that says “All checks have passed”. Next to this item, click on “Show all checks” button to reveal a small panel below this item. Click on the “Details” link. If you do not have an “All checks have passed” option, the automatic build process has failed and you will not be able to download a pre-built version.

    The panel that will take you to the build artefacts

    You should be taken to the website “AppVeyor” and should see a large blue block of text. Just above this text, click the “Artifacts” tab, and you will be presented with the built installer and ZIP file for that PR.

    The download link for the artefacts

    Page authored by
    \ No newline at end of file diff --git a/basic-topics/user-data/index.html b/basic-topics/user-data/index.html index 97d51dd..c563178 100644 --- a/basic-topics/user-data/index.html +++ b/basic-topics/user-data/index.html @@ -1,4 +1,13 @@ -User Data • basic-topics • Aurora Docs +Aurora User Data Folder • Aurora Docs
    -Aurora User Docs

    User Data


    Last updated 10.01.2024

    Aurora stores all user data in a directory in the roaming application data folder. This user data includes all your settings (such as preferred devices, bitmap accuracy, etc) as well as all your lighting profiles and recent logs that Aurora has created. You can see the Aurora folder by navigating to %APPDATA%\Aurora in Windows file explorer.

    Importing Profiles

    Profiles that others have made can be imported easily into Aurora using the import button on the “Profiles” section. Pressing this button will open a dialog asking you to choose a file to import. JSON files that have been exported from Aurora (see exporting profiles) are fully supported through import. In addition, Aurora has partial support for implementing iCUE profiles, however due to the nature of it being a different program with different layers and formats, imported profiles may not look identical.

    When importing a profile, a new profile will appear in the profile list - you do not need to worry about it overwriting the profile you currently have selected. If you wish to merge the imported profile with an existing one you have, you can select the layers from one profile and copy and paste them using the relevant buttons or by pressing the Ctrl + C and Ctrl + V keys on the keyboard.

    Exporting Profiles

    If you have created a profile that you wish to share with other people, you can easily export it by clicking the export button on the “Profiles” section. Clicking this button will open a window where you will be asked to save the profile as a JSON file. This JSON file can then be sent to other people who can import it into Aurora using the method described above. There is no way to export Aurora profiles into other applications such as LGS or iCUE.

    Taking a Backup

    There may be times when it would be wise to take a backup of your entire Aurora data folder (for example when you are installing a test build of Aurora). Doing this is a very simple matter of duplicating a folder.

    1. First, open up Windows file explorer.
    2. In the address bar, type %APPDATA% and press enter. This will take you to the folder where various installed programs can store data for your user account.
    3. There will be a folder called “Aurora” in here. Simply copy that folder to a different location (for example your Documents).

    Finding the Aurora user data directory

    1. Should you need to restore data that’s been backed up in future, you can simply replace the sane Aurora direction with the backup folder.

    Clearing User Data

    Clearing your user data may be required if you start using test versions of Aurora or need to downgrade your Aurora installation for whatever reason. To do this, you can simply delete (or rename/move if you intend to reuse to this data some time) the Aurora folder.

    1. First, ensure that you have closed Aurora. Deleting data while Aurora is running may cause it to crash. Additionally, Aurora will write some data to it’s user data folder when it closes.
    2. Next, open up Windows file explorer and in the address bar, type %APPDATA% and press enter. This will take you to the roaming application data folder.
    3. There will be a folder called “Aurora” in here. Simply delete, move or rename that folder.
    4. When you next re-open Aurora, it will recreate all the necessary data with the default configuration: default settings, default profiles, etc.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    User Data


    Last updated 02.10.2024

    You can see the Aurora data by navigating to %APPDATA%\Aurora in File Explorer. +This user data includes all your settings as well as all your lighting profiles and recent logs that Aurora has created.

    Importing Profiles

    Profiles that others have made can be imported easily into Aurora using the import button on the “Profiles” section. Pressing this button will open a dialog asking you to choose a file to import. +JSON files that have been exported from Aurora (see exporting profiles) are fully supported through import.

    When importing a profile, a new profile will appear in the profile list - you do not need to worry about it overwriting the profile you currently have selected. +If you wish to merge the imported profile with an existing one you have, +you can select the layers from one profile and copy and paste them using the relevant buttons or by pressing the Ctrl + C and Ctrl + V keys on the keyboard.

    Exporting Profiles

    If you have created a profile that you wish to share with other people, you can easily export it by clicking the export button on the “Profiles” section. +Clicking this button will open a window where you will be asked to save the profile as a JSON file. +This JSON file can then be sent to other people who can import it into Aurora using the method described above.

    Automatic Backups

    Aurora creates new backup with each update at %APPDATA%/AuroraBackups. +You can restore them by

    1. Removing %APPDATA%\Aurora folder
    2. Moving the version file to %appdata% and renaming it to Aurora

    Taking a Backup

    There may be times when it would be wise to take a backup of your entire Aurora data folder (for example when you are installing a test build of Aurora). +Doing this is a very simple matter of duplicating a folder.

    1. First, open up Windows file explorer.

    2. In the address bar, type %APPDATA% and press enter. This will take you to the folder where various installed programs can store data for your user account.

    3. There will be a folder called “Aurora” in here. Simply copy that folder to a different location (for example your Documents).

      Finding the Aurora user data directory

    4. Should you need to restore data that’s been backed up in the future, you can simply replace the same Aurora direction with the backup folder.

    Clearing User Data

    Clearing your user data may be required if you start using test versions of Aurora or need to downgrade your Aurora installation for whatever reason. +To do this, you can simply delete (or rename/move if you intend to reuse to this data some time) the Aurora folder.

    1. First, ensure that you have closed Aurora. Aurora will write back some data from memory when it closes.
    2. Next, open up Windows file explorer and in the address bar, type %APPDATA% and press enter. This will take you to the roaming application data folder.
    3. There will be a folder called “Aurora” in here. Simply delete, move or rename that folder.
    4. When you next re-open Aurora, it will recreate all the necessary data with the default configuration: default settings, default profiles, etc.
    Page authored by
    \ No newline at end of file diff --git a/devices/corsair/index.html b/devices/corsair/index.html index 21b0458..2456e7d 100644 --- a/devices/corsair/index.html +++ b/devices/corsair/index.html @@ -1,4 +1,4 @@ Corsair • devices • Aurora Docs
    -Aurora User Docs

    Corsair


    Last updated 27.01.2024

    You can use Aurora profiles and brand specific integrations (like Chroma and Lightsync) with Corsair devices using Aurora.

    Required Software

    • Corsair iCUE

    Needed configuration

    The SDK should come enabled by default when you install iCUE, but in case it doesn’t connect, make sure it is enabled.

    Turning on the SDK in Corsair iCUE

    Supported Devices

    All devices that a version of iCUE is supported.

    Page authored by
    \ No newline at end of file +Aurora User Docs

    Corsair


    Last updated 27.01.2024

    You can use Aurora profiles and brand specific integrations (like Chroma and Lightsync) with Corsair devices using Aurora.

    Required Software

    • Corsair iCUE

    Needed configuration

    The SDK should come enabled by default when you install iCUE, but in case it doesn’t connect, make sure it is enabled.

    Turning on the SDK in Corsair iCUE

    Supported Devices

    All devices that a version of iCUE is supported.

    Page authored by
    \ No newline at end of file diff --git a/devices/index.xml b/devices/index.xml index ab2b6ba..3e60fa0 100644 --- a/devices/index.xml +++ b/devices/index.xml @@ -61,7 +61,7 @@ To change this behaviour, you must open the Aurora settings, get to the &ldq <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/icue-enable-sdk.png?v=1bbe94f77e78d95af98555f206db5668" alt="Turning on the SDK in Corsair iCUE" loading="lazy" height="811" width="1280" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/icue-enable-sdk.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Turning on the SDK in Corsair iCUE" loading="lazy" height="811" width="1280" /> </picture> </p> <h1 id="supported-devices">Supported Devices</h1> @@ -106,7 +106,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/ghub-enable-sdk.png?v=1bbe94f77e78d95af98555f206db5668" alt="Turning on the SDK in Logitech G HUB" loading="lazy" height="792" width="1138" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/ghub-enable-sdk.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Turning on the SDK in Logitech G HUB" loading="lazy" height="792" width="1138" /> </picture> </p> <h2 id="for-lgs">For LGS:</h2> @@ -135,7 +135,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/lgs-enable-sdk-1.png?v=1bbe94f77e78d95af98555f206db5668" alt="Opening Settings in Logitech Gaming Software" loading="lazy" height="750" width="1006" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/lgs-enable-sdk-1.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Opening Settings in Logitech Gaming Software" loading="lazy" height="750" width="1006" /> </picture> </p>OpenRGBhttps://www.project-aurora.com/Docs/devices/openrgb/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/devices/openrgb/<h1 id="required-software">Required Software</h1> <p><a href="https://openrgb.org/">OpenRGB</a></p> @@ -184,7 +184,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/enable-sse-app.png?v=1bbe94f77e78d95af98555f206db5668" alt="Enabling custom app in SSE3" loading="lazy" height="1040" width="1920" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/enable-sse-app.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Enabling custom app in SSE3" loading="lazy" height="1040" width="1920" /> </picture> </p> <p>If you still cannot control your keyboard or mouse illumination, check if Color Special Event is enabled in Aurora applet in SSE.</p> @@ -210,7 +210,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/sse-special-event.png?v=1bbe94f77e78d95af98555f206db5668" alt="Color Special Event in Aurora applet" loading="lazy" height="1040" width="1920" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/sse-special-event.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Color Special Event in Aurora applet" loading="lazy" height="1040" width="1920" /> </picture> </p> <h1 id="known-issues">Known Issues</h1> diff --git a/devices/logitech/index.html b/devices/logitech/index.html index 60c1149..5093eba 100644 --- a/devices/logitech/index.html +++ b/devices/logitech/index.html @@ -1,6 +1,6 @@ Logitech • devices • Aurora Docs
    -Aurora User Docs

    Logitech


    Last updated 27.01.2024

    You can use Aurora profiles and brand specific integrations (like Chroma) with Logitech devices using Aurora.

    Required Software

    One of:

    • Logitech Gaming Software 9.02.65+
    • Logitech G Hub

    Needed configuration

    The SDK should come enabled by default when you install LGS or GHUB, but in case it doesn’t connect, make sure it is enabled.

    For GHUB:

    Turning on the SDK in Logitech G HUB

    For LGS:

    1. Open Logitech Gaming Software and go into Settings

    Opening Settings in Logitech Gaming Software

    1. Enable Game Integration Settings

    Enabling Game Integration Settings in Logitech Gaming Software

    1. Open the Game Integration Configuration menu

    Opening the Game Integration Menu in Logitech Gaming Software

    1. Disable Conflicting Settings and Applets

    Disabling CS:GO in Logitech Gaming Software -Disabling DotA2 in Logitech Gaming Software

    Known issues

    Logitech device integration does not work when Lightsync Wrapper is enabled

    • Lightsync wrapper will be automatically disabled if Logitech software autorun is detected. -If you want to use Logitech devices with other brands and have Lightsync integration on all devices, you have to replace Logitech software with OpenRGB

    • G HUB can take a very long time to fully open and start receiving SDK requests. Because of this, on some systems Aurora tries to connect to G HUB before it has the chance to completely start. This causes any following connections to fail until both G HUB and Aurora are restarted. This can be fixed on boot by adding a delay to the task Aurora uses to startup. This can be done in the General Settings:

    Adding a delay to Aurora’s startup task

    • Sometimes G HUB will only display Aurora’s lighting when the window is open on the foreground. To fix this, setting the desktop profile to permanent may be needed.

    Setting the desktop profile as the persistent one in GHUB

    Supported Devices

    Keyboards

    All per-key RGB keyboards are supposed to work. These are confirmed keyboards:

    • G910
    • G410
    • G810
    • GPRO
    • G815
    • G513

    Mice

    All mice are supposed to work, these are confirmed mice:

    • G900
    • G502

    Mousepads

    Most other Logitech LIGHTSYNC devices should work fine, even if they don't have a layout available in Aurora. Simply choose a keyboard with the same layout!

    Page authored by
    \ No newline at end of file +Aurora User Docs

    Logitech


    Last updated 27.01.2024

    You can use Aurora profiles and brand specific integrations (like Chroma) with Logitech devices using Aurora.

    Required Software

    One of:

    • Logitech Gaming Software 9.02.65+
    • Logitech G Hub

    Needed configuration

    The SDK should come enabled by default when you install LGS or GHUB, but in case it doesn’t connect, make sure it is enabled.

    For GHUB:

    Turning on the SDK in Logitech G HUB

    For LGS:

    1. Open Logitech Gaming Software and go into Settings

    Opening Settings in Logitech Gaming Software

    1. Enable Game Integration Settings

    Enabling Game Integration Settings in Logitech Gaming Software

    1. Open the Game Integration Configuration menu

    Opening the Game Integration Menu in Logitech Gaming Software

    1. Disable Conflicting Settings and Applets

    Disabling CS:GO in Logitech Gaming Software +Disabling DotA2 in Logitech Gaming Software

    Known issues

    Logitech device integration does not work when Lightsync Wrapper is enabled

    • Lightsync wrapper will be automatically disabled if Logitech software autorun is detected. +If you want to use Logitech devices with other brands and have Lightsync integration on all devices, you have to replace Logitech software with OpenRGB

    • G HUB can take a very long time to fully open and start receiving SDK requests. Because of this, on some systems Aurora tries to connect to G HUB before it has the chance to completely start. This causes any following connections to fail until both G HUB and Aurora are restarted. This can be fixed on boot by adding a delay to the task Aurora uses to startup. This can be done in the General Settings:

    Adding a delay to Aurora’s startup task

    • Sometimes G HUB will only display Aurora’s lighting when the window is open on the foreground. To fix this, setting the desktop profile to permanent may be needed.

    Setting the desktop profile as the persistent one in GHUB

    Supported Devices

    Keyboards

    All per-key RGB keyboards are supposed to work. These are confirmed keyboards:

    • G910
    • G410
    • G810
    • GPRO
    • G815
    • G513

    Mice

    All mice are supposed to work, these are confirmed mice:

    • G900
    • G502

    Mousepads

    Most other Logitech LIGHTSYNC devices should work fine, even if they don't have a layout available in Aurora. Simply choose a keyboard with the same layout!

    Page authored by
    \ No newline at end of file diff --git a/devices/steelseries/index.html b/devices/steelseries/index.html index b78e1ba..d5b2800 100644 --- a/devices/steelseries/index.html +++ b/devices/steelseries/index.html @@ -1,4 +1,4 @@ SteelSeries • devices • Aurora Docs
    -Aurora User Docs

    SteelSeries


    Last updated 10.01.2024

    Required Software

    One of:

    • SteelSeries Engine 3
    • OpenRGB

    Needed configuration

    The SDK should be enabled by default, but in case it’s not, make sure the ‘Project Aurora’ custom application is enabled.

    Enabling custom app in SSE3

    If you still cannot control your keyboard or mouse illumination, check if Color Special Event is enabled in Aurora applet in SSE.

    Color Special Event in Aurora applet

    Known Issues

    Devices with number of zones other than 1, 2 or 12 are not fully supported (ex. Rival 600) - they may still work but not all zones can be controlled.

    Supported Devices

    Most devices supported by SteelSeries Engine. Notable exceptions are zone based keyboards like Apex M350 or Apex 3.

    Page authored by
    \ No newline at end of file +Aurora User Docs

    SteelSeries


    Last updated 10.01.2024

    Required Software

    One of:

    • SteelSeries Engine 3
    • OpenRGB

    Needed configuration

    The SDK should be enabled by default, but in case it’s not, make sure the ‘Project Aurora’ custom application is enabled.

    Enabling custom app in SSE3

    If you still cannot control your keyboard or mouse illumination, check if Color Special Event is enabled in Aurora applet in SSE.

    Color Special Event in Aurora applet

    Known Issues

    Devices with number of zones other than 1, 2 or 12 are not fully supported (ex. Rival 600) - they may still work but not all zones can be controlled.

    Supported Devices

    Most devices supported by SteelSeries Engine. Notable exceptions are zone based keyboards like Apex M350 or Apex 3.

    Page authored by
    \ No newline at end of file diff --git a/index.html b/index.html index 87744fa..e68dcff 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ Introduction • Aurora Docs
    -Aurora User Docs
    \ No newline at end of file +Aurora User Docs
    \ No newline at end of file diff --git a/index.xml b/index.xml index a9eb717..1d0ee5a 100644 --- a/index.xml +++ b/index.xml @@ -49,7 +49,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-ambilight.png?v=1bbe94f77e78d95af98555f206db5668" alt="Ambilight Layer in use on a dual-monitor setup with a white background on one and blue on the other" loading="lazy" height="241" width="725" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-ambilight.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Ambilight Layer in use on a dual-monitor setup with a white background on one and blue on the other" loading="lazy" height="241" width="725" /> </picture> </p>    Animation Editorhttps://www.project-aurora.com/Docs/advanced-topics/animation-editor/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/advanced-topics/animation-editor/<p>The <a href="https://www.project-aurora.com/Docs/reference-layers/animation/">Animation Layer</a> allows you to add your own custom animated effects to your peripheral lights. To edit this animation, the Animation Editor used. This is a powerful tool, and fairly easy to use once you understand how it works. As with all unfamiliar things however, it may be daunting at first.</p> <h1 id="concepts-and-definitions">Concepts and Definitions</h1> @@ -88,7 +88,7 @@ To change this behaviour, you must open the Aurora settings, get to the &ldq <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-equalizer.gif?v=1bbe94f77e78d95af98555f206db5668" alt="An equalizer layer in gradient mode while playing a music track" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-equalizer.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="An equalizer layer in gradient mode while playing a music track" loading="lazy" height="288" width="866" /> </picture> </p>Audio Visualizer Tweakshttps://www.project-aurora.com/Docs/advanced-topics/visualizer-output/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/advanced-topics/visualizer-output/<p>The Audio Visualizer layer allows you to display a representation of whatever you&rsquo;re listening to on your RGB devices.</p> <h1 id="isolating-applications">Isolating applications</h1> @@ -116,7 +116,7 @@ To change this behaviour, you must open the Aurora settings, get to the &ldq <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-blinking.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A blinking layer with cyan and a random secondary color" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-blinking.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A blinking layer with cyan and a random secondary color" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -155,6 +155,12 @@ To change this behaviour, you must open the Aurora settings, get to the &ldq </tbody> </table>Brand Integrationshttps://www.project-aurora.com/Docs/integrations/integrations/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/integrations/integrations/<p>Some of the brand specific game integrations are reverse-engineered to work with Aurora. See their pages to see how they are configured.</p> +<h2 id="game-integrations-aurora-supports">Game Integrations Aurora Supports</h2> +<ul> +<li><a href="https://www.project-aurora.com/Docs/integrations/chroma/">Chroma</a></li> +<li><a href="https://www.project-aurora.com/Docs/integrations/lightsync/">Lightsync</a></li> +<li><a href="https://www.project-aurora.com/Docs/integrations/lightfx/">LightFX</a></li> +</ul> <p><a href="https://www.pcgamingwiki.com/wiki/RGB_lighting_middleware">PCGamingWiki page about integrations</a></p>Breathing Layerhttps://www.project-aurora.com/Docs/reference-layers/breathing/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/breathing/<p>The breathing layer fades the colors of the specified keys between two colors. In that regard it is similar to the Gradient Fill Layer, however this layer also allows the colors to be randomized, so that the keyboard fades between unpredictable colors.</p> <p> @@ -178,7 +184,7 @@ See their pages to see how they are configured.</p> <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-breathing.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A breathing layer with two random colors" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-breathing.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A breathing layer with two random colors" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -246,7 +252,7 @@ See their pages to see how they are configured.</p> <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/icue-enable-sdk.png?v=1bbe94f77e78d95af98555f206db5668" alt="Turning on the SDK in Corsair iCUE" loading="lazy" height="811" width="1280" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/icue-enable-sdk.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Turning on the SDK in Corsair iCUE" loading="lazy" height="811" width="1280" /> </picture> </p> <h1 id="supported-devices">Supported Devices</h1> @@ -282,7 +288,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/overview.png?v=1bbe94f77e78d95af98555f206db5668" alt="Annotated picture of the main Aurora UI" loading="lazy" height="714" width="1000" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/overview.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Annotated picture of the main Aurora UI" loading="lazy" height="714" width="1000" /> </picture> </p> <h1 id="applications">Applications</h1> @@ -309,7 +315,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-glitch.gif?v=1bbe94f77e78d95af98555f206db5668" alt="" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-glitch.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -353,7 +359,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient-fill.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A rainbow Gradient Fill Layer on the alphabetical keys of the keyboard" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient-fill.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A rainbow Gradient Fill Layer on the alphabetical keys of the keyboard" loading="lazy" height="288" width="866" /> </picture> </p>Gradient Layerhttps://www.project-aurora.com/Docs/reference-layers/gradient/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/gradient/<p>The Gradient Layer shows a gradient effect on the specified keys. The gradient can also be animated to move across the keyboard to give a wave effect. If it helps to understand how it works, you can imagine the gradient to be displayed on a (possibly moving) rectangle, and each key acts as a “window” onto that rectangle.</p> <p> @@ -378,7 +384,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A rainbow Gradient Layer on the alphabetical keys" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A rainbow Gradient Layer on the alphabetical keys" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -444,7 +450,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-image.png?v=1bbe94f77e78d95af98555f206db5668" alt="An image layer displaying a picture of a landscape" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-image.png?v=a71d2854f2395d41ca466dcae81079a8" alt="An image layer displaying a picture of a landscape" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -495,7 +501,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-interactive.gif?v=1bbe94f77e78d95af98555f206db5668" alt="Pressing keys on an interactive layer with key wave mode" loading="lazy" height="290" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-interactive.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="Pressing keys on an interactive layer with key wave mode" loading="lazy" height="290" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -587,7 +593,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/ghub-enable-sdk.png?v=1bbe94f77e78d95af98555f206db5668" alt="Turning on the SDK in Logitech G HUB" loading="lazy" height="792" width="1138" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/ghub-enable-sdk.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Turning on the SDK in Logitech G HUB" loading="lazy" height="792" width="1138" /> </picture> </p> <h2 id="for-lgs">For LGS:</h2> @@ -616,7 +622,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/lgs-enable-sdk-1.png?v=1bbe94f77e78d95af98555f206db5668" alt="Opening Settings in Logitech Gaming Software" loading="lazy" height="750" width="1006" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/lgs-enable-sdk-1.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Opening Settings in Logitech Gaming Software" loading="lazy" height="750" width="1006" /> </picture> </p>Logitech Lightsynchttps://www.project-aurora.com/Docs/integrations/lightsync/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/integrations/lightsync/<p> @@ -640,10 +646,10 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/lightsync_diagram.png?v=1bbe94f77e78d95af98555f206db5668" alt="Diagram showing Aurora &amp; Lightsync integration" loading="lazy" height="280" width="721" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/lightsync_diagram.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Diagram showing Aurora &amp; Lightsync integration" loading="lazy" height="280" width="721" /> </picture> </p> -<p>You can use Lightsync integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a></p> +<p>You can use Lightsync integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a> using Aurora</p> <blockquote> <p>Note that this is reverse engineered and may not work as the original.</p> </blockquote> @@ -704,7 +710,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-fire.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A particle layer with the fire preset" loading="lazy" height="240" width="724" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-fire.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A particle layer with the fire preset" loading="lazy" height="240" width="724" /> </picture> @@ -729,7 +735,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-matrix.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A particle layer with the matrix preset" loading="lazy" height="239" width="724" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-matrix.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A particle layer with the matrix preset" loading="lazy" height="239" width="724" /> </picture> </p>Percent (Gradient) Effect Layerhttps://www.project-aurora.com/Docs/reference-layers/percent-gradient-effect/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/percent-gradient-effect/<p>This layer is very similar to the Percent Effect Layer, but makes use of a gradient instead of a progress/background color. This layer does not have a background.</p> <p> @@ -754,7 +760,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-gradient-effect.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A gradient layer in progressive mode, with a red-green gradient assigned to the current millisecond" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-gradient-effect.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A gradient layer in progressive mode, with a red-green gradient assigned to the current millisecond" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -825,7 +831,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-effect.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A percent layer with current value set to the current time&rsquo;s milliseconds" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-effect.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A percent layer with current value set to the current time&rsquo;s milliseconds" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -901,7 +907,7 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-radial.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A rainbow radial layer" loading="lazy" height="240" width="724" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-radial.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A rainbow radial layer" loading="lazy" height="240" width="724" /> </picture> </p> <p>Note that this gradient is generated using discrete pie-shaped segments of colour. This color is determined by the median color at a particular point on the gradient. For example, if there were 4 segments, each would have a 90 degree arc. The first would use the color at 45 degrees (90 / 2) the second at 135 degrees, etc. If you do not get the colors you expect when using small numbers of segments, this is likely the reason.</p>Razerhttps://www.project-aurora.com/Docs/devices/razer/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/devices/razer/<p>You can have brand specific integrations (like LightFX and Lightsync) with Razer devices using Aurora.</p> @@ -939,10 +945,10 @@ Color updating is recommended to be disabled with supported games by setting a s <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/chroma_diagram.png?v=1bbe94f77e78d95af98555f206db5668" alt="Diagram showing Aurora Chroma integration" loading="lazy" height="350" width="691" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/chroma_diagram.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Diagram showing Aurora Chroma integration" loading="lazy" height="350" width="691" /> </picture> </p> -<p>You can use Chroma integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a></p> +<p>You can use Chroma integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a> using Aurora</p> <blockquote> <p>Note that this is reverse engineered and may not work as the original.</p> </blockquote> @@ -993,7 +999,7 @@ and rename the <strong>Repository</strong> folder to something else like R <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-shortcut.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A shortcut layer with common Ctrl and Ctrl + Shift shortcuts on top of a gradient layer" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-shortcut.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A shortcut layer with common Ctrl and Ctrl + Shift shortcuts on top of a gradient layer" loading="lazy" height="288" width="866" /> </picture> </p>Solid Color Layerhttps://www.project-aurora.com/Docs/reference-layers/solid-color/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/solid-color/<p>The Solid Color Layer is for setting static colors for specific keys. The keys will constantly be lit in the given color (providing they aren’t overridden by a higher-up layer). This is one of the most simple layers in Aurora, but can be useful for things such as highlighting controls such as WASD in video games.</p> <p> @@ -1018,7 +1024,7 @@ and rename the <strong>Repository</strong> folder to something else like R <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-color.png?v=1bbe94f77e78d95af98555f206db5668" alt="A Solid Color Layer lighting common video game control keys" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-color.png?v=a71d2854f2395d41ca466dcae81079a8" alt="A Solid Color Layer lighting common video game control keys" loading="lazy" height="288" width="866" /> </picture> </p> <p>If you want to set the color of the entire (or most) of the keyboard, consider using the <a href="https://www.project-aurora.com/Docs/reference-layers/solid-fill-color/">Solid Fill Color</a> Layer instead.</p>Solid Fill Color Layerhttps://www.project-aurora.com/Docs/reference-layers/solid-fill-color/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/solid-fill-color/<p>Similar to the Solid Color layer, however it does not have fine control over which keys are lit and so fills the entire canvas (keyboard, mouse and any other peripherals) with the given color. This layer is useful for setting static backgrounds, saving you from having to manually add each key.</p> @@ -1044,7 +1050,7 @@ and rename the <strong>Repository</strong> folder to something else like R <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-fill-color.png?v=1bbe94f77e78d95af98555f206db5668" alt="A Solid Fill Layer setting the entire keyboard to cyan" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-fill-color.png?v=a71d2854f2395d41ca466dcae81079a8" alt="A Solid Fill Layer setting the entire keyboard to cyan" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -1097,7 +1103,7 @@ and rename the <strong>Repository</strong> folder to something else like R <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/enable-sse-app.png?v=1bbe94f77e78d95af98555f206db5668" alt="Enabling custom app in SSE3" loading="lazy" height="1040" width="1920" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/enable-sse-app.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Enabling custom app in SSE3" loading="lazy" height="1040" width="1920" /> </picture> </p> <p>If you still cannot control your keyboard or mouse illumination, check if Color Special Event is enabled in Aurora applet in SSE.</p> @@ -1123,7 +1129,7 @@ and rename the <strong>Repository</strong> folder to something else like R <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/sse-special-event.png?v=1bbe94f77e78d95af98555f206db5668" alt="Color Special Event in Aurora applet" loading="lazy" height="1040" width="1920" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/sse-special-event.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Color Special Event in Aurora applet" loading="lazy" height="1040" width="1920" /> </picture> </p> <h1 id="known-issues">Known Issues</h1> @@ -1154,13 +1160,15 @@ and rename the <strong>Repository</strong> folder to something else like R <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-timer.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A timer layer on the alphabetical keys" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-timer.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A timer layer on the alphabetical keys" loading="lazy" height="288" width="866" /> </picture> </p>Toggle Key Layerhttps://www.project-aurora.com/Docs/reference-layers/toggle-key/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/toggle-key/<p>The toggle key layer allows for the turning on or off some lights based on the key press of another specific key. This layer can be useful for things such as indicators for whether something is toggled on/off in a game.</p> <p><span class="alert info">If you are using caps lock, num lock or scroll lock as a trigger key it is probably better to use the Lock Layer to ensure the key light state stays synced with the lock state properly.</span></p>Toolbar Layerhttps://www.project-aurora.com/Docs/reference-layers/toolbar/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/toolbar/<p>The toolbar layer is a layer that shows one key as “active” and all others assigned to it as “inactive”. When a different key is pressed, the pressed key becomes the active one instead. This works similarly to how toolbars/item bars work in video games such as Factorio or Minecraft.</p> -<p>The layer can also be toggled to listen for the scroll wheel to allow scrolling through the toolbar by turning on the <em>Enable Scroll</em> configuration option. The order the keys are scrolled through is given by their order in the <em>Affected Keys</em> option, so if scrolling through is in the incorrect order, check the order of the keys here.</p>User Datahttps://www.project-aurora.com/Docs/basic-topics/user-data/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/basic-topics/user-data/<p>Aurora stores all user data in a directory in the roaming application data folder. This user data includes all your settings (such as preferred devices, bitmap accuracy, etc) as well as all your lighting profiles and recent logs that Aurora has created. You can see the Aurora folder by navigating to <code>%APPDATA%\Aurora</code> in Windows file explorer.</p> +<p>The layer can also be toggled to listen for the scroll wheel to allow scrolling through the toolbar by turning on the <em>Enable Scroll</em> configuration option. The order the keys are scrolled through is given by their order in the <em>Affected Keys</em> option, so if scrolling through is in the incorrect order, check the order of the keys here.</p>User Datahttps://www.project-aurora.com/Docs/basic-topics/user-data/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/basic-topics/user-data/<p>You can see the Aurora data by navigating to <code>%APPDATA%\Aurora</code> in File Explorer. +This user data includes all your settings as well as all your lighting profiles and recent logs that Aurora has created.</p> <h1 id="importing-profiles">Importing Profiles</h1> -<p>Profiles that others have made can be imported easily into Aurora using the import button on the &ldquo;Profiles&rdquo; section. Pressing this button will open a dialog asking you to choose a file to import. JSON files that have been exported from Aurora (see <a href="#exporting-profiles">exporting profiles</a>) are fully supported through import. In addition, Aurora has partial support for implementing iCUE profiles, however due to the nature of it being a different program with different layers and formats, imported profiles may not look identical.</p>Wootinghttps://www.project-aurora.com/Docs/devices/wooting/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/devices/wooting/<h1 id="required-software">Required Software</h1> +<p>Profiles that others have made can be imported easily into Aurora using the import button on the &ldquo;Profiles&rdquo; section. Pressing this button will open a dialog asking you to choose a file to import. +JSON files that have been exported from Aurora (see <a href="#exporting-profiles">exporting profiles</a>) are fully supported through import.</p>Wootinghttps://www.project-aurora.com/Docs/devices/wooting/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/devices/wooting/<h1 id="required-software">Required Software</h1> <p>None. Aurora will connect directly to your keyboard</p> <h1 id="needed-configuration">Needed configuration</h1> <p>None. Connection should be automatic. If Aurora fails to connect at first, replug the keyboard and start Aurora again.</p> diff --git a/integrations/chroma/index.html b/integrations/chroma/index.html index e96427a..ce32836 100644 --- a/integrations/chroma/index.html +++ b/integrations/chroma/index.html @@ -1,5 +1,5 @@ How to Use Razer Chroma on Non-Razer Devices • Aurora Docs
    -Aurora User Docs

    Razer Chroma


    Last updated 01.10.2024

    Diagram showing Aurora Chroma integration

    You can use Chroma integration with all supported devices

    Note that this is reverse engineered and may not work as the original.

    You can have Synapse installed and Aurora will automatically apply game effects to your devices. +Aurora User Docs

    Razer Chroma


    Last updated 02.10.2024

    Diagram showing Aurora Chroma integration

    You can use Chroma integration with all supported devices using Aurora

    Note that this is reverse engineered and may not work as the original.

    You can have Synapse installed and Aurora will automatically apply game effects to your devices. Then, “Razer Chroma SDK Service” needs to be running for the integration to work.

    Chrome Enabled Games List on www.razer.com

    • RAZER is the trademark or registered trademark of Razer Inc.
    Page authored by
    \ No newline at end of file diff --git a/integrations/index.xml b/integrations/index.xml index 82bff93..a87ed87 100644 --- a/integrations/index.xml +++ b/integrations/index.xml @@ -4,6 +4,12 @@ <p>Note that this is reverse engineered and may not work as the original.</p> </blockquote>Brand Integrationshttps://www.project-aurora.com/Docs/integrations/integrations/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/integrations/integrations/<p>Some of the brand specific game integrations are reverse-engineered to work with Aurora. See their pages to see how they are configured.</p> +<h2 id="game-integrations-aurora-supports">Game Integrations Aurora Supports</h2> +<ul> +<li><a href="https://www.project-aurora.com/Docs/integrations/chroma/">Chroma</a></li> +<li><a href="https://www.project-aurora.com/Docs/integrations/lightsync/">Lightsync</a></li> +<li><a href="https://www.project-aurora.com/Docs/integrations/lightfx/">LightFX</a></li> +</ul> <p><a href="https://www.pcgamingwiki.com/wiki/RGB_lighting_middleware">PCGamingWiki page about integrations</a></p>Logitech Lightsynchttps://www.project-aurora.com/Docs/integrations/lightsync/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/integrations/lightsync/<p> @@ -26,10 +32,10 @@ See their pages to see how they are configured.</p> <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/lightsync_diagram.png?v=1bbe94f77e78d95af98555f206db5668" alt="Diagram showing Aurora &amp; Lightsync integration" loading="lazy" height="280" width="721" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/lightsync_diagram.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Diagram showing Aurora &amp; Lightsync integration" loading="lazy" height="280" width="721" /> </picture> </p> -<p>You can use Lightsync integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a></p> +<p>You can use Lightsync integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a> using Aurora</p> <blockquote> <p>Note that this is reverse engineered and may not work as the original.</p> </blockquote> @@ -56,10 +62,10 @@ See their pages to see how they are configured.</p> <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/chroma_diagram.png?v=1bbe94f77e78d95af98555f206db5668" alt="Diagram showing Aurora Chroma integration" loading="lazy" height="350" width="691" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/chroma_diagram.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Diagram showing Aurora Chroma integration" loading="lazy" height="350" width="691" /> </picture> </p> -<p>You can use Chroma integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a></p> +<p>You can use Chroma integration with <a href="https://www.project-aurora.com/Docs/devices/alldevices/">all supported devices</a> using Aurora</p> <blockquote> <p>Note that this is reverse engineered and may not work as the original.</p> </blockquote> diff --git a/integrations/integrations/index.html b/integrations/integrations/index.html index 3e53dab..61a02d7 100644 --- a/integrations/integrations/index.html +++ b/integrations/integrations/index.html @@ -1,5 +1,5 @@ Brand Integrations • integrations • Aurora Docs
    -Aurora User Docs

    Brand Integrations


    Last updated 11.05.2024

    Some of the brand specific game integrations are reverse-engineered to work with Aurora. -See their pages to see how they are configured.

    PCGamingWiki page about integrations

    Page authored by
    \ No newline at end of file +Aurora User Docs
    \ No newline at end of file diff --git a/integrations/lightsync/index.html b/integrations/lightsync/index.html index d6dbbd2..e4bd722 100644 --- a/integrations/lightsync/index.html +++ b/integrations/lightsync/index.html @@ -1,4 +1,4 @@ How to Use Lightsync integration on Non-Logitech Devices • Aurora Docs
    -Aurora User Docs

    Logitech Lightsync


    Last updated 01.10.2024

    Diagram showing Aurora & Lightsync integration

    You can use Lightsync integration with all supported devices

    Note that this is reverse engineered and may not work as the original.

    You can have LGS installed and Aurora will automatically apply game effects to your devices.

    LGS must be fully closed before Aurora is launched.

    Page authored by
    \ No newline at end of file +Aurora User Docs

    Logitech Lightsync


    Last updated 02.10.2024

    Diagram showing Aurora & Lightsync integration

    You can use Lightsync integration with all supported devices using Aurora

    Note that this is reverse engineered and may not work as the original.

    You can have LGS installed and Aurora will automatically apply game effects to your devices.

    LGS must be fully closed before Aurora is launched.

    Page authored by
    \ No newline at end of file diff --git a/reference-expressions/maths/index.html b/reference-expressions/maths/index.html index f0b9bfa..7b164e5 100644 --- a/reference-expressions/maths/index.html +++ b/reference-expressions/maths/index.html @@ -1,4 +1,4 @@ Maths • reference-expressions • Aurora Docs
    -Aurora User Docs

    Maths


    Last updated 10.01.2024

    This page lists all the standard evaluatables that are under the ‘Maths’ category.

    Absolute number

    Takes a number and outputs the absolute (positive) value. E.G. 5 outputs 5 (no change), but -10 would output 10.

    Arithmetic Comparison boolean

    Compares two numbers together and outputs a boolean indicating the result of the comparison. Can choose a comparison from: equal, not equal, less than, less than or equal, greater than, greater than or equal.

    Arithmetic Operation number

    Performs a binary operation on two numbers, such as: adding them together, subtracting one from the other, multiplying them together, dividing one by the other or finding the modulus (remainder of one when divided by the other).

    Lerp number

    Maps a value from one range onto it’s interpolated value in another range.

    For example, mapping the value 0.7 from a range of 0 to 1 onto the range of 50 to 100 would output 85. This is because 0.7 is 70% of the way between 0 and 1, and the number that is 70% of the way between 50 and 100 is 85.

    Number Change Detector boolean

    Outputs a true value on a frame whenever the value of the input number changes. If you require the boolean to be true for longer than a single frame, use this in conjunction with the true extender.

    Can also be set up to only output true when the value increases or decreases (instead of any change) and can also provide a minimum threshold that the change must be. For example, if you tick “Trigger on increase”, untick “Trigger on decrease” and set the threshold to 5, the only time a true will be output is when the current value of the number is 5 or higher more than the value it was last frame.

    Number Constant number

    Constantly outputs the specified number.

    Wave Function number

    Creates a wave output based on the given input.

    Note that all waves are normalized to accept a value in the range 0 - 1 and also output a value in the range 0 - 1.

    Sine

    Triangle

    Page authored by
    \ No newline at end of file +Aurora User Docs

    Maths


    Last updated 10.01.2024

    This page lists all the standard evaluatables that are under the ‘Maths’ category.

    Absolute number

    Takes a number and outputs the absolute (positive) value. E.G. 5 outputs 5 (no change), but -10 would output 10.

    Arithmetic Comparison boolean

    Compares two numbers together and outputs a boolean indicating the result of the comparison. Can choose a comparison from: equal, not equal, less than, less than or equal, greater than, greater than or equal.

    Arithmetic Operation number

    Performs a binary operation on two numbers, such as: adding them together, subtracting one from the other, multiplying them together, dividing one by the other or finding the modulus (remainder of one when divided by the other).

    Lerp number

    Maps a value from one range onto it’s interpolated value in another range.

    For example, mapping the value 0.7 from a range of 0 to 1 onto the range of 50 to 100 would output 85. This is because 0.7 is 70% of the way between 0 and 1, and the number that is 70% of the way between 50 and 100 is 85.

    Number Change Detector boolean

    Outputs a true value on a frame whenever the value of the input number changes. If you require the boolean to be true for longer than a single frame, use this in conjunction with the true extender.

    Can also be set up to only output true when the value increases or decreases (instead of any change) and can also provide a minimum threshold that the change must be. For example, if you tick “Trigger on increase”, untick “Trigger on decrease” and set the threshold to 5, the only time a true will be output is when the current value of the number is 5 or higher more than the value it was last frame.

    Number Constant number

    Constantly outputs the specified number.

    Wave Function number

    Creates a wave output based on the given input.

    Note that all waves are normalized to accept a value in the range 0 - 1 and also output a value in the range 0 - 1.

    Sine

    Triangle

    Page authored by
    \ No newline at end of file diff --git a/reference-layers/ambilight/index.html b/reference-layers/ambilight/index.html index 734d9a5..19808ac 100644 --- a/reference-layers/ambilight/index.html +++ b/reference-layers/ambilight/index.html @@ -1,4 +1,4 @@ Ambilight Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Ambilight Layer


    Last updated 10.01.2024

    The ambilight layer takes the average color of the monitor (or specific areas of the monitor) and displays them on the keys.

    This can be a very intensive operation and so may not perform well on all machines. You may find that Aurora is lagging or using too much CPU when you use one of these layers.

    Ambilight Layer in use on a dual-monitor setup with a white background on one and blue on the other

    Properties

    NameDescription
    Ambilight Effect Type
    • Default - Takes the image from the target and sets the keys to the color at points on that image (see above for an example).
    • Average Color - Takes the entire image and gets the average color of the image and sets all keys to be that color.
    Ambilight Capture Type
    • Everything - Takes entire screen output (including multiple monitors if you have them).
    • Main Monitor Only - Takes screen output only from the monitor designated as number 1.
    • Foreground Application - Takes output from whichever application currently has focus.
    • Specific Process - Takes output only from the process with the specified name.
    Specific Process NameUsed with Capture Type "Specific Process" to restrict the ambilight layer to only use output from a specific application.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Ambilight Layer


    Last updated 10.01.2024

    The ambilight layer takes the average color of the monitor (or specific areas of the monitor) and displays them on the keys.

    This can be a very intensive operation and so may not perform well on all machines. You may find that Aurora is lagging or using too much CPU when you use one of these layers.

    Ambilight Layer in use on a dual-monitor setup with a white background on one and blue on the other

    Properties

    NameDescription
    Ambilight Effect Type
    • Default - Takes the image from the target and sets the keys to the color at points on that image (see above for an example).
    • Average Color - Takes the entire image and gets the average color of the image and sets all keys to be that color.
    Ambilight Capture Type
    • Everything - Takes entire screen output (including multiple monitors if you have them).
    • Main Monitor Only - Takes screen output only from the monitor designated as number 1.
    • Foreground Application - Takes output from whichever application currently has focus.
    • Specific Process - Takes output only from the process with the specified name.
    Specific Process NameUsed with Capture Type "Specific Process" to restrict the ambilight layer to only use output from a specific application.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/animation/index.html b/reference-layers/animation/index.html index 0639d2c..a302602 100644 --- a/reference-layers/animation/index.html +++ b/reference-layers/animation/index.html @@ -1,4 +1,4 @@ Animation Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Animation Layer


    Last updated 10.01.2024

    The animation layer is another very powerful but very complex and hard-to-use layer. It allows for you to create custom animations using shapes and by creating key-frames in the animation editor. There is a basic guide on how to create animations here.

    This layer can also be triggered when certain events happen. You can select it for when a game-state value changes or when you press/release a key. When in a key-mode, the animation can optionally be translated to the location of the pressed key. This basically provides a means of creating a custom interactive layer if you don’t like that layer’s default effects.

    An very basic example animation that has a rectangle that grows in width, then in height

    Properties

    NameDescription
    Display Only on Key Sequence KeysIf this is selected, the animation will only be displayed on the keys in the Affect Keys list.
    Scale to Key Sequence boundsIf this is checked, the animation bitmap will be scaled and translated so that it covers the keys in the Affected Keys list.
    Affected KeysIf Display Only on Key Sequence Keys is checked, the animation will only be displayed on these keys.
    Animation DurationThe length of time an animation takes to play. If you do not set this value high enough, the animation will appear to be cut off as it ends too early.
    Repeat TimesThe amount of times the animation will repeat. If set to 0, it will repeat indefinitely. When the trigger is not “Always on”, this should not be set to 0 as once triggered the animation will carry on forever.
    TriggerThis option is how you set when the animations should be played. The sub-properties for each of these trigger modes are detailed in the tabs below. “Always On” does not have any additional properties.

    Value Change Trigger Properties

    NameDescription
    Trigger pathA path to a number State Variable that should be watched for the value to change.
    Stack modeWhat should happen if the state variable changes again while an animation is already playing.
    • Ignore - The currently playing animation will keep playing as if nothing happened.
    • Restart - Restart the currently playing animation.
    • Play Multiple - Play another instance of the animation in addition to the currently running one.

    Boolean Change Trigger Properties

    NameDescription
    Trigger pathA path to a boolean State Variable that should be watched for it to either become true, become false or run while true.
    Stack modeWhat should happen if the state variable changes again while an animation is already playing.
    • Ignore - The currently playing animation will keep playing as if nothing happened.
    • Restart - Restart the currently playing animation.
    • Play Multiple - Play another instance of the animation in addition to the currently running one.

    Key Trigger Properties

    NameDescription
    Trigger for any keyIf this is checked, any key press will trigger an animation. If unchecked, only the keys in Trigger Keys will cause an animation to play.
    Translate to pressed keyIf this is checked, the animation's origin point (0, 0) (top left) will be translated to the center point of the pressed key.
    Trigger keysThe keys that should trigger an animation. Not needed if Trigger for any Key is checked.
    Stack modeWhat should happen if the state variable changes again while an animation is already playing.
    • Ignore - The currently playing animation will keep playing as if nothing happened.
    • Restart - Restart the currently playing animation.
    • Play Multiple - Play another instance of the animation in addition to the currently running one.
    Stop as soon as key releasedIf this is checked, the animation will immediately stop when the key is released. I.E. it will not wait for the animation to finish playing.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Animation Layer


    Last updated 10.01.2024

    The animation layer is another very powerful but very complex and hard-to-use layer. It allows for you to create custom animations using shapes and by creating key-frames in the animation editor. There is a basic guide on how to create animations here.

    This layer can also be triggered when certain events happen. You can select it for when a game-state value changes or when you press/release a key. When in a key-mode, the animation can optionally be translated to the location of the pressed key. This basically provides a means of creating a custom interactive layer if you don’t like that layer’s default effects.

    An very basic example animation that has a rectangle that grows in width, then in height

    Properties

    NameDescription
    Display Only on Key Sequence KeysIf this is selected, the animation will only be displayed on the keys in the Affect Keys list.
    Scale to Key Sequence boundsIf this is checked, the animation bitmap will be scaled and translated so that it covers the keys in the Affected Keys list.
    Affected KeysIf Display Only on Key Sequence Keys is checked, the animation will only be displayed on these keys.
    Animation DurationThe length of time an animation takes to play. If you do not set this value high enough, the animation will appear to be cut off as it ends too early.
    Repeat TimesThe amount of times the animation will repeat. If set to 0, it will repeat indefinitely. When the trigger is not “Always on”, this should not be set to 0 as once triggered the animation will carry on forever.
    TriggerThis option is how you set when the animations should be played. The sub-properties for each of these trigger modes are detailed in the tabs below. “Always On” does not have any additional properties.

    Value Change Trigger Properties

    NameDescription
    Trigger pathA path to a number State Variable that should be watched for the value to change.
    Stack modeWhat should happen if the state variable changes again while an animation is already playing.
    • Ignore - The currently playing animation will keep playing as if nothing happened.
    • Restart - Restart the currently playing animation.
    • Play Multiple - Play another instance of the animation in addition to the currently running one.

    Boolean Change Trigger Properties

    NameDescription
    Trigger pathA path to a boolean State Variable that should be watched for it to either become true, become false or run while true.
    Stack modeWhat should happen if the state variable changes again while an animation is already playing.
    • Ignore - The currently playing animation will keep playing as if nothing happened.
    • Restart - Restart the currently playing animation.
    • Play Multiple - Play another instance of the animation in addition to the currently running one.

    Key Trigger Properties

    NameDescription
    Trigger for any keyIf this is checked, any key press will trigger an animation. If unchecked, only the keys in Trigger Keys will cause an animation to play.
    Translate to pressed keyIf this is checked, the animation's origin point (0, 0) (top left) will be translated to the center point of the pressed key.
    Trigger keysThe keys that should trigger an animation. Not needed if Trigger for any Key is checked.
    Stack modeWhat should happen if the state variable changes again while an animation is already playing.
    • Ignore - The currently playing animation will keep playing as if nothing happened.
    • Restart - Restart the currently playing animation.
    • Play Multiple - Play another instance of the animation in addition to the currently running one.
    Stop as soon as key releasedIf this is checked, the animation will immediately stop when the key is released. I.E. it will not wait for the animation to finish playing.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/audio-visualizer/index.html b/reference-layers/audio-visualizer/index.html index fd2afdc..241907a 100644 --- a/reference-layers/audio-visualizer/index.html +++ b/reference-layers/audio-visualizer/index.html @@ -1,4 +1,4 @@ Audio Visualizer Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Audio Visualizer Layer


    Last updated 10.01.2024

    This layer takes in audio data from your computer and visualizes the volume at various frequencies. There are many different customization options for this layer including which frequencies should be detected. Which frequencies are best depends on the type of audio you expect to be playing (rock will be different from classical) but the default frequencies provide a good starting point.

    An equalizer layer in gradient mode while playing a music track

    Properties

    NameDescription
    Equalizer Effect Type
    • Power Bars
    • Waveform
    • Waveform (From bottom)
    View Type
    • Solid Color - The waveform/bars are displayed in a single color (Primary Color)
    • Alternating Colors - Each bar alternates between Primary and Secondary color.
    • Gradient Notched Color - Each bar is a single color based on the Gradient provided.
    • Gradient Color Shift - The whole waveform is a single color as given by the gradient. The color gradually changes over time.
    • Gradient (Horizontal) - The waveform is colored as the Gradient provided.
    • Gradient (Vertical) - The waveform is colored as the Gradient provided vertically.
    Primary ColorThe color used when View Type is "Solid Color" or used for every other bar when View Type is "Alternating Colors".
    Secondary ColorThe color used for every other bar when View Type is "Alternating Colors".
    GradientThe gradient used when View Type isn't "Solid Color" or "Alternating Colors".
    Max AmplitudeThe value that will be used as the maximum value of the waveform. If the bars frequently clip off the top/bottom of the bitmap, try decreasing this value.
    Scale with System VolumeWhether or not the max amplitude should automatically scale with the system volume.
    Dim Background on SoundIf this is selected, when a sound is played the Dim Color will be used to dim the background.
    Dim ColorThe color used to dim the background by when Dim Background on Sound is selected.
    FrequenciesA list of all frequencies that will be represented by bars when the Effect Type is set to "Power Bars". You may need to tweak or add/remove this values to get the best experience depending on the type of audio you expect to be played.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Audio Visualizer Layer


    Last updated 10.01.2024

    This layer takes in audio data from your computer and visualizes the volume at various frequencies. There are many different customization options for this layer including which frequencies should be detected. Which frequencies are best depends on the type of audio you expect to be playing (rock will be different from classical) but the default frequencies provide a good starting point.

    An equalizer layer in gradient mode while playing a music track

    Properties

    NameDescription
    Equalizer Effect Type
    • Power Bars
    • Waveform
    • Waveform (From bottom)
    View Type
    • Solid Color - The waveform/bars are displayed in a single color (Primary Color)
    • Alternating Colors - Each bar alternates between Primary and Secondary color.
    • Gradient Notched Color - Each bar is a single color based on the Gradient provided.
    • Gradient Color Shift - The whole waveform is a single color as given by the gradient. The color gradually changes over time.
    • Gradient (Horizontal) - The waveform is colored as the Gradient provided.
    • Gradient (Vertical) - The waveform is colored as the Gradient provided vertically.
    Primary ColorThe color used when View Type is "Solid Color" or used for every other bar when View Type is "Alternating Colors".
    Secondary ColorThe color used for every other bar when View Type is "Alternating Colors".
    GradientThe gradient used when View Type isn't "Solid Color" or "Alternating Colors".
    Max AmplitudeThe value that will be used as the maximum value of the waveform. If the bars frequently clip off the top/bottom of the bitmap, try decreasing this value.
    Scale with System VolumeWhether or not the max amplitude should automatically scale with the system volume.
    Dim Background on SoundIf this is selected, when a sound is played the Dim Color will be used to dim the background.
    Dim ColorThe color used to dim the background by when Dim Background on Sound is selected.
    FrequenciesA list of all frequencies that will be represented by bars when the Effect Type is set to "Power Bars". You may need to tweak or add/remove this values to get the best experience depending on the type of audio you expect to be played.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/blinking/index.html b/reference-layers/blinking/index.html index f41130d..7e59b04 100644 --- a/reference-layers/blinking/index.html +++ b/reference-layers/blinking/index.html @@ -1,4 +1,4 @@ Blinking Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Blinking Layer


    Last updated 10.01.2024

    The blinking layer sets the colors of the specified keys to flash between two alternatives, with no fading between the colors. Like to the breathing layer, it allows either or both of these colors to be randomized if you wish.

    A blinking layer with cyan and a random secondary color

    Properties

    NameDescription
    Primary ColorThe solid color to set all the affected keys to during the first phase.
    Use Random PrimaryTick this to use a random color during first phase instead of Primary Color.
    Secondary ColorThe solid color to set all the affected keys to during the second phase.
    Use Random SecondaryTick this to use a random color during second phase instead of Secondary Color.
    Effect SpeedHow fast the keys swap between primary and secondary colors.
    Affected KeysA collection of keys that will be set to the target color.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Blinking Layer


    Last updated 10.01.2024

    The blinking layer sets the colors of the specified keys to flash between two alternatives, with no fading between the colors. Like to the breathing layer, it allows either or both of these colors to be randomized if you wish.

    A blinking layer with cyan and a random secondary color

    Properties

    NameDescription
    Primary ColorThe solid color to set all the affected keys to during the first phase.
    Use Random PrimaryTick this to use a random color during first phase instead of Primary Color.
    Secondary ColorThe solid color to set all the affected keys to during the second phase.
    Use Random SecondaryTick this to use a random color during second phase instead of Secondary Color.
    Effect SpeedHow fast the keys swap between primary and secondary colors.
    Affected KeysA collection of keys that will be set to the target color.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/breathing/index.html b/reference-layers/breathing/index.html index 4747cf0..bfa5775 100644 --- a/reference-layers/breathing/index.html +++ b/reference-layers/breathing/index.html @@ -1,4 +1,4 @@ Breathing Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Breathing Layer


    Last updated 10.01.2024

    The breathing layer fades the colors of the specified keys between two colors. In that regard it is similar to the Gradient Fill Layer, however this layer also allows the colors to be randomized, so that the keyboard fades between unpredictable colors.

    A breathing layer with two random colors

    Properties

    NameDescription
    Primary ColorThe solid color to set all the affected keys to during the first phase.
    Use Random PrimaryTick this to use a random color during first phase instead of Primary Color.
    Secondary ColorThe solid color to set all the affected keys to during the second phase.
    Use Random SecondaryTick this to use a random color during second phase instead of Secondary Color.
    Effect SpeedHow fast the keys swap between primary and secondary colors.
    Affected KeysA collection of keys that will be set to the target color.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Breathing Layer


    Last updated 10.01.2024

    The breathing layer fades the colors of the specified keys between two colors. In that regard it is similar to the Gradient Fill Layer, however this layer also allows the colors to be randomized, so that the keyboard fades between unpredictable colors.

    A breathing layer with two random colors

    Properties

    NameDescription
    Primary ColorThe solid color to set all the affected keys to during the first phase.
    Use Random PrimaryTick this to use a random color during first phase instead of Primary Color.
    Secondary ColorThe solid color to set all the affected keys to during the second phase.
    Use Random SecondaryTick this to use a random color during second phase instead of Secondary Color.
    Effect SpeedHow fast the keys swap between primary and secondary colors.
    Affected KeysA collection of keys that will be set to the target color.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/glitch-effect/index.html b/reference-layers/glitch-effect/index.html index 8450631..3ca802b 100644 --- a/reference-layers/glitch-effect/index.html +++ b/reference-layers/glitch-effect/index.html @@ -1,4 +1,4 @@ Glitch Effect Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Glitch Effect Layer


    Last updated 10.01.2024

    The glitch layer simply randomizes each key’s color every time it updates. The frequency of the update is configurable.

    Properties

    NameDescription
    Update IntervalThe time in seconds between the key’s randomization.
    Allow TransparencyIf true, the random color may be transparent.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Glitch Effect Layer


    Last updated 10.01.2024

    The glitch layer simply randomizes each key’s color every time it updates. The frequency of the update is configurable.

    Properties

    NameDescription
    Update IntervalThe time in seconds between the key’s randomization.
    Allow TransparencyIf true, the random color may be transparent.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/gradient-fill/index.html b/reference-layers/gradient-fill/index.html index 1db55a0..bd090b6 100644 --- a/reference-layers/gradient-fill/index.html +++ b/reference-layers/gradient-fill/index.html @@ -1,4 +1,4 @@ Gradient Fill Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Gradient Fill Layer


    Last updated 10.01.2024

    This layer sets all the specified keys to the same color, determined by the gradient. Unlike the regular gradient layer, all keys are the same color. You can think of the gradient as being a “timeline”, and the colors of all the keys are set based on how far through the timeline we are. This can be used to create a fade effect between multiple different colors.

    A rainbow Gradient Fill Layer on the alphabetical keys of the keyboard

    Properties

    NameDescription
    GradientThe gradient that will be used to set the keys’ color to.
    Effect SpeedThe speed that the colors of the keys change. Higher = faster.
    Fill keyboard canvasTick this to fill the whole keyboard with the gradient instead of the affected keys.
    Affected KeysA collection of keys that will be set to the target color.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Gradient Fill Layer


    Last updated 10.01.2024

    This layer sets all the specified keys to the same color, determined by the gradient. Unlike the regular gradient layer, all keys are the same color. You can think of the gradient as being a “timeline”, and the colors of all the keys are set based on how far through the timeline we are. This can be used to create a fade effect between multiple different colors.

    A rainbow Gradient Fill Layer on the alphabetical keys of the keyboard

    Properties

    NameDescription
    GradientThe gradient that will be used to set the keys’ color to.
    Effect SpeedThe speed that the colors of the keys change. Higher = faster.
    Fill keyboard canvasTick this to fill the whole keyboard with the gradient instead of the affected keys.
    Affected KeysA collection of keys that will be set to the target color.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/gradient/index.html b/reference-layers/gradient/index.html index 8bbd4c7..642c82e 100644 --- a/reference-layers/gradient/index.html +++ b/reference-layers/gradient/index.html @@ -1,4 +1,4 @@ Gradient Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Gradient Layer


    Last updated 10.01.2024

    The Gradient Layer shows a gradient effect on the specified keys. The gradient can also be animated to move across the keyboard to give a wave effect. If it helps to understand how it works, you can imagine the gradient to be displayed on a (possibly moving) rectangle, and each key acts as a “window” onto that rectangle.

    A rainbow Gradient Layer on the alphabetical keys

    Properties

    NameDescription
    GradientThe solid color to set all the affected keys to.
    Effect SpeedThe speed at which the animation (as given by Animation Type) moves.
    Effect AngleThe angle of the gradient.
    Animation Type
    • None - No animation, static gradient.
    • Translate X and Y - Moves the gradient X and Y (depending on angle).
    • (Radial only) Zoom In
    • (Radial only) Zoom Out
    Reverse DirectionWhether or not to reverse the direction the gradient animation plays.
    Affected KeysA collection of keys that will be set to the above solid color.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Gradient Layer


    Last updated 10.01.2024

    The Gradient Layer shows a gradient effect on the specified keys. The gradient can also be animated to move across the keyboard to give a wave effect. If it helps to understand how it works, you can imagine the gradient to be displayed on a (possibly moving) rectangle, and each key acts as a “window” onto that rectangle.

    A rainbow Gradient Layer on the alphabetical keys

    Properties

    NameDescription
    GradientThe solid color to set all the affected keys to.
    Effect SpeedThe speed at which the animation (as given by Animation Type) moves.
    Effect AngleThe angle of the gradient.
    Animation Type
    • None - No animation, static gradient.
    • Translate X and Y - Moves the gradient X and Y (depending on angle).
    • (Radial only) Zoom In
    • (Radial only) Zoom Out
    Reverse DirectionWhether or not to reverse the direction the gradient animation plays.
    Affected KeysA collection of keys that will be set to the above solid color.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/image/index.html b/reference-layers/image/index.html index e4cb8e2..e6129b7 100644 --- a/reference-layers/image/index.html +++ b/reference-layers/image/index.html @@ -1,4 +1,4 @@ Image Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Image Layer


    Last updated 10.01.2024

    The image layer takes an image saved on your computer and attempts to replicate it on the keyboard by averaging the nearby color at different points. Obviously one should not expect to get the same fidelity you would get with a high-res image, but some images can provide nice effects. In addition, Aurora supports the use of animated GIF images.

    An image layer displaying a picture of a landscape

    Properties

    NameDescription
    Selected ImageThe file path to the image you wish to display.
    Affected KeysThe collection of keys that will be set to colors that imitate the given image.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Image Layer


    Last updated 10.01.2024

    The image layer takes an image saved on your computer and attempts to replicate it on the keyboard by averaging the nearby color at different points. Obviously one should not expect to get the same fidelity you would get with a high-res image, but some images can provide nice effects. In addition, Aurora supports the use of animated GIF images.

    An image layer displaying a picture of a landscape

    Properties

    NameDescription
    Selected ImageThe file path to the image you wish to display.
    Affected KeysThe collection of keys that will be set to colors that imitate the given image.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/index.xml b/reference-layers/index.xml index 781c36b..f33fab4 100644 --- a/reference-layers/index.xml +++ b/reference-layers/index.xml @@ -22,7 +22,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-ambilight.png?v=1bbe94f77e78d95af98555f206db5668" alt="Ambilight Layer in use on a dual-monitor setup with a white background on one and blue on the other" loading="lazy" height="241" width="725" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-ambilight.png?v=a71d2854f2395d41ca466dcae81079a8" alt="Ambilight Layer in use on a dual-monitor setup with a white background on one and blue on the other" loading="lazy" height="241" width="725" /> </picture> </p>    Animation Layerhttps://www.project-aurora.com/Docs/reference-layers/animation/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/animation/<p>The animation layer is another very powerful but very complex and hard-to-use layer. It allows for you to create custom animations using shapes and by creating key-frames in the animation editor. There is a basic guide on how to create animations <a href="https://www.project-aurora.com/Docs/advanced-topics/animation-editor/">here</a>.</p> <p>This layer can also be triggered when certain events happen. You can select it for when a game-state value changes or when you press/release a key. When in a key-mode, the animation can optionally be translated to the location of the pressed key. This basically provides a means of creating a custom interactive layer if you don’t like that layer’s default effects.</p>Audio Visualizer Layerhttps://www.project-aurora.com/Docs/reference-layers/audio-visualizer/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/audio-visualizer/<p>This layer takes in audio data from your computer and visualizes the volume at various frequencies. There are many different customization options for this layer including which frequencies should be detected. Which frequencies are best depends on the type of audio you expect to be playing (rock will be different from classical) but the default frequencies provide a good starting point.</p> @@ -48,7 +48,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-equalizer.gif?v=1bbe94f77e78d95af98555f206db5668" alt="An equalizer layer in gradient mode while playing a music track" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-equalizer.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="An equalizer layer in gradient mode while playing a music track" loading="lazy" height="288" width="866" /> </picture> </p>Blinking Layerhttps://www.project-aurora.com/Docs/reference-layers/blinking/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/blinking/<p>The blinking layer sets the colors of the specified keys to flash between two alternatives, with no fading between the colors. Like to the breathing layer, it allows either or both of these colors to be randomized if you wish.</p> <p> @@ -73,7 +73,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-blinking.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A blinking layer with cyan and a random secondary color" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-blinking.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A blinking layer with cyan and a random secondary color" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -133,7 +133,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-breathing.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A breathing layer with two random colors" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-breathing.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A breathing layer with two random colors" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -195,7 +195,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-glitch.gif?v=1bbe94f77e78d95af98555f206db5668" alt="" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-glitch.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -239,7 +239,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient-fill.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A rainbow Gradient Fill Layer on the alphabetical keys of the keyboard" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient-fill.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A rainbow Gradient Fill Layer on the alphabetical keys of the keyboard" loading="lazy" height="288" width="866" /> </picture> </p>Gradient Layerhttps://www.project-aurora.com/Docs/reference-layers/gradient/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/gradient/<p>The Gradient Layer shows a gradient effect on the specified keys. The gradient can also be animated to move across the keyboard to give a wave effect. If it helps to understand how it works, you can imagine the gradient to be displayed on a (possibly moving) rectangle, and each key acts as a “window” onto that rectangle.</p> <p> @@ -264,7 +264,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A rainbow Gradient Layer on the alphabetical keys" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-gradient.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A rainbow Gradient Layer on the alphabetical keys" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -330,7 +330,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-image.png?v=1bbe94f77e78d95af98555f206db5668" alt="An image layer displaying a picture of a landscape" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-image.png?v=a71d2854f2395d41ca466dcae81079a8" alt="An image layer displaying a picture of a landscape" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -374,7 +374,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-interactive.gif?v=1bbe94f77e78d95af98555f206db5668" alt="Pressing keys on an interactive layer with key wave mode" loading="lazy" height="290" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-interactive.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="Pressing keys on an interactive layer with key wave mode" loading="lazy" height="290" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -456,7 +456,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-fire.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A particle layer with the fire preset" loading="lazy" height="240" width="724" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-fire.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A particle layer with the fire preset" loading="lazy" height="240" width="724" /> </picture> @@ -481,7 +481,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-matrix.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A particle layer with the matrix preset" loading="lazy" height="239" width="724" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-particle-matrix.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A particle layer with the matrix preset" loading="lazy" height="239" width="724" /> </picture> </p>Percent (Gradient) Effect Layerhttps://www.project-aurora.com/Docs/reference-layers/percent-gradient-effect/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/percent-gradient-effect/<p>This layer is very similar to the Percent Effect Layer, but makes use of a gradient instead of a progress/background color. This layer does not have a background.</p> <p> @@ -506,7 +506,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-gradient-effect.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A gradient layer in progressive mode, with a red-green gradient assigned to the current millisecond" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-gradient-effect.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A gradient layer in progressive mode, with a red-green gradient assigned to the current millisecond" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -577,7 +577,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-effect.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A percent layer with current value set to the current time&rsquo;s milliseconds" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-percent-effect.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A percent layer with current value set to the current time&rsquo;s milliseconds" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -653,7 +653,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-radial.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A rainbow radial layer" loading="lazy" height="240" width="724" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-radial.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A rainbow radial layer" loading="lazy" height="240" width="724" /> </picture> </p> <p>Note that this gradient is generated using discrete pie-shaped segments of colour. This color is determined by the median color at a particular point on the gradient. For example, if there were 4 segments, each would have a 90 degree arc. The first would use the color at 45 degrees (90 / 2) the second at 135 degrees, etc. If you do not get the colors you expect when using small numbers of segments, this is likely the reason.</p>Script Layerhttps://www.project-aurora.com/Docs/reference-layers/script/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/script/<p>The script layer on its own will do nothing, however it is one of the most powerful, advanced layers. It provides an interface for users to create custom effects using the Aurora API in either C# or Python. More details can be found on the project&rsquo;s <a href="https://github.com/antonpup/Aurora/wiki/Profile-Scripting">Old-Wiki</a> and example scripts can be found in the <a href="https://github.com/antonpup/Aurora/tree/master/Script%20Examples">Script Examples</a> folder on GitHub. The limits of what this layer can do really are up to you.</p>Shortcut Assistant Layerhttps://www.project-aurora.com/Docs/reference-layers/shortcut-assistant/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/shortcut-assistant/<p>The Shortcut Assistant layer shows possible key presses when a modifier key is pressed. The defined shortcuts will set the keyboard lights when they are partially pressed. For example, if you had a shortcut defined for Ctrl + C and Ctrl + V, whenever you press control, the other layers below are dimmed and the C and V letter light up in whichever color is specified.</p> @@ -679,7 +679,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-shortcut.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A shortcut layer with common Ctrl and Ctrl + Shift shortcuts on top of a gradient layer" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-shortcut.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A shortcut layer with common Ctrl and Ctrl + Shift shortcuts on top of a gradient layer" loading="lazy" height="288" width="866" /> </picture> </p>Solid Color Layerhttps://www.project-aurora.com/Docs/reference-layers/solid-color/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/solid-color/<p>The Solid Color Layer is for setting static colors for specific keys. The keys will constantly be lit in the given color (providing they aren’t overridden by a higher-up layer). This is one of the most simple layers in Aurora, but can be useful for things such as highlighting controls such as WASD in video games.</p> <p> @@ -704,7 +704,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-color.png?v=1bbe94f77e78d95af98555f206db5668" alt="A Solid Color Layer lighting common video game control keys" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-color.png?v=a71d2854f2395d41ca466dcae81079a8" alt="A Solid Color Layer lighting common video game control keys" loading="lazy" height="288" width="866" /> </picture> </p> <p>If you want to set the color of the entire (or most) of the keyboard, consider using the <a href="https://www.project-aurora.com/Docs/reference-layers/solid-fill-color/">Solid Fill Color</a> Layer instead.</p>Solid Fill Color Layerhttps://www.project-aurora.com/Docs/reference-layers/solid-fill-color/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/solid-fill-color/<p>Similar to the Solid Color layer, however it does not have fine control over which keys are lit and so fills the entire canvas (keyboard, mouse and any other peripherals) with the given color. This layer is useful for setting static backgrounds, saving you from having to manually add each key.</p> @@ -730,7 +730,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-fill-color.png?v=1bbe94f77e78d95af98555f206db5668" alt="A Solid Fill Layer setting the entire keyboard to cyan" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-solid-fill-color.png?v=a71d2854f2395d41ca466dcae81079a8" alt="A Solid Fill Layer setting the entire keyboard to cyan" loading="lazy" height="288" width="866" /> </picture> </p> <h2 id="properties">Properties</h2> @@ -770,7 +770,7 @@ <picture> - <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-timer.gif?v=1bbe94f77e78d95af98555f206db5668" alt="A timer layer on the alphabetical keys" loading="lazy" height="288" width="866" /> + <img class="img-fluid" src="https://www.project-aurora.com/Docs/img/docs/layer-timer.gif?v=a71d2854f2395d41ca466dcae81079a8" alt="A timer layer on the alphabetical keys" loading="lazy" height="288" width="866" /> </picture> </p>Toggle Key Layerhttps://www.project-aurora.com/Docs/reference-layers/toggle-key/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/toggle-key/<p>The toggle key layer allows for the turning on or off some lights based on the key press of another specific key. This layer can be useful for things such as indicators for whether something is toggled on/off in a game.</p> <p><span class="alert info">If you are using caps lock, num lock or scroll lock as a trigger key it is probably better to use the Lock Layer to ensure the key light state stays synced with the lock state properly.</span></p>Toolbar Layerhttps://www.project-aurora.com/Docs/reference-layers/toolbar/Mon, 01 Jan 0001 00:00:00 +0000https://www.project-aurora.com/Docs/reference-layers/toolbar/<p>The toolbar layer is a layer that shows one key as “active” and all others assigned to it as “inactive”. When a different key is pressed, the pressed key becomes the active one instead. This works similarly to how toolbars/item bars work in video games such as Factorio or Minecraft.</p> diff --git a/reference-layers/interactive/index.html b/reference-layers/interactive/index.html index 0f125f3..dc54e4d 100644 --- a/reference-layers/interactive/index.html +++ b/reference-layers/interactive/index.html @@ -1,4 +1,4 @@ Interactive Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Interactive Layer


    Last updated 10.01.2024

    The interactive layer listens for key presses on the keyboard and plays an animation from that key. This can be used to make ripple effects (as shown in the GIF below) or have the key light up and slowly fade out when it’s been pressed.

    Pressing keys on an interactive layer with key wave mode

    Properties

    NameDescription
    Interactive Effect Type
    • Key Wave - A circle emerges from the pressed key and slowly expands. It is initially Primary Color, then fades to Secondary Color.
    • Key Fade - The pressed key turns the into the Primary Color then fades to Secondary Color then fades out.
    • Key Wave (Filled) - The same as "Key Wave" but is a filled circle rather than only a border.
    • Arrow Flow - A rectangle with a constant height is created at the location of the pressed key and it slowly increases in width.
    • Key Wave (Rainbow) - Same as "Key Wave" but the circle takes on a gradient color, with blue in the inner side and red on the outer side.
    Primary ColorThe solid color to set all the affected keys to during the first half of the animation.
    Use Random PrimaryTick this to use a random color during first part of the animation instead of using Primary Color.
    Secondary ColorThe solid color to set all the affected keys to during the second half of the animation.
    Use Random SecondaryTick this to use a random color during second half of the animation instead of using Secondary Color.
    Effect SpeedHow quick the animation plays. Higher = faster.
    Effect WidthHow thick the circle lines are for the "Key Wave"s, or how tall the rectangle is for "Arrow Flow".
    Start when key releasedWhether to star the animation when the key is released, instead of when it is first pressed.
    Excluded KeysA collection of keys that will not trigger the animations (but will still show the animation if it passes over).
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Interactive Layer


    Last updated 10.01.2024

    The interactive layer listens for key presses on the keyboard and plays an animation from that key. This can be used to make ripple effects (as shown in the GIF below) or have the key light up and slowly fade out when it’s been pressed.

    Pressing keys on an interactive layer with key wave mode

    Properties

    NameDescription
    Interactive Effect Type
    • Key Wave - A circle emerges from the pressed key and slowly expands. It is initially Primary Color, then fades to Secondary Color.
    • Key Fade - The pressed key turns the into the Primary Color then fades to Secondary Color then fades out.
    • Key Wave (Filled) - The same as "Key Wave" but is a filled circle rather than only a border.
    • Arrow Flow - A rectangle with a constant height is created at the location of the pressed key and it slowly increases in width.
    • Key Wave (Rainbow) - Same as "Key Wave" but the circle takes on a gradient color, with blue in the inner side and red on the outer side.
    Primary ColorThe solid color to set all the affected keys to during the first half of the animation.
    Use Random PrimaryTick this to use a random color during first part of the animation instead of using Primary Color.
    Secondary ColorThe solid color to set all the affected keys to during the second half of the animation.
    Use Random SecondaryTick this to use a random color during second half of the animation instead of using Secondary Color.
    Effect SpeedHow quick the animation plays. Higher = faster.
    Effect WidthHow thick the circle lines are for the "Key Wave"s, or how tall the rectangle is for "Arrow Flow".
    Start when key releasedWhether to star the animation when the key is released, instead of when it is first pressed.
    Excluded KeysA collection of keys that will not trigger the animations (but will still show the animation if it passes over).
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/lock-color/index.html b/reference-layers/lock-color/index.html index 7c7a824..067e8a8 100644 --- a/reference-layers/lock-color/index.html +++ b/reference-layers/lock-color/index.html @@ -1,4 +1,4 @@ Lock Color Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Lock Color Layer


    Last updated 10.01.2024

    The lock layer allows you to have keys light up (or pulse) in a color when one of the “lock” keys is active (caps lock, num lock or scroll lock). You can use this to make a warning for when caps lock is on for example, or perhaps turn off the lights on the numpad when the numpad is off.

    This layer functionality can be incorporated using the Overrides System. That said, it is simpler to use this layer for the pulse feature than to use the Override System alternative.

    Lock layer flashing alphabetical key when the caps lock is on

    Lock layer turning off the numpad lights when the numlock is off

    Properties

    NameDescription
    Lock KeyThe type of key to check whether it is locked or not. Valid options are: Capital, Scroll and NumLock.
    Off ColorThe solid color to use when the lock key is disabled/off.
    On ColorThe solid color to use when the lock key is enabled/on.
    PulseIf checked, the On Color will fade in and out when the lock key is active (as shown in the first screencap above).
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Lock Color Layer


    Last updated 10.01.2024

    The lock layer allows you to have keys light up (or pulse) in a color when one of the “lock” keys is active (caps lock, num lock or scroll lock). You can use this to make a warning for when caps lock is on for example, or perhaps turn off the lights on the numpad when the numpad is off.

    This layer functionality can be incorporated using the Overrides System. That said, it is simpler to use this layer for the pulse feature than to use the Override System alternative.

    Lock layer flashing alphabetical key when the caps lock is on

    Lock layer turning off the numpad lights when the numlock is off

    Properties

    NameDescription
    Lock KeyThe type of key to check whether it is locked or not. Valid options are: Capital, Scroll and NumLock.
    Off ColorThe solid color to use when the lock key is disabled/off.
    On ColorThe solid color to use when the lock key is enabled/on.
    PulseIf checked, the On Color will fade in and out when the lock key is active (as shown in the first screencap above).
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/particle/index.html b/reference-layers/particle/index.html index 6a87bfe..7b568fa 100644 --- a/reference-layers/particle/index.html +++ b/reference-layers/particle/index.html @@ -1,5 +1,5 @@ Particle Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Particle Layer


    Last updated 10.01.2024

    The particle layer spawns a number of particles which can independently move (based on the layer’s settings) and have a color. After a specified amount of time, the particles are removed from the canvas.

    Some examples of what can be done with this layer are shown below (both are available as presets), but this is by no means all that can be achieved. Experiment with it!

    A particle layer with the fire preset -A particle layer with the matrix preset

    There is no limit on the number of particles that can be spawned at once. If it is setup to spawn far too many at a time, you may see issues with CPU or memory usage or the program may crash. Be sensible with it.

    Properties

    Many of the properties listed here have a “min” and “max” value. For every particle, a random value between the two given values will be chosen when it is spawned.

    NameDescription
    Spawn locationThe location in which to spawn the particle. Either on an edge, randomly on the entire canvas or randomly within a specified region.
    Color (over time)A gradient that defines the color a particle should be at any given point in it’s lifespan. When the particle is newly spawned, it’s color will be at the far left of the gradient. At the end of it’s life, the particle’s color will be the value at the far right of the gradient.
    Spawn timeThe amount of time in seconds between a single particle (or a group of particles if spawn amount > 1) spawning.
    Spawn amountThe number of particles to spawn at a time.
    LifetimeNumber of seconds the particle will stay active before being removed.
    Initial horizontal velocityThe initial horizontal velocity of the particle in units per second. Can be negative to make the particle move left.
    Initial vertical velocityThe initial vertical velocity of the particle in units per second. Can be negative to make the particle move up.
    Horizontal accelerationThe acceleration of the particle in the horizontal direction. Applies the given value to the particle’s velocity per second. For example, if this was 1.5 and the particle’s velocity was 5, after 2 seconds the velocity will be 8. If positive, the particle will accelerate to the right; if negative it will accelerate to the left.
    Vertical accelerationThe acceleration of the particle in the vertical direction. Applies the given value to the particle’s velocity per second. For example, if this was 1.5 and the particle’s velocity was 5, after 2 seconds the velocity will be 8. If positive, the particle will accelerate downwards; if negative it will accelerate upwards.
    Horizontal dragA value between 0-1 which the horizontal velocity of the particle will be multiplied by. This allows for making the particle appear to naturally slow down.
    Vertical dragA value between 0-1 which the vertical velocity of the particle will be multiplied by. This allows for making the particle appear to naturally slow down.
    Initial particle sizeThe initial size of the particle.
    Size changeThe rate of change in the size of the particle measured in units per second.
    PresetsYou can choose a preset and press ‘Apply’ to set all the values of the particle layer from some predefined values.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Particle Layer


    Last updated 10.01.2024

    The particle layer spawns a number of particles which can independently move (based on the layer’s settings) and have a color. After a specified amount of time, the particles are removed from the canvas.

    Some examples of what can be done with this layer are shown below (both are available as presets), but this is by no means all that can be achieved. Experiment with it!

    A particle layer with the fire preset +A particle layer with the matrix preset

    There is no limit on the number of particles that can be spawned at once. If it is setup to spawn far too many at a time, you may see issues with CPU or memory usage or the program may crash. Be sensible with it.

    Properties

    Many of the properties listed here have a “min” and “max” value. For every particle, a random value between the two given values will be chosen when it is spawned.

    NameDescription
    Spawn locationThe location in which to spawn the particle. Either on an edge, randomly on the entire canvas or randomly within a specified region.
    Color (over time)A gradient that defines the color a particle should be at any given point in it’s lifespan. When the particle is newly spawned, it’s color will be at the far left of the gradient. At the end of it’s life, the particle’s color will be the value at the far right of the gradient.
    Spawn timeThe amount of time in seconds between a single particle (or a group of particles if spawn amount > 1) spawning.
    Spawn amountThe number of particles to spawn at a time.
    LifetimeNumber of seconds the particle will stay active before being removed.
    Initial horizontal velocityThe initial horizontal velocity of the particle in units per second. Can be negative to make the particle move left.
    Initial vertical velocityThe initial vertical velocity of the particle in units per second. Can be negative to make the particle move up.
    Horizontal accelerationThe acceleration of the particle in the horizontal direction. Applies the given value to the particle’s velocity per second. For example, if this was 1.5 and the particle’s velocity was 5, after 2 seconds the velocity will be 8. If positive, the particle will accelerate to the right; if negative it will accelerate to the left.
    Vertical accelerationThe acceleration of the particle in the vertical direction. Applies the given value to the particle’s velocity per second. For example, if this was 1.5 and the particle’s velocity was 5, after 2 seconds the velocity will be 8. If positive, the particle will accelerate downwards; if negative it will accelerate upwards.
    Horizontal dragA value between 0-1 which the horizontal velocity of the particle will be multiplied by. This allows for making the particle appear to naturally slow down.
    Vertical dragA value between 0-1 which the vertical velocity of the particle will be multiplied by. This allows for making the particle appear to naturally slow down.
    Initial particle sizeThe initial size of the particle.
    Size changeThe rate of change in the size of the particle measured in units per second.
    PresetsYou can choose a preset and press ‘Apply’ to set all the values of the particle layer from some predefined values.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/percent-effect/index.html b/reference-layers/percent-effect/index.html index b44a31d..7bbe500 100644 --- a/reference-layers/percent-effect/index.html +++ b/reference-layers/percent-effect/index.html @@ -1,4 +1,4 @@ Percent Effect Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Percent Effect Layer


    Last updated 10.01.2024

    The percent effect layer allows you to have the color of some set keys dependent on a numeric variable that can be provided by the computer (such as how much RAM or CPU is in use) or by the game if it is supported (e.g. health in CS:GO or speed in Euro Truck Sim).

    A percent layer with current value set to the current time’s milliseconds

    Properties

    NameDescription
    Current ValueThe path of a State Variable or a number. This value represents the current value of whichever variable you are watching, e.g. health, ammo, etc.
    Maximum ValueThe path of a State Variable or a number. This value represents the value that is the maximum value of the percent layer. This will be your max health, or max ammo etc.
    Progress ColorIn the case of progressive effect types: the color that the active keys will take. For example, if current was 50 and max was 100, then the first half of the keys will be lit this color. For "all at once": the color that will be mixed with the background color depending on the current/max ratio.
    Background ColorFor progressive effect types: the color that will appear if the key is not being shown in progress color. For "all at once": the color that will be mixed with the progress color depending on the current/max ratio.
    Effect Type
    • All at once - All keys in the affected keys sequence share the same color. This color will be given by a blend of progress and background depending on the current/max ratio. For example: if progress is green, background is blue, current is 30 and max is 100: all the keys will be set to a blend of 30% green, 70% blue.
    • Progressive - The keys will light up in progress color when they are active. For example: if there are 10 keys in the affected key list, progress is green, background is blue, current is 30 and max is 100: the first 3 keys will be green, the others blue.
    • Progressive (Gradual) - Same as progressive, but any keys that are partially active will have their color interpolated.
    Blink ThresholdIf the current/max percentage is less than this value, the "active" keys will fade in and out.
    Reverse Blink ThresholdIf this is true, the current/max percentage must be greater than the threshold for the active keys to flash.
    Blink BackgroundIf this is selected, the background will fade in and out instead of the active keys.
    Affected KeysA collection of keys that will display the progress bar or color. Note that for progressive effect types, the order of the keys in the list matters.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Percent Effect Layer


    Last updated 10.01.2024

    The percent effect layer allows you to have the color of some set keys dependent on a numeric variable that can be provided by the computer (such as how much RAM or CPU is in use) or by the game if it is supported (e.g. health in CS:GO or speed in Euro Truck Sim).

    A percent layer with current value set to the current time’s milliseconds

    Properties

    NameDescription
    Current ValueThe path of a State Variable or a number. This value represents the current value of whichever variable you are watching, e.g. health, ammo, etc.
    Maximum ValueThe path of a State Variable or a number. This value represents the value that is the maximum value of the percent layer. This will be your max health, or max ammo etc.
    Progress ColorIn the case of progressive effect types: the color that the active keys will take. For example, if current was 50 and max was 100, then the first half of the keys will be lit this color. For "all at once": the color that will be mixed with the background color depending on the current/max ratio.
    Background ColorFor progressive effect types: the color that will appear if the key is not being shown in progress color. For "all at once": the color that will be mixed with the progress color depending on the current/max ratio.
    Effect Type
    • All at once - All keys in the affected keys sequence share the same color. This color will be given by a blend of progress and background depending on the current/max ratio. For example: if progress is green, background is blue, current is 30 and max is 100: all the keys will be set to a blend of 30% green, 70% blue.
    • Progressive - The keys will light up in progress color when they are active. For example: if there are 10 keys in the affected key list, progress is green, background is blue, current is 30 and max is 100: the first 3 keys will be green, the others blue.
    • Progressive (Gradual) - Same as progressive, but any keys that are partially active will have their color interpolated.
    Blink ThresholdIf the current/max percentage is less than this value, the "active" keys will fade in and out.
    Reverse Blink ThresholdIf this is true, the current/max percentage must be greater than the threshold for the active keys to flash.
    Blink BackgroundIf this is selected, the background will fade in and out instead of the active keys.
    Affected KeysA collection of keys that will display the progress bar or color. Note that for progressive effect types, the order of the keys in the list matters.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/percent-gradient-effect/index.html b/reference-layers/percent-gradient-effect/index.html index 4900d9e..cba4712 100644 --- a/reference-layers/percent-gradient-effect/index.html +++ b/reference-layers/percent-gradient-effect/index.html @@ -1,4 +1,4 @@ Percent (Gradient) Effect Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Percent (Gradient) Effect Layer


    Last updated 10.01.2024

    This layer is very similar to the Percent Effect Layer, but makes use of a gradient instead of a progress/background color. This layer does not have a background.

    A gradient layer in progressive mode, with a red-green gradient assigned to the current millisecond

    Properties

    NameDescription
    Current ValueThe path of a State Variable or a number. This value represents the current value of whichever variable you are watching, e.g. health, ammo, etc.
    Maximum ValueThe path of a State Variable or a number. This value represents the value that is the maximum value of the percent layer. This will be your max health, or max ammo etc.
    Percent GradientA gradient brush whose color will define the color the affected keys will take.
    Background ColorFor progressive effect types: the color that will appear if the key is not being shown in progress color. For "all at once": the color that will be mixed with the progress color depending on the current/max ratio.
    Effect Type
    • All at once - All keys in the affected keys sequence share the same color. This color will be given by a blend of progress and background depending on the current/max ratio. For example: if progress is green, background is blue, current is 30 and max is 100: all the keys will be set to a blend of 30% green, 70% blue.
    • Progressive/Progressive (Gradual) - The keys will light up in percent gradient pattern when they are active. For example: if there are 10 keys in the affected key list, current is 30 and max is 100: the first 3 keys will be set to the color of the gradient, the others will not be set.
    Blink ThresholdIf the current/max percentage is less than this value, the "active" keys will fade in and out.
    Reverse Blink ThresholdIf this is true, the current/max percentage must be greater than the threshold for the active keys to flash.
    Affected KeysA collection of keys that will display the progress bar or color. Note that for progressive effect types, the order of the keys in the list matters.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Percent (Gradient) Effect Layer


    Last updated 10.01.2024

    This layer is very similar to the Percent Effect Layer, but makes use of a gradient instead of a progress/background color. This layer does not have a background.

    A gradient layer in progressive mode, with a red-green gradient assigned to the current millisecond

    Properties

    NameDescription
    Current ValueThe path of a State Variable or a number. This value represents the current value of whichever variable you are watching, e.g. health, ammo, etc.
    Maximum ValueThe path of a State Variable or a number. This value represents the value that is the maximum value of the percent layer. This will be your max health, or max ammo etc.
    Percent GradientA gradient brush whose color will define the color the affected keys will take.
    Background ColorFor progressive effect types: the color that will appear if the key is not being shown in progress color. For "all at once": the color that will be mixed with the progress color depending on the current/max ratio.
    Effect Type
    • All at once - All keys in the affected keys sequence share the same color. This color will be given by a blend of progress and background depending on the current/max ratio. For example: if progress is green, background is blue, current is 30 and max is 100: all the keys will be set to a blend of 30% green, 70% blue.
    • Progressive/Progressive (Gradual) - The keys will light up in percent gradient pattern when they are active. For example: if there are 10 keys in the affected key list, current is 30 and max is 100: the first 3 keys will be set to the color of the gradient, the others will not be set.
    Blink ThresholdIf the current/max percentage is less than this value, the "active" keys will fade in and out.
    Reverse Blink ThresholdIf this is true, the current/max percentage must be greater than the threshold for the active keys to flash.
    Affected KeysA collection of keys that will display the progress bar or color. Note that for progressive effect types, the order of the keys in the list matters.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/radial/index.html b/reference-layers/radial/index.html index cd831f9..5332be5 100644 --- a/reference-layers/radial/index.html +++ b/reference-layers/radial/index.html @@ -1,4 +1,4 @@ Radial Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Radial Layer


    Last updated 10.01.2024

    A layer that provides a gradient that rotates around a single point and optionally spins.

    A rainbow radial layer

    Note that this gradient is generated using discrete pie-shaped segments of colour. This color is determined by the median color at a particular point on the gradient. For example, if there were 4 segments, each would have a 90 degree arc. The first would use the color at 45 degrees (90 / 2) the second at 135 degrees, etc. If you do not get the colors you expect when using small numbers of segments, this is likely the reason.

    Properties

    NameDescription
    GradientThe gradient of the layer.
    Rotation speedThe rotation speed of the layer, in degrees per second. Positive will spin clockwise, negative for counter-clockwise.
    Segment countThe number of segments (see above) that are used to create the gradient. A lower number will result in distinct blocks of colour whereas a higher number will result in a smoother transition.
    Affected keysThe keys or region to apply the gradient to.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Radial Layer


    Last updated 10.01.2024

    A layer that provides a gradient that rotates around a single point and optionally spins.

    A rainbow radial layer

    Note that this gradient is generated using discrete pie-shaped segments of colour. This color is determined by the median color at a particular point on the gradient. For example, if there were 4 segments, each would have a 90 degree arc. The first would use the color at 45 degrees (90 / 2) the second at 135 degrees, etc. If you do not get the colors you expect when using small numbers of segments, this is likely the reason.

    Properties

    NameDescription
    GradientThe gradient of the layer.
    Rotation speedThe rotation speed of the layer, in degrees per second. Positive will spin clockwise, negative for counter-clockwise.
    Segment countThe number of segments (see above) that are used to create the gradient. A lower number will result in distinct blocks of colour whereas a higher number will result in a smoother transition.
    Affected keysThe keys or region to apply the gradient to.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/shortcut-assistant/index.html b/reference-layers/shortcut-assistant/index.html index ed51c55..ba2a8d3 100644 --- a/reference-layers/shortcut-assistant/index.html +++ b/reference-layers/shortcut-assistant/index.html @@ -1,4 +1,4 @@ Shortcut Assistant Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Shortcut Assistant Layer


    Last updated 10.01.2024

    The Shortcut Assistant layer shows possible key presses when a modifier key is pressed. The defined shortcuts will set the keyboard lights when they are partially pressed. For example, if you had a shortcut defined for Ctrl + C and Ctrl + V, whenever you press control, the other layers below are dimmed and the C and V letter light up in whichever color is specified.

    A shortcut layer with common Ctrl and Ctrl + Shift shortcuts on top of a gradient layer

    Properties

    NameDescription
    Dim BackgroundIf this is checked, when Aurora detects you a pressing a modifier key (Ctrl, Shift, Alt) then it will display Dimming Color over all keys before rendering the shortcut keys.
    ShortcutsA list of all shortcuts that should be displayed by the layer. To create a shortcut, click on the "New Shortcut" button, then "Assign" next to the new row of the table and press the keys on your keyboard. Once done, click the button again (now "Stop"). Multiple keys can be pressed at the same time and will appear in the shortcut.
    Dimming ColorIf Dim Background, this color is used to dim the background. A semi-transparent dark color is recommended.
    ColorThe color that the keys representing the shortcuts will be displayed.
    Presentation TypeFor shortcuts with longer sequences of keys, this option will dictate which keys become active and when. As an example, we shall consider the sequence Ctrl + Shift + A.
    • Show All Keys - Shows any shortcut that can be pressed that has the currently pressed buttons in its key list. In the example with this mode, when Ctrl is pressed, both Shift and A will light up.
    • Progressive Suggestion - Shows a shortcut only when all it's previous keys in the list are pressed. In the example, when Ctrl is pressed, only Shift will light up. When Ctrl + Shift are pressed, A will also light up.
    Trigger When Same Modifier Keys PressedIf this is checked, both control keys (left and right) and both shift keys (left and right) will trigger a shortcut bound to one of the keys. E.G. if there is a shortcut bound to LControlKey + A, then the right control key would also trigger this shortcut if this option was selected.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Shortcut Assistant Layer


    Last updated 10.01.2024

    The Shortcut Assistant layer shows possible key presses when a modifier key is pressed. The defined shortcuts will set the keyboard lights when they are partially pressed. For example, if you had a shortcut defined for Ctrl + C and Ctrl + V, whenever you press control, the other layers below are dimmed and the C and V letter light up in whichever color is specified.

    A shortcut layer with common Ctrl and Ctrl + Shift shortcuts on top of a gradient layer

    Properties

    NameDescription
    Dim BackgroundIf this is checked, when Aurora detects you a pressing a modifier key (Ctrl, Shift, Alt) then it will display Dimming Color over all keys before rendering the shortcut keys.
    ShortcutsA list of all shortcuts that should be displayed by the layer. To create a shortcut, click on the "New Shortcut" button, then "Assign" next to the new row of the table and press the keys on your keyboard. Once done, click the button again (now "Stop"). Multiple keys can be pressed at the same time and will appear in the shortcut.
    Dimming ColorIf Dim Background, this color is used to dim the background. A semi-transparent dark color is recommended.
    ColorThe color that the keys representing the shortcuts will be displayed.
    Presentation TypeFor shortcuts with longer sequences of keys, this option will dictate which keys become active and when. As an example, we shall consider the sequence Ctrl + Shift + A.
    • Show All Keys - Shows any shortcut that can be pressed that has the currently pressed buttons in its key list. In the example with this mode, when Ctrl is pressed, both Shift and A will light up.
    • Progressive Suggestion - Shows a shortcut only when all it's previous keys in the list are pressed. In the example, when Ctrl is pressed, only Shift will light up. When Ctrl + Shift are pressed, A will also light up.
    Trigger When Same Modifier Keys PressedIf this is checked, both control keys (left and right) and both shift keys (left and right) will trigger a shortcut bound to one of the keys. E.G. if there is a shortcut bound to LControlKey + A, then the right control key would also trigger this shortcut if this option was selected.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/solid-color/index.html b/reference-layers/solid-color/index.html index 42001ca..15c957b 100644 --- a/reference-layers/solid-color/index.html +++ b/reference-layers/solid-color/index.html @@ -1,4 +1,4 @@ Solid Color Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Solid Color Layer


    Last updated 10.01.2024

    The Solid Color Layer is for setting static colors for specific keys. The keys will constantly be lit in the given color (providing they aren’t overridden by a higher-up layer). This is one of the most simple layers in Aurora, but can be useful for things such as highlighting controls such as WASD in video games.

    A Solid Color Layer lighting common video game control keys

    If you want to set the color of the entire (or most) of the keyboard, consider using the Solid Fill Color Layer instead.

    Properties

    NameDescription
    ColorThe solid color to set all the affected keys to.
    Affected KeysA collection of keys that will be set to the above solid color.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Solid Color Layer


    Last updated 10.01.2024

    The Solid Color Layer is for setting static colors for specific keys. The keys will constantly be lit in the given color (providing they aren’t overridden by a higher-up layer). This is one of the most simple layers in Aurora, but can be useful for things such as highlighting controls such as WASD in video games.

    A Solid Color Layer lighting common video game control keys

    If you want to set the color of the entire (or most) of the keyboard, consider using the Solid Fill Color Layer instead.

    Properties

    NameDescription
    ColorThe solid color to set all the affected keys to.
    Affected KeysA collection of keys that will be set to the above solid color.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/solid-fill-color/index.html b/reference-layers/solid-fill-color/index.html index 883095e..50dac6b 100644 --- a/reference-layers/solid-fill-color/index.html +++ b/reference-layers/solid-fill-color/index.html @@ -1,4 +1,4 @@ Solid Fill Color Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Solid Fill Color Layer


    Last updated 10.01.2024

    Similar to the Solid Color layer, however it does not have fine control over which keys are lit and so fills the entire canvas (keyboard, mouse and any other peripherals) with the given color. This layer is useful for setting static backgrounds, saving you from having to manually add each key.

    A Solid Fill Layer setting the entire keyboard to cyan

    Properties

    NameDescription
    ColorThe solid color to set all the affected keys to.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Solid Fill Color Layer


    Last updated 10.01.2024

    Similar to the Solid Color layer, however it does not have fine control over which keys are lit and so fills the entire canvas (keyboard, mouse and any other peripherals) with the given color. This layer is useful for setting static backgrounds, saving you from having to manually add each key.

    A Solid Fill Layer setting the entire keyboard to cyan

    Properties

    NameDescription
    ColorThe solid color to set all the affected keys to.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/timer-key/index.html b/reference-layers/timer-key/index.html index 65ec051..0269fce 100644 --- a/reference-layers/timer-key/index.html +++ b/reference-layers/timer-key/index.html @@ -1,4 +1,4 @@ Timer Key Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Timer Key Layer


    Last updated 10.01.2024

    The timer layer waits for one or more keys to be pressed (do not have to be the keys displaying the lights) and sets the color of the keys to be something else for a set duration, after which they return to their original color. This layer can be used for things such as ability timers for games that have no game state integration.

    A timer layer on the alphabetical keys

    Properties

    NameDescription
    Default ColorThe color that the keys are by default and when the timer is not active.
    Active ColorThe color the keys turn when one of the triggers has been pressed.
    DurationThe duration (in milliseconds) that the timer takes.
    Animation Type
    • OnOff - When the trigger is pressed, the Affected Keys turn to active color and stays there for the Duration then immediately goes back to default.
    • Fade - When the trigger is pressed, the Affected Keys turn to active colors and then slowly fades back to the default color.
    Repeat Action
    • Reset - When a trigger is pressed while the timer is running, it will restart the timer anew.
    • Extend - When a trigger is pressed while the timer is running, it will extend the timer by Duration. E.G. if duration is 5000ms, and you press a trigger again 3000ms after pressing it for a first time, it would take 8000ms from the second press to completely reset.
    • Ignore - If a trigger is pressed while the timer is running, nothing will happen. The original timer will keep running as normal.
    Trigger KeysThe list of keybinds that will cause the timer to run. These keys won't light up (unless you add them to the Affected Keys)
    Affected KeysThe list of keys that will light up in default or active color. These keys will not trigger the timer.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Timer Key Layer


    Last updated 10.01.2024

    The timer layer waits for one or more keys to be pressed (do not have to be the keys displaying the lights) and sets the color of the keys to be something else for a set duration, after which they return to their original color. This layer can be used for things such as ability timers for games that have no game state integration.

    A timer layer on the alphabetical keys

    Properties

    NameDescription
    Default ColorThe color that the keys are by default and when the timer is not active.
    Active ColorThe color the keys turn when one of the triggers has been pressed.
    DurationThe duration (in milliseconds) that the timer takes.
    Animation Type
    • OnOff - When the trigger is pressed, the Affected Keys turn to active color and stays there for the Duration then immediately goes back to default.
    • Fade - When the trigger is pressed, the Affected Keys turn to active colors and then slowly fades back to the default color.
    Repeat Action
    • Reset - When a trigger is pressed while the timer is running, it will restart the timer anew.
    • Extend - When a trigger is pressed while the timer is running, it will extend the timer by Duration. E.G. if duration is 5000ms, and you press a trigger again 3000ms after pressing it for a first time, it would take 8000ms from the second press to completely reset.
    • Ignore - If a trigger is pressed while the timer is running, nothing will happen. The original timer will keep running as normal.
    Trigger KeysThe list of keybinds that will cause the timer to run. These keys won't light up (unless you add them to the Affected Keys)
    Affected KeysThe list of keys that will light up in default or active color. These keys will not trigger the timer.
    Page authored by
    \ No newline at end of file diff --git a/reference-layers/toolbar/index.html b/reference-layers/toolbar/index.html index 22cdca1..62e5efc 100644 --- a/reference-layers/toolbar/index.html +++ b/reference-layers/toolbar/index.html @@ -1,4 +1,4 @@ Toolbar Layer • reference-layers • Aurora Docs
    -Aurora User Docs

    Toolbar Layer


    Last updated 10.01.2024

    The toolbar layer is a layer that shows one key as “active” and all others assigned to it as “inactive”. When a different key is pressed, the pressed key becomes the active one instead. This works similarly to how toolbars/item bars work in video games such as Factorio or Minecraft.

    The layer can also be toggled to listen for the scroll wheel to allow scrolling through the toolbar by turning on the Enable Scroll configuration option. The order the keys are scrolled through is given by their order in the Affected Keys option, so if scrolling through is in the incorrect order, check the order of the keys here.

    The toolbar layer affecting the number keys

    Properties

    NameDescription
    Default ColorThe color of the inactive keys.
    Active ColorThe color of the active key.
    Enable ScrollWhether or not to allow the active key to be moved up and down when you scroll the mouse scroll wheel.
    Scroll LoopWhether or not to allow the scrolling to wrap from one end of the toolbar to the other. Only has an effect when Enable Scroll is true.
    Affected KeysThe keys that make up the toolbar layer. Note that if Enable Scroll is checked, the order of the keys matters.
    Page authored by
    \ No newline at end of file +Aurora User Docs

    Toolbar Layer


    Last updated 10.01.2024

    The toolbar layer is a layer that shows one key as “active” and all others assigned to it as “inactive”. When a different key is pressed, the pressed key becomes the active one instead. This works similarly to how toolbars/item bars work in video games such as Factorio or Minecraft.

    The layer can also be toggled to listen for the scroll wheel to allow scrolling through the toolbar by turning on the Enable Scroll configuration option. The order the keys are scrolled through is given by their order in the Affected Keys option, so if scrolling through is in the incorrect order, check the order of the keys here.

    The toolbar layer affecting the number keys

    Properties

    NameDescription
    Default ColorThe color of the inactive keys.
    Active ColorThe color of the active key.
    Enable ScrollWhether or not to allow the active key to be moved up and down when you scroll the mouse scroll wheel.
    Scroll LoopWhether or not to allow the scrolling to wrap from one end of the toolbar to the other. Only has an effect when Enable Scroll is true.
    Affected KeysThe keys that make up the toolbar layer. Note that if Enable Scroll is checked, the order of the keys matters.
    Page authored by
    \ No newline at end of file diff --git a/search/index.html b/search/index.html index 3a093a4..acb3d60 100644 --- a/search/index.html +++ b/search/index.html @@ -1,4 +1,4 @@ Search Results • Aurora Docs
    -Aurora User Docs
    Search Results
      \ No newline at end of file +Aurora User Docs
      Search Results
        \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 91d7ead..5b4a0c3 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://www.project-aurora.com/Docs/advanced-topics/2020-04-26T22:28:17+01:00https://www.project-aurora.com/Docs/integrations/lightfx/2024-01-02T18:03:57+01:00https://www.project-aurora.com/Docs/devices/alldevices/2024-01-02T17:29:33+01:00https://www.project-aurora.com/Docs/reference-layers/ambilight/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/advanced-topics/animation-editor/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/animation/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/devices/asus/2024-01-27T01:39:46+01:00https://www.project-aurora.com/Docs/reference-layers/audio-visualizer/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/advanced-topics/visualizer-output/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/basic-topics/2020-04-26T22:28:17+01:00https://www.project-aurora.com/Docs/reference-layers/blinking/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/integrations/integrations/2024-05-11T22:15:31+02:00https://www.project-aurora.com/Docs/integrations/2024-01-02T17:09:05+01:00https://www.project-aurora.com/Docs/reference-layers/breathing/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/conditional-comparisons/2020-04-27T00:04:29+01:00https://www.project-aurora.com/Docs/devices/corsair/2024-01-27T01:39:46+01:00https://www.project-aurora.com/Docs/devices/2024-01-02T17:09:05+01:00https://www.project-aurora.com/Docs/diagnostics/2024-05-06T13:42:04+02:00https://www.project-aurora.com/Docs/devices/dualsense/2024-01-05T20:49:19+01:00https://www.project-aurora.com/Docs/basic-topics/getting-started/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/glitch-effect/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/gradient-fill/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/gradient/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/image/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/input/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/basic-topics/installation/2024-01-16T21:01:18+01:00https://www.project-aurora.com/Docs/reference-layers/interactive/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/2020-04-27T16:55:57+01:00https://www.project-aurora.com/Docs/reference-layers/lock-color/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/logic/2020-06-06T22:36:56+01:00https://www.project-aurora.com/Docs/devices/logitech/2024-01-27T01:39:46+01:00https://www.project-aurora.com/Docs/integrations/lightsync/2024-10-01T20:26:32+02:00https://www.project-aurora.com/Docs/reference-expressions/maths/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/misc/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/basic-topics/games/2024-01-02T18:03:57+01:00https://www.project-aurora.com/Docs/devices/openrgb/2024-01-16T21:22:29+01:00https://www.project-aurora.com/Docs/advanced-topics/overrides-system/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/particle-interactive/2020-04-27T15:07:17+01:00https://www.project-aurora.com/Docs/reference-layers/particle/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/percent-gradient-effect/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/percent-effect/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/radial/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/devices/razer/2024-01-21T21:20:11+01:00https://www.project-aurora.com/Docs/integrations/chroma/2024-10-01T20:26:32+02:00https://www.project-aurora.com/Docs/reference-expressions/2020-04-27T16:55:57+01:00https://www.project-aurora.com/Docs/reference-layers/2020-04-27T16:55:57+01:00https://www.project-aurora.com/Docs/diagnostics/repair-wmi/2024-05-06T14:03:53+02:00https://www.project-aurora.com/Docs/reference-layers/script/2024-01-03T11:19:19+01:00https://www.project-aurora.com/Docs/search/2020-04-27T15:11:52+01:000.1https://www.project-aurora.com/Docs/reference-layers/shortcut-assistant/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/solid-color/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/solid-fill-color/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/state/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/advanced-topics/state-variables/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/devices/steelseries/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/string/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/reference-layers/timer-key/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/toggle-key/2020-04-27T00:04:29+01:00https://www.project-aurora.com/Docs/reference-layers/toolbar/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/basic-topics/user-data/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/devices/wooting/2024-01-05T20:49:19+01:00https://www.project-aurora.com/Docs/reference-layers/wrapper/2024-01-05T20:49:19+01:00 \ No newline at end of file +https://www.project-aurora.com/Docs/advanced-topics/2020-04-26T22:28:17+01:00https://www.project-aurora.com/Docs/integrations/lightfx/2024-01-02T18:03:57+01:00https://www.project-aurora.com/Docs/devices/alldevices/2024-01-02T17:29:33+01:00https://www.project-aurora.com/Docs/reference-layers/ambilight/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/advanced-topics/animation-editor/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/animation/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/devices/asus/2024-01-27T01:39:46+01:00https://www.project-aurora.com/Docs/reference-layers/audio-visualizer/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/advanced-topics/visualizer-output/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/basic-topics/2020-04-26T22:28:17+01:00https://www.project-aurora.com/Docs/reference-layers/blinking/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/integrations/integrations/2024-10-02T16:57:47+02:00https://www.project-aurora.com/Docs/integrations/2024-01-02T17:09:05+01:00https://www.project-aurora.com/Docs/reference-layers/breathing/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/conditional-comparisons/2020-04-27T00:04:29+01:00https://www.project-aurora.com/Docs/devices/corsair/2024-01-27T01:39:46+01:00https://www.project-aurora.com/Docs/devices/2024-01-02T17:09:05+01:00https://www.project-aurora.com/Docs/diagnostics/2024-05-06T13:42:04+02:00https://www.project-aurora.com/Docs/devices/dualsense/2024-01-05T20:49:19+01:00https://www.project-aurora.com/Docs/basic-topics/getting-started/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/glitch-effect/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/gradient-fill/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/gradient/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/image/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/input/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/basic-topics/installation/2024-01-16T21:01:18+01:00https://www.project-aurora.com/Docs/reference-layers/interactive/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/2020-04-27T16:55:57+01:00https://www.project-aurora.com/Docs/reference-layers/lock-color/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/logic/2020-06-06T22:36:56+01:00https://www.project-aurora.com/Docs/devices/logitech/2024-01-27T01:39:46+01:00https://www.project-aurora.com/Docs/integrations/lightsync/2024-10-02T16:57:47+02:00https://www.project-aurora.com/Docs/reference-expressions/maths/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/misc/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/basic-topics/games/2024-01-02T18:03:57+01:00https://www.project-aurora.com/Docs/devices/openrgb/2024-01-16T21:22:29+01:00https://www.project-aurora.com/Docs/advanced-topics/overrides-system/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/particle-interactive/2020-04-27T15:07:17+01:00https://www.project-aurora.com/Docs/reference-layers/particle/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/percent-gradient-effect/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/percent-effect/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/radial/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/devices/razer/2024-01-21T21:20:11+01:00https://www.project-aurora.com/Docs/integrations/chroma/2024-10-02T16:57:47+02:00https://www.project-aurora.com/Docs/reference-expressions/2020-04-27T16:55:57+01:00https://www.project-aurora.com/Docs/reference-layers/2020-04-27T16:55:57+01:00https://www.project-aurora.com/Docs/diagnostics/repair-wmi/2024-05-06T14:03:53+02:00https://www.project-aurora.com/Docs/reference-layers/script/2024-01-03T11:19:19+01:00https://www.project-aurora.com/Docs/search/2020-04-27T15:11:52+01:000.1https://www.project-aurora.com/Docs/reference-layers/shortcut-assistant/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/solid-color/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/solid-fill-color/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/state/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/advanced-topics/state-variables/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/devices/steelseries/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-expressions/string/2020-04-28T11:04:39+01:00https://www.project-aurora.com/Docs/reference-layers/timer-key/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/reference-layers/toggle-key/2020-04-27T00:04:29+01:00https://www.project-aurora.com/Docs/reference-layers/toolbar/2024-01-10T03:07:45+01:00https://www.project-aurora.com/Docs/basic-topics/user-data/2024-10-02T16:57:47+02:00https://www.project-aurora.com/Docs/devices/wooting/2024-01-05T20:49:19+01:00https://www.project-aurora.com/Docs/reference-layers/wrapper/2024-01-05T20:49:19+01:00 \ No newline at end of file