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-08-17 20:04:08 +02:00 committed by GitHub
parent 6a32ecc3a4
commit 894a76ff2e
1 changed files with 19 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,3 +1,4 @@
# 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)
@ -24,31 +25,28 @@ Executable of latest Artemis 2 build: [Artemis_Build.zip]( https://build.rbeekma
4. Open ```<central folder>\Artemis\src\Artemis.sln```
5. 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](https://github.com/DarthAffe/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 :smiley:
For an up-to-date overview of what's currently being worked on, see the [Projects](https://github.com/SpoinkyNL/Artemis/projects) page
### Work in progress screenshots
![Surface editor](https://i.imgur.com/7d8wgkr.png)
_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._
**Note:** Video tutorials and written guides on many of the features displayed below are planned for when Artemis 2 nears feature-completion.
![Profile editor](https://i.imgur.com/e41dal0.png)
_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._
![Plugins](https://i.imgur.com/x8LGJxp.png)
_Artemis 2 has been build from the ground up with modularity in mind. This means almost everything can be extended using plugins. New devices, effects, games and almost everything else can be added through plugins._
![LED selection](https://i.imgur.com/3uYi7Jt.png)
_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._
![Surface editor](https://i.imgur.com/uA8JLL5.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._
![Rotation and scale](https://i.imgur.com/jen9nbi.png)
_An example of what the profile editor might look like whith a rotated keyboard and an enlarged mouse._
![Profile editor](https://i.imgur.com/PydFspu.png)
_Here is an overview of the profile editor. While it may be overwhelming at first it is very simple to get some basic effects set up. When you're ready, the profile editor will allow you to create almost anything you can think of._
![Settings](https://i.imgur.com/rK4oJ5A.png)
_This is an early version of the device settings tab, in here you can configure devices where applicable._
![LED selection](https://i.imgur.com/7DM0c1x.png)
_Layers are created by making a selection of LEDs, this allows you to precisely dictate where a layer may render._
![Shapes](https://i.imgur.com/NRzc5B1.png)
_Inside the layer you can freely manipulate the shape that is being rendered. By default it always fills the entire layer as seen in the previous screenshot, but it can shrink and even be a circle, revealing the rainbow background behind._
![Keyframes](http://artemis-rgb.com/github/sSEvdAXeTQ.gif)
_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._
![Conditions](https://i.imgur.com/ERHRFQj.png)
_Using visual programming you can create conditions to dictate when a layer may show. The data available to these conditions is provided by plugins, allowing easy expansion._