Skip to content

Commit

Permalink
readibility and link updates for user data and integration pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Aytackydln committed Oct 2, 2024
1 parent 0eeddec commit a35c547
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 19 deletions.
47 changes: 32 additions & 15 deletions content/basic-topics/user-data.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,56 @@
---
searchTitle: Aurora User Data Folder
title: User Data
order: 4
authors:
- Wibble199
- Aytackydln
---

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.
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]({{% ref "#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.
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]({{% ref "#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.
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.
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.
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.
1. 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.
1. 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](img/docs/aurora-user-data-directory.png)
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).

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.
![Finding the Aurora user data directory](img/docs/aurora-user-data-directory.png)
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.
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.
1. 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.
1. There will be a folder called "Aurora" in here. Simply delete, move or rename that folder.
1. When you next re-open Aurora, it will recreate all the necessary data with the default configuration: default settings, default profiles, etc.
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.
2 changes: 1 addition & 1 deletion content/integrations/chroma.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ authors:

![Diagram showing Aurora Chroma integration](img/chroma_diagram.png)

You can use Chroma integration with [all supported devices]({{< relref "/devices/alldevices.md" >}})
You can use Chroma integration with [all supported devices]({{< relref "/devices/alldevices.md" >}}) using Aurora

> Note that this is reverse engineered and may not work as the original.
Expand Down
5 changes: 5 additions & 0 deletions content/integrations/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,9 @@ order: 1
Some of the brand specific game integrations are reverse-engineered to work with Aurora.
See their pages to see how they are configured.

## Game Integrations Aurora Supports
- [Chroma]({{< relref "/integrations/chroma.md" >}})
- [Lightsync]({{< relref "/integrations/lightsync.md" >}})
- [LightFX]({{< relref "/integrations/lightfx.md" >}})

[PCGamingWiki page about integrations](https://www.pcgamingwiki.com/wiki/RGB_lighting_middleware)
2 changes: 1 addition & 1 deletion content/integrations/lightsync.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ authors:

![Diagram showing Aurora & Lightsync integration](img/lightsync_diagram.png)

You can use Lightsync integration with [all supported devices]({{< relref "/devices/alldevices.md" >}})
You can use Lightsync integration with [all supported devices]({{< relref "/devices/alldevices.md" >}}) using Aurora

> Note that this is reverse engineered and may not work as the original.
Expand Down
4 changes: 2 additions & 2 deletions themes/aurora/layouts/_default/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
<a href="{{ "/reference-layers" | relURL }}" class="button">
<p class="item-title">Layers list</p>
</a>
<a href="{{ "/reference-expressions" | relURL }}" class="button">
<p class="item-title">Override expressions list</p>
<a href="{{ "/integrations" | relURL }}" class="button">
<p class="item-title">Brand Specific Integrations</p>
</a>
</div>
</section>
Expand Down

0 comments on commit a35c547

Please sign in to comment.