Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 1.37 KB

README.md

File metadata and controls

37 lines (30 loc) · 1.37 KB
Raw

DalamudPluginProjectTemplate

An opinionated Visual Studio project template for Dalamud plugins, with attributes for more maintainable command setup and teardown.

Hint paths

The project file includes hint paths for the dependencies, which are set up to not include much information about the developer's filesystem. You may need to adjust these paths yourself, if they don't represent your development environment.

Attributes

This template includes an attribute framework reminiscent of Discord.Net.

[Command("/example1")]
[Aliases("/ex1", "/e1")]
[HelpMessage("Example help message.")]
public void ExampleCommand1(string command, string args)
{
    var chat = this.pluginInterface.Framework.Gui.Chat;
    var world = this.pluginInterface.ClientState.LocalPlayer.CurrentWorld.GameData;
    chat.Print($"Hello {world.Name}!");
    PluginLog.Log("Message sent successfully.");
}

[Command("/example2")]
[DoNotShowInHelp]
public void ExampleCommand2(string command, string args)
{
    // do nothing
}

This automatically registers and unregisters the methods that they're attached to on initialization and dispose.

GitHub Actions

Running the shell script DownloadGithubActions.sh will download some useful GitHub actions for you. You can also delete this file if you have no need for it.

Current Actions

  • dotnet build/test