{"id":19675557,"url":"https://github.com/notnite/dalamud-plugin-template","last_synced_at":"2025-05-05T23:16:34.110Z","repository":{"id":247431583,"uuid":"825818870","full_name":"NotNite/dalamud-plugin-template","owner":"NotNite","description":"A Dalamud plugin template for the .NET Template Engine","archived":false,"fork":false,"pushed_at":"2025-04-02T02:29:23.000Z","size":45,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-05T23:16:27.470Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotNite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-08T15:00:01.000Z","updated_at":"2025-04-02T02:29:26.000Z","dependencies_parsed_at":"2025-01-10T04:21:48.950Z","dependency_job_id":"c2a8aef0-2de7-4abd-9e77-77e5449d1d96","html_url":"https://github.com/NotNite/dalamud-plugin-template","commit_stats":null,"previous_names":["notnite/dalamud-plugin-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fdalamud-plugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fdalamud-plugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fdalamud-plugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNite%2Fdalamud-plugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotNite","download_url":"https://codeload.github.com/NotNite/dalamud-plugin-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252590635,"owners_count":21772941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T17:24:44.634Z","updated_at":"2025-05-05T23:16:34.103Z","avatar_url":"https://github.com/NotNite.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dalamud Plugin Template\n\n(Of course, because we needed another one.)\n\nThis is a template for the [.NET Template Engine](https://github.com/dotnet/templating) to make Dalamud plugins. It has several benefits over [SamplePlugin](https://github.com/goatcorp/SamplePlugin):\n\n- Assumes knowledge and experience of making Dalamud plugins\n- Easy to get started with\n  - Easy to create from the dotnet CLI/Visual Studio/JetBrains Rider\n  - Optionally toggle windowing, configuration, commands\n  - Builds out of the box (but please let me know if there are issues!)\n- Modern\n  - Uses Dalamud.NET.Sdk\n  - Only a Version field in the .csproj\n- Choose your bias\n  - Service injection via god objects, constructor injection, or static properties\n  - No provided .editorconfig, bring your own code style \u0026 reformat\n- Clean\n  - No image loading or Data folder to strip out\n  - Ships with a proper LICENSE file without the Markdown extension\n  - Contains a .gitignore ignoring JetBrains IDEs\n\n## Installation\n\nRun this command in your terminal:\n\n```shell\ndotnet new install NotNite.DalamudPluginTemplate --nuget-source https://nuget.n2.pm/v3/index.json\n```\n\nYou can then use the template when creating a plugin:\n\n- Visual Studio: Click \"Create a new project\" and select \"Dalamud Plugin (NotNite)\".\n- JetBrains Rider: Click \"New Solution\" and select \"Dalamud Plugin\".\n- dotnet CLI: `dotnet new dalamudplugin --name MyDalamudPlugin --MoveExtraFiles false`\n\nBy 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\".\n\nAvailable options:\n\n- `ServiceType`: How services are accessed in the plugin\n  - `GodObject`: Services are accessed through static properties on a Services class\n  - `Constructor`: Services are passed to the plugin constructor\n  - `StaticProperty`: Services are accessed through a static property on the Plugin class\n- `Windowing`: Whether to include the Dalamud window system for the plugin\n- `Configuration`: Whether to include a configuration file for the plugin\n  - If `Windowing` is enabled, a config window is created\n- `Command`: Whether to include the Dalamud command system for the plugin\n  - If `Windowing` is enabled, the command toggles the UI\n- `MoveExtraFiles`: Whether to move extra files (e.g. .gitignore) to the parent directory\n\nIf you want to work on the template locally, clone this repository and run this command:\n\n```shell\ndotnet new install --force ./template\n```\n\n## Problems\n\nIf 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotnite%2Fdalamud-plugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotnite%2Fdalamud-plugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotnite%2Fdalamud-plugin-template/lists"}