Dalamud Plugin Template

(Of course, because we needed another one.)

This is a template for the .NET Template Engine to make Dalamud plugins. It has several benefits over SamplePlugin:

• Assumes knowledge and experience of making Dalamud plugins
• Easy to get started with
  • Easy to create from the dotnet CLI/Visual Studio/JetBrains Rider
  • Optionally toggle windowing, configuration, commands
  • Builds out of the box (but please let me know if there are issues!)
• Modern
  • Uses Dalamud.NET.Sdk
  • Only a Version field in the .csproj
• Choose your bias
  • Service injection via god objects, constructor injection, or static properties
  • No provided .editorconfig, bring your own code style & reformat
• Clean
  • No image loading or Data folder to strip out
  • Ships with a proper LICENSE file without the Markdown extension
  • Contains a .gitignore ignoring JetBrains IDEs

Installation

Run this command in your terminal:

dotnet new install NotNite.DalamudPluginTemplate --nuget-source https://nuget.n2.pm/v3/index.json

You can then use the template when creating a plugin:

• Visual Studio: Click "Create a new project" and select "Dalamud Plugin (NotNite)".
• JetBrains Rider: Click "New Solution" and select "Dalamud Plugin".
• dotnet CLI: dotnet new dalamudplugin --name MyDalamudPlugin --MoveExtraFiles false

By default, the template will copy the .gitignore and LICENSE files to the parent directory. If you are creating a new project in an existing solution, or your solution and project is in the same folder, make sure to disable "Move Extra Files".

Available options:

• ServiceType: How services are accessed in the plugin
  • GodObject: Services are accessed through static properties on a Services class
  • Constructor: Services are passed to the plugin constructor
  • StaticProperty: Services are accessed through a static property on the Plugin class
• Windowing: Whether to include the Dalamud window system for the plugin
• Configuration: Whether to include a configuration file for the plugin
  • If Windowing is enabled, a config window is created
• Command: Whether to include the Dalamud command system for the plugin
  • If Windowing is enabled, the command toggles the UI
• MoveExtraFiles: Whether to move extra files (e.g. .gitignore) to the parent directory

If you want to work on the template locally, clone this repository and run this command:

dotnet new install --force ./template

Problems

If the plugin doesn't build out of the box after creation, this is considered a bug. Please fire an issue - there's a lot of permutations of config options here.