forked from antonpup/Aurora
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into release/v0.7
- Loading branch information
Showing
6 changed files
with
107 additions
and
37 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: Report an issue with how the program works. | ||
| labels: bug | ||
| --- | ||
| <!-- | ||
| Thank you for reporting your issues to us, helping to make Aurora better! :) | ||
| Please make sure you SEARCH for an issue similar to yours before submitting your issue - it might already have been answered. | ||
| If you haven't found a similar issue, please answer all the questions below to the best of your ability. More accurate bug reports help us pinpoint the problem quicker and easier. When you fill in the responses, make sure to delete the square brackets as comments inside these are not visible in the report. | ||
| If you have log files or screenshots that may help, please also attach them to the issue. The logs can be found in %APPDATA%\Aurora\Logs | ||
| --> | ||
| ### Expected Behaviour | ||
| <!-- Write what should be happening here. --> | ||
|
|
||
| ### Actual Behaviour | ||
| <!-- Explain what actually happens here. --> | ||
|
|
||
| ### Reproduction steps | ||
| <!-- If you can, please provide detailed step-by-step instructions on how to reproduce this issue. --> | ||
|
|
||
| ### Frequency | ||
| <!-- How often does this issue occur? Every time? Only sometimes? --> | ||
|
|
||
| ### Aurora Version: | ||
| <!-- Which version of Aurora are you using that's causing the problem? (You can see this on the about page under settings) --> | ||
|
|
||
| ### Previously an Issue? | ||
| <!-- Did the previous version of Aurora have this issue? Yes/No/Don't know --> | ||
|
|
||
| <!-- | ||
| Once you're done, check the preview tab. You should see a nice table with your issue text. | ||
| If it all looks correct, submit the issue :) Again, thank you for your report. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| name: Device Request | ||
| about: Request support for a new hardware device. | ||
| labels: hardware support | ||
| --- | ||
| <!-- | ||
| Please make sure you SEARCH for any other issues requesting your device before submitting your issue - it might already have been requested. | ||
| If you haven't found a similar issue, please carry on. Make sure that when you fill in the responses you delete the square brackets as comments inside these are not visible in the bug report. | ||
| To be able to add support for a particular device (keyboard, mouse, etc.), we need to be able to access an SDK. A Software Development Kit (SDK) is a code library that allows manufacturers to provide an way of controlling things with Aurora. It has various procedures programmed into it that we developers can use to send our own colour data to the keyboards or other devices. The SDK handles things such as making sure the data is in the right format, establishing a connection with the keyboard and anything else that needs to be done to make it work. | ||
| There may also be other open source projects on GitHub that we are able to use instead of needing the official SDK. | ||
| Please have a quick look on the manufacturer's website for an SDK (maybe under a section titled 'developers'). Please also search GitHub to see if there are any projects on there that might help. | ||
| Without an SDK, the only way to implement lighting in Aurora is to attempt to reverse-engineer packets of data sent from the PC software to the device, however this is a VERY SLOW PROCESS and the dev team do not have enough time to do this. If you join our Discord, we may be able to help you do this yourself if you choose to. | ||
| --> | ||
|
|
||
| Please add support for the following device: | ||
|
|
||
| **Device Name:** <!-- Make/model of device --> | ||
|
|
||
| **Device Website:** <!-- Please add a link to the manufacturer's website --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| name: Enhancement | ||
| about: Got an idea for a new feature for Aurora? Put it here. | ||
| labels: enhancement | ||
| --- | ||
| <!-- | ||
| Thank you for helping to improve the Aurora lighting software. | ||
| Please describe your suggested idea in-depth below. What will it do? How will it work? | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| name: Game Request | ||
| about: Request support for a new game or application. | ||
| labels: game support | ||
| --- | ||
| <!-- | ||
| Please make sure you SEARCH for any other issues requesting this game before submitting your issue - it might already have been requested. | ||
| If you haven't found a similar issue, please carry on. Make sure that when you fill in the responses you delete the square brackets as comments inside these are not visible in the bug report. | ||
| To be able to add game state support for a particular game we need a way of reading the values from the game. This can be done in one of several ways: | ||
| 1. Sometimes the game itself makes the relevant variables available (e.g. CSGO, Dota 2). This is quite uncommon and your requested game probably won't do this. | ||
| 2. Another option is mod support. Depending on the level of support, we may be able to make a custom mod that gets useful variables and sends them (via HTTP request) to Aurora (e.g. Minecraft, Subnautica). | ||
| 3. We may be able to read values from the game itself using memory reading. This WILL NOT BE DONE ON MULTIPLAYER GAMES or games with anti-cheat as memory reading can be used by cheats to give players an advantage, and so many anti-cheat systems will flag you if memory reading is detected. | ||
| 4. If the game already has support for lighting (e.g. it natively supports Razer Chroma) you may be able to patch the game and use the wrapper layer on Aurora to get the values from the existing system. This does not always work as sometimes games will not load modified DLLs. For this to work, we do not need to add anything special and you do not need to make an issue. | ||
| We are continuing to look at other options of getting data from games (such as optical character recgonition). Sadly if your game does not fit into any of the above groups, then Aurora cannot currently support your requested game. | ||
| If it does, feel free to fill in the following report and submit the issue. | ||
| --> | ||
|
|
||
| Please add support for the following game: | ||
|
|
||
| **Game Name:** <!-- What game is it? --> | ||
|
|
||
| **Methods:** <!-- Please tell us which methods of getting data this game has (see above). Native GSI/Mod support/Memory reading --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters