Skip to content
This repository has been archived by the owner on Jul 24, 2022. It is now read-only.

Latest commit

 

History

History
464 lines (345 loc) · 16.8 KB

README.md

File metadata and controls

464 lines (345 loc) · 16.8 KB

Aurora - Unified Lighting Effects

Aurora Logo

Link to Aurora's webpage, includes some demos and changelogs

Latest Version Total Downloads Build status Build status

Project Aurora is a utility that unifies RGB lighting devices across different brands and enables them to work alongside each other, all while adding and improving RGB lighting support for various games that previous had none or little RGB lighting support. Aurora is mainly written in C#, but has C++ components to implement native support for other games.

Download

Latest stable release

Most recent release (potentially unstable)

Bleeding-edge builds (decent chance they're going to have issues)

Discord Server

Having issues? Want to discuss changes or talk about possible features? Want to be involved in the development and design process of Aurora? Join our Discord server and get involved!

How to Install

AUTOMATIC

  1. Download the 'Aurora-setup-vX.X.X.exe' from any of the options found under the Download section, every recent release should have this available
  2. Run the executable and install it, all requirements should be installed for you.
  3. Start using Aurora!

MANUAL

  1. First of all, make sure that your PC meets the requirements listed above. Also, make sure that you have Visual C++ Redistributable Packages for Visual Studio 2017 and Microsoft .NET Framework 4.6.1 installed.
  2. Download the latest release from above
  3. Extract the archive anywhere on your computer. Preferably keep it in a location you can easily access.
  4. Run "Aurora.exe", from that point, Aurora should provide you with further instructions and options.

Natively Supported Games

  • Dota 2
  • CS:GO
  • Grand Theft Auto V
  • Rocket League
  • Overwatch
  • Payday 2
  • The Division
  • League of Legends
  • Hotline Miami
  • The Talos Principle
  • Battlefield 3
  • Blacklight: Retribution
  • Magic: The Gathering - Duels of the Planeswalkers 2012
  • Middle-earth: Shadow of Mordor
  • Serious Sam 3
  • Robot Roller-Derby Disco Dodgeball
  • XCOM: Enemy Unknown
  • Evolve Stage 2
  • Metro: Last Light
  • Guild Wars 2
  • Worms W.M.D
  • Blade and Soul
  • Borderlands 2
  • Minecraft
  • Euro Truck Simulator 2
  • American Truck Simulator
  • Rise of the Tomb Raider
  • Dying Light
  • Quantum Conumdrum
  • Move or Die
  • Battlefield 1
  • Dishonored
  • The Witcher 3
  • Minecraft
  • Killing Floor 2
  • DOOM (2016)
  • Factorio
  • Quake Champions
  • Diablo III

Natively Supported Devices

If you don't see some of these devices in the menu, select a similar one and it will probably work. Submit an issue for proper support in the interface! Devices from supported brands generally should work even if they aren't listed here.

Logitech

  • Most Logitech Lightsync devices should work

Keyboards

  • G410
  • G512
  • G513
  • G810
  • G910
  • G PRO

Mice

  • G203
  • G403
  • G502
  • G900
  • G903
  • G703
  • G PRO

Corsair

  • Most Keyboards, Mice, Headsets and mousepads should work.

Keyboards

  • K68
  • K65
  • K70 LUX
  • K95
  • K95 Platinum
  • STRAFE Non-RGB/RGB

Mice

  • Scimitar RGB
  • Dark Core RGB
  • M65 RGB
  • Glaive RGB

Other Peripherals

  • ST100 Headset Stand
  • MM800 Mousepad

Razer

  • Most Chroma enabled devices should work

Keyboards

  • Huntsman
  • Huntsman Elite
  • BlackWidow Chroma

Mice

  • Abyssus Essential
  • Naga Hex/Trinity
  • Lancehead
  • Mamba & Elite
  • DeathAdder Elite
  • Basilisk

Mousepads

  • Firefly

Cooler Master

  • Masterkeys Pro L, M and S RGB/White
  • MK750
  • CK372
  • CK552
  • CK551

Roccat

Keyboards

  • Ryos MK FX

Mice

  • Kone Pure & SE

SteelSeries

Keyboards

  • Apex M800
  • Apex M750
  • Apex M750 TKL

Mice

  • Rival 600
  • Rival 700
  • Rival 310
  • Rival 300

Wooting

  • One

Alienware

  • All laptop models until AW15 R3/AW17 R4 (AW broke support for per-key RGB)

Clevo

AtmoOrb

Dualshock 4 (PS4 Controller)

Drevo

  • Blademaster

SoundBlasterX

  • Vanguard K08

Video demonstrations

Dota 2 Demo

Dota 2 Demo

Rocket League Demo

Rocket League Demo

Grand Theft Auto V Demo

Grand Theft Auto V Demo

Robot Roller-Derby Disco Dodgeball Demo

Robot Roller-Derby Disco Dodgeball Demo

Screenshots

Desktop Settings Dota 2 Settings CSGO Settings GTA 5 Settings Rocket League Settings Payday 2 Settings Euro Truck Simulator 2 / American Truck Simulator Settings Skype Integration Settings

In-depth features

General

  • Display volume percentage on the keyboard
  • Display CPU and Memory usage on the keyboard
  • Layering system for effects
  • Define custom layers with individual effects
  • Key selection via freeform region
  • Customizable “away from keyboard” effects
  • Set global peripheral brightness on the fly without having to leave your game
  • Completely turn off peripheral lights after a specific time
  • Interactive keyboard effects such as: Key Fade, Key Wave, and Arrow Flow
  • Preview lighting effects without having to launch the game
  • Simultaneous support for different brands of RGB peripheral devices
  • Support for a wide range of models from all the top brands of RGB peripherals
  • Support for almost any Logitech LED and Razer Chroma supported games
  • Add other programs to define custom lighting layers for daytime and nighttime themes
  • Display shortcut keys with Shortcuts Assistant
  • Automatic updater
  • Ability to select your preferred keyboard layout and brand
  • Ability to select your mouse, and it's orientation (left/right handed)
  • Import/Export for profile settings
  • Customizable gradient layers
  • Scripting support for custom lighting effects & custom devices

Dota 2 features

  • Team-based background lighting
  • Respawn effect
  • Killstreak effect
  • Health and Mana indicators
  • Ability and Item indicators
  • Hero ability effects

CS:GO features

  • Team-based background lighting
  • Health and Ammo indicators
  • Bomb effect
  • Kill indicators
  • Burning and Flashbang effects
  • Chat/Console typing keys

Grand Theft Auto V features

  • Dynamic background lighting (based on current character or race position)
  • Custom police siren effects

Rocket League features

  • Team-based background lighting
  • Score-split for background effect
  • Boost indicator
  • Goal Explosions

Overwatch features

  • Overwatch effects are controlled by the game itself

Payday 2 features

  • Assault-based background lighting effects
  • Suspicion background effect
  • Player health and ammo indicators

The Division features

  • The Division effects are controlled by the game itself

League of Legends features

  • League of Legends reacts to player HP, when damaged, healed, or killed.

Hotline Miami features

  • Hotline Miami has a slowly alternating color effect.

The Talos Principle features

  • The Talos Principle changes color based on the puzzle color you are in.

Borderlands 2 features

  • Health and Shield indicators

Minecraft features

  • Healthbar
  • XP bar
  • Armor and hunger bars (not on the default profile but can easily be added)
  • Flame effect when player burns
  • Raindrops when world is raining
  • Background based on time-of-day

Euro Truck Simulator 2 / American Truck Simulator features

  • Throttle/braking indicators
  • RPM meter
  • Blinkers
  • Beacons
  • Fuel/air pressure indicators
  • Ignition indicator

Quantum Conumdrum features

  • Changes color based on what dimension you are in.

Move or Die features

  • Move or Die effects are controlled by the game itself.

Battlefield 1 features

  • Flashes red when you take damage.
  • Lights up keybindings.

Dishonored features

  • Health and Mana indicators.
  • Potion indicators.

The Witcher 3 features

  • Current active sign as background.
  • Health, Toxicity, and Stamina indicators.

Minecraft features

  • Health, hunger, experience, and other indicators
  • Day/Night indicator
  • Rain and Fire indicator

Killing Floor 2 features

  • Killing Floor 2 effects are controlled by the game itself

DOOM features

  • DOOM effects are controlled by the game itself

Quake Champions features

  • Quake Champions effects are controlled by the game itself

Factorio features

  • Factorio effects are controlled by the game itself

Diablo III features

  • Diablo III effects are controlled by the game itself

F.A.Q.

Can this give me a ban in a video game?

Support for all included games is tested to be sure not to trigger any anti-cheats or produce any suspicious behavior. With that said, the software is to be used at your own risk. We cannot prevent game developers from adding anti-cheats or blocking ways Aurora retrieves information from the game.

Are you going to support more devices?

Yes, we are going to support anything that has an SDK.

I can't find an option for my Device in the settings!

Those listed are purely different layouts, if your device is made by a brand that is supported, try selecting a device that has a similar layout to yours and see if that works! If not, check if the integration is connected under 'Device Manager', if you can't get it to connect, check if there is an issue open for your device, if not, feel free to open one.

Are you going to support more games?

Yes, we will be looking into requested games. You can suggest/request game support here.

Are you open to doing collaborations with other RGB projects or game companies?

Definitely! If you have a project that you think can fit Aurora, feel free to send me an e-mail.

I would like to request support for a game, how do I do that?

You can make suggestions by posting an issue here, outlining what you would like to request, and I will look over it.

Some keys in the program state that they are not supported. What does this mean?

It means that changes to those keys are not currently possible. When it's possible to change those keys via SDK, then their support will be added.

Aurora is constantly crashing! Help!

You can report crashes and other issues on Github. Please include a brief explanation of how to reproduce the crash and include the most recent log file. Log files can be located in the "%appdata%/Aurora/Logs" directory, or by going to Settings -> Debug and clicking 'Show Logs Folder'.

I have found a bug. How do I report it?

You can report bugs here, by creating a new Issue here. Before posting an issue, please try and see if there is an issue the same as yours that has already been posted, if not, then feel free to post a new one.

I wish to expand this, fix bugs, and add my own features.

Feel free to fork this repo and make pull requests with your own code. I am open for suggestions for both features and optimization. :)

What is the purpose of this utility?

The main goal of Aurora is to allow RGB peripheral devices to work alongside other RGB peripheral devices from other brands. Meaning, if you own a combination of Logitech, Razer, or Corsair peripheral devices, they should be able to work together.

Secondary goal of Aurora is to integrate RGB lighting into popular games. RGB lighting is a nifty feature that is often underused, and as a result gamers with RGB gear are unable to utilize the lighting effects that they paid for.

Development Team

  • simon-wh Lead Developer (since May 2017), Developer (July 2016 - May 2017)
  • Antonpup Owner, Lead Developer (until May 2017)

Minor Announcement

I (@Antonpup) will no longer be able to develop this project further due to my new future job. I have handed over the project development to @Simon W. He has access to everything in order to push new updates and upkeep the project. I will keep this project on my Github account, as it is part of my portfolio. I hope you enjoy the work Simon will be putting into this project. Some of you will see my work again in the near future.

Support the Project

Contribute

If you're a developer or just a software user you can help the project by:

  • Opening an issue to report any bugs you experience (please see if an issue already exists before opening an issue)
  • Trying to find where the problem lies with a particular issue (regardless of your skill level, information is always helpful)
  • Fixing issues, if you spot an issue you think you can fix, please make a fork and submit a pull request that solves the issue. Any contributions are welcome!
    • Right now we don't have a very fixed code styling due to the amount of inconsistency in the project. At some point I'm going to go through and make it all consistent, but it'll probably be CamelCase or a slight variation of it that'll be used.

Donations

If you want to help this project rapidly grow, you can donate via PayPal to help further develop Aurora. While being a university student, Aurora does not take my monetary priority. Games and RGB hardware are not cheap, and as a result, support for not owned products will take more time to develop. The donations will be used to purchase hardware and video games with intent to add support for them with Aurora. Alternatively you can gift games directly to me via Steam.

I do not have any intent in charging money for Aurora, it will always be a free and open source project.

PayPal

Credits

Special thanks to these people:

Contributions

Thanks to all the brilliant people that made contributions to this project. See everyone here

Testing

  • Casper
  • dirty_thomas
  • Dustmuffins
  • eMJay
  • FarmeZZ
  • Firewall
  • LASTBULLET_ZEROALIAS
  • KensonN
  • Melantrix
  • Mice
  • NurisH
  • Podgy
  • Raushen
  • Steven-O-kun
  • System Overlord
  • Tatsuto
  • ThirdEyeOpen
  • Trickster79
  • twitch.tv/fearsc | Faceit.com
  • Warblade