Not what you're looking for?
Head back to the guide overview on the getting started page.
The main purpose of this guide is to be an overview of what features are available and what they're used for.
The profile system is one of the main features of Artemis and is what allows you to create extremely customizable effects on all your supported devices. Profiles are closely tied to modules, this means each profile you create is a profile for a module. You can create multiple profiles and switch between them at will as long as the module is active.
Since all changes to profiles are made using the profile editor, every profile feature is shown through the editor. However, this guide won't go into deep detail of each individual feature, instead links to more specific guides will be included where relevant.
To access the profile editor of a module, simply select the module in the sidebar.
A profile contains your layers and folders, it is basically Artemis's way of storing your savedata.
Profiles conform to a hierarchy as shown below:
The profile editor is accessed by selecting a module in the sidebar, you'll be in the profile editor for that specific module.
Once you open the profile editor regular profile playback stops, all other modules are suspended and the editor takes over.
The image below highlights each aspect of the profile editor. In the next chapters each highlighted part of the editor is explained.
The toolbox contains all the tools you can use to modify layers in de visualization panel on the right.
The tools available to you are:
More detailed info on using these tools can be found in the layer guide.
The visualization part of the editor is used to see what's going on in real-time. Assuming your devices have a layout, you'll see a realistic representation of your device with all its LEDs.
You can use the Panning tool to move around the surface (holding down Ctrl will select the panning tool until you release it again). To get a closer look you can use the mousewheel to zoom in and out.
The visualizer shows all the layers of your profile but only LEDs and shape of the currently selected layer are highlighted.
Below is an example of 3 layers - all on the keyboard - but with shapes that cover only part of the keyboard:
Just above the panel you can manage your profiles for this module such as adding new ones, switching profiles, renaming etc.. The profile elements panel itself contains all the layers and folders of your profile.
Each element contains an icon indicating its type, a or for folders and a for layers.
For layers another icon is visible which is the brush icon. This icon helps you to more easily identify layers, hovering over this icon will also tell you the name of the brush.
You can use the -toggle to temporarily disable layers and even entire folders.
The main purpose of this panel is to manage the contents of the profile
It is vital to understand that these controls are only for the profile editor. Nothing you click here effects regular profile playback in any way.
To get a sense of how your profile will look when the editor is closed, you can use the playback controls to start a preview.
When you select a layer in the profile elements panel, its properties become visible in the properties panel.
Because this guide is meant as an overview, we won't go into detail here but the main takeaway is that this is where you change all the settings for your layer.
In a new layer all settings are collapsed, you may expand them by clicking the -icon. Once you've done that you'll be shown all the settings within that category.
By default a layer has 3 main categories
Already want to learn a bit more? Hover over the properties in Artemis to view a more detailed description of what they do!
Below the properties you can see the name of the currently selected layer and next to that there's an ADD EFFECT button. Clicking this button will allow you to add an effect to the layer.
A layer can use effects to modify what should be shown, this can be adding a glow, adjusting the color, making the layer grayscale etc.
You can have multiple effects but they are always applied in order.
Because when stacking effects the order can make a difference, you can reorder effects by dragging them up and down.
Each effect has its own property group but they are slightly different from the 3 main categories
For more info on properties and effects, please refer to the layers guide.
The main purpose of the timeline is to create custom animations using keyframes.
The timeline allows you to change the value of one or more properties over time. The way this is done is by giving a property multiple values at different points in time, these values are called keyframes. When the timeline plays Artemis smoothly follows these keyframes, resulting in an animation.
The timeline is split up into separate rails. Each property has its own rail and on these rails you can place keyframes. Because of this, you'll be using the properties panel and the timelines panel together a lot.
In the image above you'll see that keyframes are enabled for the Position, Scale and Rotation properties. This was achieved by clicking the -icon in front of each property.
Each keyframe is shown on the timeline using circle like this one: .
You can drag these around to change their position. The position of your keyframes determine the start, end and speed of the animation.
Changing the value of a property which has keyframes enabled adds a new keyframe at the current position of the timeline cursor.
Collapsing a property will also collapse the rails, causing all keyframes to be consolidated into a single rail which you cannot edit.
In Artemis you can use conditions to make layers and even entire folders hide/display when certain criteria are met.
Conditions are created using visual programming, this means all you need to do is click things!
Below is an example of a condition using groups and different operators.
Conditions are color coded and can be devided into several parts
Since the right side of the condition can be a data model value or your own input, you can swap between the two modes by clicking the -icon.
In full human language the condition from the image above looks like this:
The day of the week is monday and the current hour is before 17:00 or The day of the week is friday and the current hour is or is later than 12:00
Below the conditions you'll find two configuration options, the Play mode and the Stop mode.
These allow you to configure how your layer should act while its conditions are met and when conditions stop being met.
Play mode - Configure how the layer should act while the conditions are met
Want your layer to repeat, even while you have no conditions? Make sure play mode is set to Repeat.
Stop mode - Configure how the layer should act when the conditions are no longer met
More details on conditions, different condition types and more can be found in the conditions guide.
One last powerful feature of the editor are data bindings. Where conditions allow you to show/hide things based on certain criteria, data bindings allow you to tie properties to values.
To show the difference we have two examples