1
0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-12 21:38:38 +00:00
Artemis/README.md
Robert Beekman 5de3fa3be9 Update README.md
Updated build instructions and overview of changes compared to Artemis 1.x
2020-06-30 22:35:50 +02:00

4.2 KiB

Artemis

Build status GitHub release Github All Releases GitHub license GitHub stars Donate

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. To use, extract the ZIP and run Artemis.UI.exe.

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.

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
  4. Open <central folder>\RGB.NET\RGB.NET.sln and build with the default config
  5. Open <central folder>\Artemis\src\Artemis.sln
  6. Restore Nuget packages

A quick overview of the largest changes compared to Artemis 1.x

  • Completely overhauled UI
  • Deep intergration with DarthAffe's RGB.NET (meaning more devices!)
  • Custom device positions to accurately map out your real-world setup
  • Profiles are no longer be bound to a specific keyboard but will with any setup
  • Layers are assigned to LEDs to allow for very precise lighting
  • Profiles are built using an entirely custom made editor with support for keyframe-based animations and shape manipulation
  • Devices, layer types (known as brushes and effects in Artemis 2), modules and many other things are available in the form of plugins
  • There will be a workshop to share plugins, profiles and even layers. This workshop will be integrated into the application and will also 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 😃 For an up-to-date overview of what's currently being worked on, see the Projects page

Work in progress screenshots

Surface editor The surface editor allows you to recreate your desktop in 2D space, ensure effects scale properly over your different devices. Right clicking a device lets you identify it (it will blink white) and change its properties such as rotation and scale.

Profile editor Here is an overview of the profile editor, the panels aren't populated yet but will allow you to configure display conditions, layer elements (such as colors, animations, filters) and element properties where you can configure the different elements.

LED selection Inside the profile editor you'll be able to select LEDs and create layers for them or apply them to layers. A layer will only display on the LEDs it is assigned to.

Rotation and scale An example of what the profile editor might look like whith a rotated keyboard and an enlarged mouse.

Settings This is an early version of the device settings tab, in here you can configure devices where applicable.