Skip to content

Update the Plugin template #4185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
2br-2b wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update the Plugin template #4185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b753abe
Bump SDK version
2br-2b Nov 23, 2025
cf86994
Add installer to default templates
2br-2b Nov 23, 2025
8596e8c
Added READMEs to the extension templates
2br-2b Nov 23, 2025
c33917b
Update template csproj-s to include the readme and the installer
2br-2b Nov 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions source/Tools/Playnite.Toolbox/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public class Extensions
private const string nameReplaceMask = "_name_";
private const string namespaceReplaceMask = "_namespace_";
private const string guidReplaceMask = "00000000-0000-0000-0000-000000000001";
private const string dateReplaceMask = "XXXX-XX-XX";
private const string genericPluginProjectName = "GenericPlugin";
private const string libraryPluginProjectName = "CustomLibraryPlugin";
private const string metadataPluginProjectName = "CustomMetadataPlugin";
Expand Down Expand Up @@ -96,6 +97,12 @@ public static string GenerateScriptExtension(string name, string directory)
changed = true;
}

if (fileContent.Contains(dateReplaceMask))
{
fileContent = fileContent.Replace(dateReplaceMask, DateTime.Now.ToString("yyyy-MM-dd"));
changed = true;
}

if (changed)
{
File.WriteAllText(filePath, fileContent, Encoding.UTF8);
Expand Down Expand Up @@ -145,6 +152,12 @@ public static string GeneratePluginExtension(ExtensionType type, string name, st
changed = true;
}

if (fileContent.Contains(dateReplaceMask))
{
fileContent = fileContent.Replace(dateReplaceMask, DateTime.Now.ToString("yyyy-MM-dd"));
changed = true;
}

if (changed)
{
File.WriteAllText(filePath, fileContent, Encoding.UTF8);
Expand Down
6 changes: 4 additions & 2 deletions ...ools/Playnite.Toolbox/Templates/Extensions/CustomLibraryPlugin/CustomLibraryPlugin.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
<WarningLevel>4</WarningLevel>
</PropertyGroup>
<ItemGroup>
<Reference Include="Playnite.SDK, Version=6.2.0.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>packages\PlayniteSDK.6.2.0\lib\net462\Playnite.SDK.dll</HintPath>
<Reference Include="Playnite.SDK, Version=6.13.0.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>packages\PlayniteSDK.6.13.0\lib\net462\Playnite.SDK.dll</HintPath>
</Reference>
<Reference Include="PresentationCore" />
<Reference Include="PresentationFramework" />
Expand Down Expand Up @@ -61,6 +61,8 @@
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="packages.config" />
<None Include="installer.yaml" />
<None Include="README.md" />
</ItemGroup>
<ItemGroup>
<None Include="icon.png">
Expand Down
5 changes: 5 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/CustomLibraryPlugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# _name_

Check out https://api.playnite.link/docs/tutorials/extensions/libraryPlugins.html for documentation on creating a library plugin!

Once you're done, update the installer yaml, then submit a PR to https://github.com/JosefNemec/PlayniteAddonDatabase
8 changes: 8 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/CustomLibraryPlugin/installer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
AddonId: "_name__00000000-0000-0000-0000-000000000001"
Packages:
- Version: 1.0
RequiredApiVersion: 6.13.0
ReleaseDate: XXXX-XX-XX
PackageUrl: <INSERT_PEXT_URL_HERE>
Changelog:
- Initial Release
2 changes: 1 addition & 1 deletion source/Tools/Playnite.Toolbox/Templates/Extensions/CustomLibraryPlugin/packages.config
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="PlayniteSDK" version="6.2.0" targetFramework="net462" />
<package id="PlayniteSDK" version="6.13.0" targetFramework="net462" />
</packages>
6 changes: 4 additions & 2 deletions ...ls/Playnite.Toolbox/Templates/Extensions/CustomMetadataPlugin/CustomMetadataPlugin.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
<WarningLevel>4</WarningLevel>
</PropertyGroup>
<ItemGroup>
<Reference Include="Playnite.SDK, Version=6.2.0.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>packages\PlayniteSDK.6.2.0\lib\net462\Playnite.SDK.dll</HintPath>
<Reference Include="Playnite.SDK, Version=6.13.0.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>packages\PlayniteSDK.6.13.0\lib\net462\Playnite.SDK.dll</HintPath>
</Reference>
<Reference Include="PresentationCore" />
<Reference Include="PresentationFramework" />
Expand Down Expand Up @@ -61,6 +61,8 @@
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="packages.config" />
<None Include="installer.yaml" />
<None Include="README.md" />
</ItemGroup>
<ItemGroup>
<None Include="icon.png">
Expand Down
5 changes: 5 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/CustomMetadataPlugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# _name_

Check out https://api.playnite.link/docs/tutorials/extensions/metadataPlugins.html for documentation on creating a metadata plugin!

Once you're done, update the installer yaml, then submit a PR to https://github.com/JosefNemec/PlayniteAddonDatabase
8 changes: 8 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/CustomMetadataPlugin/installer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
AddonId: "_name__00000000-0000-0000-0000-000000000001"
Packages:
- Version: 1.0
RequiredApiVersion: 6.13.0
ReleaseDate: XXXX-XX-XX
PackageUrl: <INSERT_PEXT_URL_HERE>
Changelog:
- Initial Release
2 changes: 1 addition & 1 deletion source/Tools/Playnite.Toolbox/Templates/Extensions/CustomMetadataPlugin/packages.config
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="PlayniteSDK" version="6.2.0" targetFramework="net462" />
<package id="PlayniteSDK" version="6.13.0" targetFramework="net462" />
</packages>
6 changes: 4 additions & 2 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/GenericPlugin/GenericPlugin.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
<WarningLevel>4</WarningLevel>
</PropertyGroup>
<ItemGroup>
<Reference Include="Playnite.SDK, Version=6.2.0.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>packages\PlayniteSDK.6.2.0\lib\net462\Playnite.SDK.dll</HintPath>
<Reference Include="Playnite.SDK, Version=6.13.0.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>packages\PlayniteSDK.6.13.0\lib\net462\Playnite.SDK.dll</HintPath>
</Reference>
<Reference Include="PresentationCore" />
<Reference Include="PresentationFramework" />
Expand Down Expand Up @@ -60,6 +60,8 @@
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="packages.config" />
<None Include="installer.yaml" />
<None Include="README.md" />
</ItemGroup>
<ItemGroup>
<None Include="Localization\*.xaml">
Expand Down
5 changes: 5 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/GenericPlugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# _name_

Check out https://api.playnite.link/docs/tutorials/extensions/genericPlugins.html for documentation on creating a generic plugin!

Once you're done, update the installer yaml, then submit a PR to https://github.com/JosefNemec/PlayniteAddonDatabase
8 changes: 8 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/GenericPlugin/installer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
AddonId: "_name__00000000-0000-0000-0000-000000000001"
Packages:
- Version: 1.0
RequiredApiVersion: 6.13.0
ReleaseDate: XXXX-XX-XX
PackageUrl: <INSERT_PEXT_URL_HERE>
Changelog:
- Initial Release
2 changes: 1 addition & 1 deletion source/Tools/Playnite.Toolbox/Templates/Extensions/GenericPlugin/packages.config
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="PlayniteSDK" version="6.2.0" targetFramework="net462" />
<package id="PlayniteSDK" version="6.13.0" targetFramework="net462" />
</packages>
7 changes: 7 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/PowerShellScript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# _name_

Check out https://api.playnite.link/docs/tutorials/extensions/scripting.html for documentation on creating a script plugin!

Note - **Support for PowerShell extensions is getting removed in next major Playnite release, version 11. We strongly recommend using .NET plugins since porting PowerShell script code to C# would be considerable amount of effort.**

Once you're done, update the installer yaml, then submit a PR to https://github.com/JosefNemec/PlayniteAddonDatabase
8 changes: 8 additions & 0 deletions source/Tools/Playnite.Toolbox/Templates/Extensions/PowerShellScript/installer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
AddonId: "_name__00000000-0000-0000-0000-000000000001"
Packages:
- Version: 1.0
RequiredApiVersion: 6.13.0
ReleaseDate: XXXX-XX-XX
PackageUrl: <INSERT_PEXT_URL_HERE>
Changelog:
- Initial Release