From 41821b4fcd0bc434a8bbf1bd63a2ad777a1269b5 Mon Sep 17 00:00:00 2001 From: 10_days_till_xmas Date: Wed, 16 Jul 2025 19:04:27 +0100 Subject: [PATCH 1/3] refactor(package): mark package as deprecated and update references - Updated package description to indicate deprecation and recommend using UltraModding.PluginInfoGenerator. - Added a warning in the build target to inform users about the deprecation. - Updated project URL to reflect the new branch structure. BREAKING-CHANGE: This package is deprecated and should not be used in new projects. --- .../UltraModding.PluginInfoProps.csproj | 12 ++++--- .../UltraModding.PluginInfoProps.props | 34 ++++++++++--------- 2 files changed, 25 insertions(+), 21 deletions(-) diff --git a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj b/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj index 27256ca..255882a 100644 --- a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj +++ b/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj @@ -2,16 +2,18 @@ UltraModding.PluginInfoProps - 3.0.0 + 3.1.0 BepInEx;10_days_till_xmas BepInEx;Ultrakill;Build;Props - Helper build target that generates a MyPluginInfo class based on assembly metadata. + + [Deprecated: Use UltraModding.PluginInfoGenerator instead] + Helper build target that generates a MyPluginInfo class based on assembly metadata. + - Initial nuget release. Generates a MyPluginInfo class based on assembly metadata. - - Use the GUID, Product, and Version properties to set the values. + Mark package as deprecated and recommend using UltraModding.PluginInfoGenerator instead. MIT false @@ -19,7 +21,7 @@ - https://github.com/UltraModding/UltraModding.Templates/tree/master/UltraModding.PluginInfoProps + https://github.com/UltraModding/UltraModding.Templates/tree/rename-package/UltraModding.PluginInfoProps https://github.com/UltraModding/UltraModding.Templates git diff --git a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props b/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props index d7e11f9..94b1844 100644 --- a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props +++ b/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props @@ -1,10 +1,13 @@ - - - $(GUID) - $(Product) - $(Version) - + + + + $(GUID) + $(Product) + $(Version) + - $(IntermediateOutputPath)MyPluginInfo.cs - - - - - - - - + $(IntermediateOutputPath)MyPluginInfo.cs + + + + + + + + From cab24cbeae6917e40702f807b52d26204519e812 Mon Sep 17 00:00:00 2001 From: 10_days_till_xmas Date: Wed, 16 Jul 2025 21:04:52 +0100 Subject: [PATCH 2/3] refactor(plugin-info): rename package and update README - Renamed package from UltraModding.PluginInfoProps to UltraModding.PluginInfoGenerator. - Updated README.md with new GUID and product name. - Created new project file for UltraModding.PluginInfoGenerator. - Updated solution file to reflect the new project name. BREAKING-CHANGE: The package has been renamed and is now deprecated; users should reference UltraModding.PluginInfoGenerator instead. --- .../README.md | 10 ++++++---- .../UltraModding.PluginInfoGenerator.csproj | 12 ++++++------ .../UltraModding.PluginInfoGenerator.targets | 2 -- UltraModding.Templates.sln | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) rename {UltraModding.PluginInfoProps => UltraModding.PluginInfoGenerator}/README.md (61%) rename UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj => UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.csproj (80%) rename UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props => UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.targets (91%) diff --git a/UltraModding.PluginInfoProps/README.md b/UltraModding.PluginInfoGenerator/README.md similarity index 61% rename from UltraModding.PluginInfoProps/README.md rename to UltraModding.PluginInfoGenerator/README.md index 9030873..31f998a 100644 --- a/UltraModding.PluginInfoProps/README.md +++ b/UltraModding.PluginInfoGenerator/README.md @@ -7,18 +7,20 @@ Generates `MyPluginInfo.cs` based on csproj tags. Define the following properties in your `csproj`: ```xml -Example.Plugin -My first plugin +com.example.plugin +Example Plugin 1.0.0 ``` this will generate the following class: ```cs +namespace Example.Plugin; + internal static class MyPluginInfo { - public const string PLUGIN_GUID = "Example.Plugin"; - public const string PLUGIN_NAME = "My first plugin"; + public const string PLUGIN_GUID = "com.example.plugin"; + public const string PLUGIN_NAME = "Example Plugin"; public const string PLUGIN_VERSION = "1.0.0"; } ``` diff --git a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj b/UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.csproj similarity index 80% rename from UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj rename to UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.csproj index 255882a..5b58c1a 100644 --- a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.csproj +++ b/UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.csproj @@ -1,19 +1,19 @@ - UltraModding.PluginInfoProps - 3.1.0 + UltraModding.PluginInfoGenerator + 4.0.0 BepInEx;10_days_till_xmas BepInEx;Ultrakill;Build;Props + UltraModding.PluginInfoProps - [Deprecated: Use UltraModding.PluginInfoGenerator instead] Helper build target that generates a MyPluginInfo class based on assembly metadata. - Mark package as deprecated and recommend using UltraModding.PluginInfoGenerator instead. + Renamed the package and deprecated UltraModding.PluginInfoProps MIT false @@ -21,7 +21,7 @@ - https://github.com/UltraModding/UltraModding.Templates/tree/rename-package/UltraModding.PluginInfoProps + https://github.com/UltraModding/UltraModding.Templates/tree/master/UltraModding.PluginInfoGenerator https://github.com/UltraModding/UltraModding.Templates git @@ -38,7 +38,7 @@ - + diff --git a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props b/UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.targets similarity index 91% rename from UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props rename to UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.targets index 94b1844..8bf759a 100644 --- a/UltraModding.PluginInfoProps/UltraModding.PluginInfoProps.props +++ b/UltraModding.PluginInfoGenerator/UltraModding.PluginInfoGenerator.targets @@ -1,8 +1,6 @@ - - $(GUID) $(Product) diff --git a/UltraModding.Templates.sln b/UltraModding.Templates.sln index 36c1e39..f3aa4bb 100644 --- a/UltraModding.Templates.sln +++ b/UltraModding.Templates.sln @@ -5,7 +5,7 @@ VisualStudioVersion = 17.13.35931.197 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UltraModding.Templates", "UltraModding.Templates\UltraModding.Templates.csproj", "{C57C43F6-3BCC-42C5-83C3-48DD6CA51245}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UltraModding.PluginInfoProps", "UltraModding.PluginInfoProps\UltraModding.PluginInfoProps.csproj", "{E05232A2-D0AD-435C-8C16-BC954E43E97B}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UltraModding.PluginInfoGenerator", "UltraModding.PluginInfoGenerator\UltraModding.PluginInfoGenerator.csproj", "{E05232A2-D0AD-435C-8C16-BC954E43E97B}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Assets", "Assets", "{BD2D4189-0F06-4F95-9E6A-61B0B6468BCF}" ProjectSection(SolutionItems) = preProject From fd57a574b84d0227397c7bb6ed8c6464d8143eb4 Mon Sep 17 00:00:00 2001 From: 10_days_till_xmas Date: Wed, 16 Jul 2025 22:04:53 +0100 Subject: [PATCH 3/3] refactor(templates): update package references and bump to v2.0.1 - Changed package reference from UltraModding.PluginInfoProps to UltraModding.PluginInfoGenerator - Updated version constraint for the new package BREAKING-CHANGE: The plugin info properties package has been renamed and updated. --- README.md | 7 ++++--- UltraModding.Templates.Tests/ProjectTemplateTests.cs | 2 ++ UltraModding.Templates/README.md | 9 +++++---- UltraModding.Templates/UltraModding.Templates.csproj | 2 +- .../UltraModding.FullPluginTemplate.csproj | 2 +- .../UltraModding.MinimalPluginTemplate.csproj | 2 +- 6 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5d25b87..ccb183b 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,10 @@ dotnet new install UltraModding.Templates ``` This will install the following template: -| Templates | Short Name | Language | Tags | -|-----------------------------------|----------------|----------|--------------------------------------| -| Ultrakill Minimal Plugin Template | `ukplugin-min` | `[C#]` | `BepInEx/BepInEx 5/Plugin/Ultrakill` | +| Templates | Short Name | Language | Tags | +|-----------------------------------|-----------------|----------|--------------------------------------| +| Ultrakill Full Plugin Template | `ukplugin-full` | `[C#]` | `BepInEx/BepInEx 5/Plugin/Ultrakill` | +| Ultrakill Minimal Plugin Template | `ukplugin-min` | `[C#]` | `BepInEx/BepInEx 5/Plugin/Ultrakill` | ## Using a template diff --git a/UltraModding.Templates.Tests/ProjectTemplateTests.cs b/UltraModding.Templates.Tests/ProjectTemplateTests.cs index d46ed5f..8271467 100644 --- a/UltraModding.Templates.Tests/ProjectTemplateTests.cs +++ b/UltraModding.Templates.Tests/ProjectTemplateTests.cs @@ -127,8 +127,10 @@ public async Task FullProjectTemplate_Generated_Project_Builds() const string version = "2.3.4"; const string ultrakillDirectory = "C:/Program Files (x86)/Steam/steamapps/common/ULTRAKILL/"; const string pluginsDirectory = $"{ultrakillDirectory}BepInEx/plugins/"; + Assert.SkipUnless(Directory.Exists(pluginsDirectory), $"Ultrakill plugins directory '{pluginsDirectory}' does not exist. Skipping test."); + var cancellationToken = TestContext.Current.CancellationToken; using TempDir tempDir = new(); diff --git a/UltraModding.Templates/README.md b/UltraModding.Templates/README.md index 19bf003..15295f1 100644 --- a/UltraModding.Templates/README.md +++ b/UltraModding.Templates/README.md @@ -2,14 +2,15 @@ A collection of .NET project templates for Ultrakill plugins using BepInEx 5. -| Templates | Short Name | Language | Tags | -|-----------------------------------|-----------------|------------|---------------------------------------| -| Ultrakill Minimal Plugin Template | `ukplugin-min` | `[C#]` | `BepInEx/BepInEx 5/Plugin/Ultrakill` | +| Templates | Short Name | Language | Tags | +|-----------------------------------|-----------------|----------|--------------------------------------| +| Ultrakill Full Plugin Template | `ukplugin-full` | `[C#]` | `BepInEx/BepInEx 5/Plugin/Ultrakill` | +| Ultrakill Minimal Plugin Template | `ukplugin-min` | `[C#]` | `BepInEx/BepInEx 5/Plugin/Ultrakill` | ## Using a template -To use a template, you can use the `dotnet new` command. +To use a template, use the `dotnet new` command. If you use Rider or Visual Studio 2022, you will be able to select the templates when creating a new solution. For example, to create an Ultrakill plugin project: diff --git a/UltraModding.Templates/UltraModding.Templates.csproj b/UltraModding.Templates/UltraModding.Templates.csproj index cad0178..1055dbd 100644 --- a/UltraModding.Templates/UltraModding.Templates.csproj +++ b/UltraModding.Templates/UltraModding.Templates.csproj @@ -2,7 +2,7 @@ UltraModding.Templates - 2.0.0 + 2.0.1 BepInEx;10_days_till_xmas BepInEx;Plugin;Template;Ultrakill Template diff --git a/UltraModding.Templates/templates/UltraModding.FullPluginTemplate/UltraModding.FullPluginTemplate.csproj b/UltraModding.Templates/templates/UltraModding.FullPluginTemplate/UltraModding.FullPluginTemplate.csproj index 3dd4b09..0d48842 100644 --- a/UltraModding.Templates/templates/UltraModding.FullPluginTemplate/UltraModding.FullPluginTemplate.csproj +++ b/UltraModding.Templates/templates/UltraModding.FullPluginTemplate/UltraModding.FullPluginTemplate.csproj @@ -25,7 +25,7 @@ - + diff --git a/UltraModding.Templates/templates/UltraModding.MinimalPluginTemplate/UltraModding.MinimalPluginTemplate.csproj b/UltraModding.Templates/templates/UltraModding.MinimalPluginTemplate/UltraModding.MinimalPluginTemplate.csproj index 2053fbb..57f18ff 100644 --- a/UltraModding.Templates/templates/UltraModding.MinimalPluginTemplate/UltraModding.MinimalPluginTemplate.csproj +++ b/UltraModding.Templates/templates/UltraModding.MinimalPluginTemplate/UltraModding.MinimalPluginTemplate.csproj @@ -19,7 +19,7 @@ - +