1
0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00
Artemis/README.md
2019-11-22 19:02:52 +01:00

47 lines
3.7 KiB
Markdown

# Artemis
[![Build status](https://build.rbeekman.nl/app/rest/builds/buildType:(id:Artemis_Build)/statusIcon.svg)](https://build.rbeekman.nl/viewType.html?buildTypeId=Artemis_Build&guest=1)
[![GitHub release](https://img.shields.io/github/release/spoinkynl/Artemis.svg)](https://github.com/SpoinkyNL/Artemis/releases)
[![Github All Releases](https://img.shields.io/github/downloads/spoinkynl/artemis/setup.exe.svg)](https://github.com/SpoinkyNL/Artemis/releases)
[![GitHub license](https://img.shields.io/badge/license-GPL3-blue.svg)](https://github.com/SpoinkyNL/Artemis/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/SpoinkyNL/Artemis.svg)](https://github.com/SpoinkyNL/Artemis/stargazers)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VQBAEJYUFLU4J)
Artemis adds highly configurable support for several games to a range of RGB keyboards, mice and headsets.
**Download**: https://github.com/SpoinkyNL/Artemis/releases
**FAQ**: https://github.com/SpoinkyNL/Artemis/wiki/Frequently-Asked-Questions-(FAQ)
### Notice
Artemis 2 is in development. In the meanwhile I'm no longer supporting Artemis 1.x, sorry!
Executable of latest Artemis 2 build: [Artemis_Build.zip]( https://build.rbeekman.nl/repository/downloadAll/Artemis_Build/.lastSuccessful/artifacts.zip?guest=1). To use, extract the ZIP and run Artemis.UI.exe.
**Please note that for now I've only included Corsair and very limited Logitech support. If you want to test support for a different device (must be RGB.NET supported), let me know on Discord.**
#### Want to build? Follow these instructions
1. Create a central folder like ```C:\Repos```
2. Clone RGB.NET's development branch into ```<central folder>\RGB.NET```
3. Clone Artemis into ```<central folder>\Artemis```
5. Open ```<central folder>\RGB.NET\RGB.NET.sln``` and build with the default config
4. Open ```<central folder>\Artemis\src\Artemis.sln```
5. Restore Nuget packages
6. Run ```Update-Package -reinstall Fody``` on both the **Artemis.Core** and **Artemis.UI** projects
Some things I have planned for 2.0
- Completely overhauled UI
- Deep intergration with DarthAffe's [RGB.NET](https://github.com/DarthAffe/RGB.NET) (meaning more devices!)
- Profiles will no longer be bound to a specific keyboard but will work on any keyboard
- Layers will be assigned to keys accurately like done in per example Corsair's CUE thanks to RGB.NET
- Instead of the built-in game support Artemis currently offers there will be plugins that add support for games, new layers, effects and more
- The plugin system will replace the current idea of having a scripting engine and will be in multiple languages (these will be in the form of plugins themselves)
- I'll include some plugins by default to support most of the games Artemis currently supports (I might drop some games that don't work well/are too much work to maintain)
- There will be a workshop to share plugins, profiles and even layers. This workshop will be part of an Artemis website
Much of this is subject to change and will take a while to create but it'll leave us with a much better platform to create a community around :smiley:
### Special thanks to:
- [Corsair](http://corsair.com) and [GloriousGe0rge](https://twitter.com/GloriousGe0rge) in particular for their continued support of Artemis
- [DarthAffe](https://github.com/DarthAffe) for his great help and awesome CUE SDK wrapper, [CUE.NET](https://github.com/DarthAffe/CUE.NET)
- [JewsOfHazard](https://github.com/JewsOfHazard) and [Thoth2020](https://github.com/Thoth2020) for their work and ideas
- [rakosi2](https://github.com/rakosi2) for providing help and support
- All the people that helped by reporting bugs over the last few months