diff --git a/README.md b/README.md index 060a82434..7ae3a1d0d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # Artemis -Artemis, adding third-party support for RGB keyboard to games. +Artemis adds support for several games to a range of RGB keyboards. + +Besides game-support there are also a few (rather gimicky) effects for when you're not gaming. + +Some of it's basic features: + + * Support for multiple keyboards planned. + * Support for multiple games. + * A few non-gaming effects such as type waves and audio visualization. + * A fancy, modern looking UI. + + +Currently the following games are supported: + + * Rocket League + * The Witcher 3 + +Support is planned for: + * Counter-Strike Global Offensive (Using native Gamestate intergration) + * Dota 2 (Using native Gamestate intergration) + * Project CARS (Using native memory sharing) + +Currently the only supported keyboard is the Logitech G910 Orion Spark, but progress is being made to support Corsair as well. + +For any other keyboards feel free to submit a PR. + +### Screenshots +![Screenshot 1](http://i.imgur.com/mq8i4ht.png) +![Screenshot 2](http://i.imgur.com/Z2RkiTE.png) + + +### Thanks to: + + * [CUE.NET](https://github.com/DarthAffe/CUE.NET) for the great Corsair library + * [NAudio](http://naudio.codeplex.com/) for the fine audio library + * [Open.WinKeyboardHook](Open.WinKeyboardHook) for their robust keyboard listener + * [Caliburn.Micro](http://caliburnmicro.com/) for the awesome WPF framework, really, try it out + * [MahApps.Metro](https://github.com/MahApps/MahApps.Metro) for the brilliant UI + * [Extended.Wpf.Toolkit](http://wpftoolkit.codeplex.com/) for the sweet color picker