DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-12 21:38:38 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Robert Beekman 2020-10-28 20:33:30 +01:00 committed by GitHub
parent c4bce4ef2c
commit 2575e3bb45
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,23 +1,22 @@
# 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)
[![Build Status](https://dev.azure.com/artemis-rgb/Artemis/_apis/build/status/Artemis%20Development%20build?repoName=Artemis-RGB%2FArtemis&branchName=master)](https://dev.azure.com/artemis-rgb/Artemis/_build/latest?definitionId=1&repoName=Artemis-RGB%2FArtemis&branchName=master)
[![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)
[![Discord](https://img.shields.io/discord/392093058352676874?logo=discord&logoColor=white)](https://discord.gg/S3MVaC9)
[![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.
#### Artemis 2 is still in very active development and that's why there are no how-to guides yet.
**Pre-release download**: https://github.com/SpoinkyNL/Artemis/releases
**Plugin Documentation**: https://artemis-rgb.com/docs/
**Plugin dcumentation**: https://artemis-rgb.com/docs/
### 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.
Executable of latest Artemis 2 build: [Artemis build.zip](http://download.rbeekman.nl/build/1/Artemis%20build). To use, extract the ZIP and run Artemis.UI.exe.
This download includes all the plugins found in the [Artemis.Plugins repository](https://github.com/Artemis-RGB/Artemis.Plugins)
**Please note that even though I've included a plugin for each brand supported by RGB.NET, only Corsair and Logitech have been tested. If you run into any issues please let us know on Discord.**
**Please note that even though we have plugins for each brand supported by RGB.NET, they have not been thoroughly tested. If you run into any issues please let us know on Discord.**
#### Want to build? Follow these instructions
1. Create a central folder like ```C:\Repos```
@ -38,6 +37,12 @@ To use the templates you must have Artemis 2 extracted somewhere on your drive.
Due to the volatine nature of the project right now, there is no documentation yet. The templates provide some commentary to get you going and feel free to ask for more help in Discord.
### Third party plugins
A few people have already started working on plugins! If you want your plugins to be added to this list feel free to PR or ask on Discord.
- https://github.com/diogotr7/Artemis.Plugins
- https://github.com/Wibble199/Artemis.Plugins
- https://github.com/F-Lehmann/MyArtemisPlugins
## Work in progress screenshots
**Note:** Video tutorials and written guides on many of the features displayed below are planned for when Artemis 2 nears feature-completion.