Skip to content

Commit

Permalink
1.5.0 - Change CI, remove repository template, cleanup readne
Browse files Browse the repository at this point in the history
  • Loading branch information
diogotr7 committed Oct 19, 2023
1 parent f7cc36a commit 160c895
Show file tree
Hide file tree
Showing 15 changed files with 33 additions and 521 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Build

on: push

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Clone
uses: actions/checkout@v3

- name: Build
run: dotnet build src
13 changes: 4 additions & 9 deletions .github/workflows/nuget.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
name: Publish Template Nuget packages

on:
push:
branches:
- master
push:
tags:
- '*'

jobs:
push:
runs-on: ubuntu-latest

steps:
- name: Setup .NET 6.0
uses: actions/setup-dotnet@v1
with:
dotnet-version: '6.0.x'

- name: Clone
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Pack
run: dotnet pack -c Release src/Artemis.Templates.csproj
Expand Down
35 changes: 10 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@

This repository contains templates for Artemis plugins. Available on Nuget ![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/ArtemisRGB.Templates)

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](https://github.com/Artemis-RGB/Artemis.PluginTemplate) on Github.

## Pre-requisites

- [.NET 6 SDK](https://dotnet.microsoft.com/download) (required)
- [.NET SDK](https://dotnet.microsoft.com/download) (required)
- Code editor of your choice (recommended):
- [Rider](https://www.jetbrains.com/rider/)
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/community/)
- [Visual Studio Code](https://code.visualstudio.com/)
- [Rider](https://www.jetbrains.com/rider/)
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/community/)
- [Visual Studio Code](https://code.visualstudio.com/)

## Installation

Expand All @@ -18,7 +21,8 @@ To install the templates, run the following command:
dotnet new install ArtemisRGB.Templates
```

You can see all available templates by running
You can see all available templates by running

```bash
dotnet new list artemis
```
Expand All @@ -31,25 +35,6 @@ dotnet new update

## Usage

To get started creating plugins for Artemis, the repository template is recommended. It comes with a gitignore to keep your project clean, and GitHub Actions set up to automatically build and publish your plugins.

This repository cannot be created in Visual Studio like the plugin projects, the dotnet CLI needs to be used.
To create a new plugin repository, run the following command in a new empty folder:

```bash
dotnet new artemis-plugin-repo -n Artemis.Plugins.SolutionName
```

The name can be anything you want, like your GitHub username or something else that describes the plugin(s).

You now have a repository with an empty solution. You can add any of the plugin templates as new projects.

This can be done in two ways:
- Visual Studio via the `Add > New Project...` menu
- dotnet CLI via the given commands.

## Available Templates

### Empty Plugin

```bash
Expand Down Expand Up @@ -80,4 +65,4 @@ Creates an Artemis plugin project with a single layer brush. This is used to add
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.
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.
2 changes: 1 addition & 1 deletion src/Artemis.Templates.csproj
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<PackageType>Template</PackageType>
<PackageVersion>1.4.9</PackageVersion>
<PackageVersion>1.5.0</PackageVersion>
<PackageId>ArtemisRGB.Templates</PackageId>
<PackageIcon>icon.png</PackageIcon>
<Title>Artemis Templates</Title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.622.7" />
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.1017.2" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.622.7" />
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.1017.2" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.622.7" />
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.1017.2" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.622.7" />
<PackageReference Include="ArtemisRGB.UI.Shared" IncludeAssets="compile;build;buildTransitive" Version="1.2023.1017.2" />
</ItemGroup>

<ItemGroup>
Expand Down

This file was deleted.

Binary file not shown.

This file was deleted.

This file was deleted.

1 change: 0 additions & 1 deletion src/templates/Artemis.Plugins.RepositoryTemplate/README.md

This file was deleted.

Loading

0 comments on commit 160c895

Please sign in to comment.