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

Readme - Updated for Avalonia

Browse Source 
Readme - Fix video
This commit is contained in:
Robert 2022-10-06 20:27:26 +02:00
parent 35b593a31d
commit ec32266fa5
1 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -6,8 +6,7 @@
[![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 2 adds highly configurable support for several games to a range of RGB keyboards, mice and headsets.
Artemis 1 is no longer supported and Artemis 2 is in active development. This entire readme and all websites/documents refer to Artemis 2.
Artemis adds highly configurable support for several games to a range of RGB keyboards, mice and headsets.
### Check out our [Wiki](https://wiki.artemis-rgb.com) and more specifically, the [getting started guide](https://wiki.artemis-rgb.com/en/guides/user).
**Pre-release download**: https://github.com/SpoinkyNL/Artemis/releases (pre-release means your profiles may break at any given time!)
@ -31,23 +30,17 @@ dotnet build .\Artemis\src\Artemis.sln
dotnet build .\Artemis.Plugins\src\Artemis.Plugins.sln
```
For an up-to-date overview of what's currently being worked on, see the [Projects](https://github.com/SpoinkyNL/Artemis/projects) page
For an up-to-date overview of what's currently being worked on, see the [Projects](https://github.com/Artemis-RGB/Artemis/projects?type=classic) page
## Plugin development
While Artemis 2 is still in development, the plugin API is pretty far along.
To get started, you can download the Visual Studio extension in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=SpoinkyNL.ArtemisTemplates).
This extension provides you with interactive template projects for each type of Artemis 2 plugin.
To use the templates you must have Artemis 2 extracted somewhere on your drive. The plugin wizard will ask you to locate the exectuable in order to setup all the required project references for you.
To get started, you can download the .NET templates, check out the [Artemis.Plugins.Templates](https://github.com/Artemis-RGB/Artemis.Plugins.Templates) repository.
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
- https://github.com/Cheerpipe/Artemis.Plugins.Public
A few people have already started working on plugins! We're keeping a list on our wiki
https://wiki.artemis-rgb.com/en/guides/user/plugins
## 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.
@ -55,7 +48,8 @@ A few people have already started working on plugins! If you want your plugins t
![Surface editor](https://wiki.artemis-rgb.com/screenshots/surface-editor.png)
_The surface editor allows you to recreate your desktop in 2D space, this provides Artemis with spatial awareness and ensures effects scale properly over your different devices. Right clicking a device lets you change its properties such as rotation and scale._
![Keyframes](http://artemis-rgb.com/github/sSEvdAXeTQ.gif)
[profile-editor.webm](https://user-images.githubusercontent.com/8858506/194389752-7cf1b69a-8ee5-478a-a404-0ef08532c28e.webm)
_With the keyframe engine you can animate almost any property of the layer. In the example above the position and scale of the shape have been animated using keyframes._
For more screenshots check out the wiki: https://wiki.artemis-rgb.com/en/screenshots
@ -63,5 +57,4 @@ For more screenshots check out the wiki: https://wiki.artemis-rgb.com/en/screens
### Special thanks
Over the years several companies have supported Artemis by providing both hardware and software, thank you!
[![Corsair](https://i.imgur.com/UKUdDOy.png)](https://www.corsair.com/)
[![JetBrains](https://i.imgur.com/JYfXjjB.png)](https://www.jetbrains.com/?from=ArtemisRGB)
[![Wooting](https://i.imgur.com/Zh3bVza.png)](https://wooting.io/)