Graic.Template.GorillaTagModTemplate.nuspec
1.2.1
dotnet new install Graic.Template.GorillaTagModTemplate.nuspec::1.2.1
Gorilla Tag Mod Template
.NET Project Template for PCVR Gorilla Tag Mods
Usage
To install the template, run
dotnet new --install Graic.Template.GorillaTagModTemplate.nuspec
from the command line.
The template can be used from the command line by running dotnet new gtmod -A [Authorname]
. Command line help for the template can be found by running dotnet new gtmod -h
.
To enable the template to be used in Visual Studio, open Visual Studio without code and navigate to Tools/Options/Environment/Preview Features
.
Make sure that "Show all .NET Core Templates in the New Project Dialog" is checked.
The template should then appear in Visual Studio Templates, under "Gorilla Tag Mod".
Parameters
- Project Name is used as the name of the mod. Do not put spaces in the project name, as it will prevent the mod from loading.
- Author Name is the name of the author, used for the plugin info.
- Gorilla Tag Location is the path to the place where Gorilla Tag is installed. By default, it is
C:\Program Files (x86)\Steam\steamapps\common\Gorilla Tag
. This is used for copying the mod on build and for referencing game files.
Template Information
The template creates the following files of note:
- Plugin.cs: The main class of your mod. Most of your code should go here.
- PluginInfo.cs: This holds information about your plugin in a central location. This is where the plugin name, id, and version are stored.
- HarmonyPatches.cs: This handles the application of harmony patches (such as ExamplePatch). You shouldn't need to modify this class.
- Patches/ExamplePatch.cs: This demonstrates how patches are created, you should remove or modify it as you see fit.
- MakeRelease.ps1: This script generates a MonkeModManager compatible release (named ModName-v.zip). You should use this to create builds that you share with others.
- Directory.Build.props: This file contains information about where dependencies are located. If you are getting CS024 (type could not be found) errors, GamePath is probably wrong.
CI/CD With Github Actions
Builds can be generated automatically with https://gist.github.com/Graicc/8ca16f70e9603e9975d99c4a607ff77a
This package has no dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.