Artemis Plugin Templates

This repository contains templates for Artemis plugins. Available on Nuget

These templates are intended to be used if you know your way around Artemis plugins, especially if you already have a repository with some plugins and want to add a new one. If you're starting out with Artemis plugins, it's recommended to use the Artemis Template Repository on Github.

Pre-requisites

• .NET SDK (required)
• Code editor of your choice (recommended):
  • Rider
  • Visual Studio 2022
  • Visual Studio Code

Installation

To install the templates, run the following command:

dotnet new install ArtemisRGB.Templates

You can see all available templates by running

dotnet new list artemis

To update the templates, run the following command:

dotnet new update

Usage

Empty Plugin

dotnet new artemis-plugin-empty -n Artemis.Plugins.ExamplePlugin

Empty Artemis plugin project, without any modules or layers.

Module Plugin

dotnet new artemis-plugin-module -n Artemis.Plugins.Modules.ExampleModule --moduleName Example

Creates an Artemis plugin project with a single module. This is used to add external data for Artemis to use, such as CPU or GPU temperatures, current weather, etc.

Layer Brush Plugin

dotnet new artemis-plugin-layerbrush -n Artemis.Plugins.LayerBrushes.ExampleLayerBrush --layerBrushName Example

Creates an Artemis plugin project with a single layer brush. This is used to add a new brush to the editor, such as a gradient or a noise brush.

Layer Effect Plugin

dotnet new artemis-plugin-layereffect -n Artemis.Plugins.LayerEffects.ExampleLayerEffect --layerEffectName Example

Creates an Artemis plugin project with a single layer effect. This is used to add a new effect to the editor, which can be applied to a layer.