|
| 1 | +--- |
| 2 | +title: Profiles |
| 3 | +weight: 2 |
| 4 | +description: |
| 5 | + Detailed guide with photos showing you how to use profiles and layers in Aurora. |
| 6 | +authors: |
| 7 | + - Wibble199 |
| 8 | +--- |
| 9 | + |
| 10 | +When you first open Aurora, you will be presented with a window that looks like the following. |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +## Applications |
| 15 | +On the far left is the **application** list, with each application shown as an icon. |
| 16 | +All the applications and games you will see here by default have some sort of integration or preset profile. |
| 17 | +You are not limited to just these ones however; |
| 18 | +by scrolling to the bottom of the list and clicking the plus icon you can create new applications. |
| 19 | + |
| 20 | +You can disable applications if you don’t want your lighting changing when you open that app by right clicking the icon and un-checking the “Enabled” box. |
| 21 | +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. |
| 22 | + |
| 23 | +Aurora works by detecting the application that is currently focused and checking if it has an application entry for that application. |
| 24 | +If it does, it will render the active profile (we'll see what a profile is in the next section) to your peripherals. |
| 25 | +If it does not, it will render the "Desktop" application's selected profile. |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +## Profiles |
| 31 | +**Profiles** are a collection of layers that will be drawn to the keyboard whenever that application is currently open (and in the foreground). |
| 32 | +An application can have one or more profiles, but only one profile can be active at once. |
| 33 | +You can assign keys to each profile allowing you to switch between them when a specific button is pressed. |
| 34 | + |
| 35 | +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. |
| 36 | +The list below this button will then show you all the profiles of the application. From here you can: |
| 37 | +- Add a new profile by clicking the "Add" button. |
| 38 | +- Delete profiles by clicking the red "X" button. |
| 39 | +- Import a profile from .json file. |
| 40 | +- Export your profile as a .json file. |
| 41 | +- Copy/paste profiles to duplicate them or add them to another application. |
| 42 | +- Reset the profile to the default state. |
| 43 | +- Rename a profile by clicking on it, then typing a name in the "Profile name" box in the properties panel |
| 44 | +- Assign a key to select a profile by clicking on it, |
| 45 | +- then clicking "Assign" next to "Keybind to active profile" in the properties panel then pressing the keys on your keyboard you want. |
| 46 | + |
| 47 | + |
| 48 | +## Layers |
| 49 | +A **Layer** is an instruction for Aurora to set the color of some specific keys on your keyboard. |
| 50 | +Each layer has different functionality which is detailed in a [later section of this guide]({{% ref "reference-layers/solid-color" %}}). |
| 51 | +The layers are drawn from bottom-to-top, therefore anything higher up the list will take priority over the colors of anything lower down. |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +To show the layers list, click the "Layers" list view button that will be at the top left or bottom left of the window |
| 56 | +(depending on whether the profile list is open or not). |
| 57 | +A list will appear below this button showing you all your layers. From here you can: |
| 58 | +- Add new layers by clicking on the "Add" button above the layer list. |
| 59 | +- 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. |
| 60 | +- Change the layer properties by clicking on a layer and using the properties panel. |
| 61 | +- Delete the layer by selecting it and clicking the red "X" button. |
| 62 | +- Re-order layers by clicking and dragging the triple horizontal line (burger) button next to the layer. |
| 63 | + |
| 64 | +### Global Layers |
| 65 | +Global layers are different from regular layers in that they appear whenever a particular process is running (or in the case of desktop global layers, always). |
| 66 | +For example, if you create a profile for Spotify and add a audio visualizer as an overlay, |
| 67 | +the visualizer will always appear whenever Spotify is open, regardless of whether you have it in the foreground or not. |
| 68 | + |
| 69 | +Note that the layers and global layers for a profile can be enabled/disabled independently. |
| 70 | +With the Spotify example, if you disable the regular layers for the profile but keep the global layers, |
| 71 | +your desktop profile will stay active when Spotify is in the foreground instead of going blank with only the global layers. |
| 72 | + |
| 73 | +### Layer Properties |
| 74 | +Each layer will have a set of properties that you can change such as color or the keys it affects. |
| 75 | +This can be changed in the bottom right panel, the Properties Panel. |
| 76 | +The properties available to each layer are listed in the reference section of this guide that can be accessed in the navigation list. |
0 commit comments