ThunderPipe.Sdk 1.0.4

<p align="center"> <img src="https://raw.githubusercontent.com/WarperSan/ThunderPipe/refs/heads/master/icon.png" alt="Logo" height="128"/> </p>

ThunderPipe.Sdk

Overview

ThunderPipe.Sdk is the MSBuild integration of ThunderPipe.Core.

Installation

Go to NuGet, and copy the Sdk XML node for the latest version into your project:

<Sdk Name="ThunderPipe.Sdk" Version="version.number.here" />

Tasks

ThunderPipePack

Packs your files into a valid Thunderstore .zip package.

Use pre-existing ThunderPipePack Target that executes after Build:

<PropertyGroup>
  <RunThunderPipePackAfterBuild>true</RunThunderPipePackAfterBuild>
</PropertyGroup>

Or use the ThunderPipePack Task in your own Target:

<ThunderPipePack
  Token="$(ThunderstoreToken)"
  Team="$(ThunderstoreTeam)"
  Name="$(ThunderstoreName)"
  Version="$(ThunderstoreVersion)"
  Description="$(ThunderstoreDescription)"
  Website="$(ThunderstoreWebsite)"
  Dependencies="@(ThunderstoreDependency)"
  PackageFiles="@(ThunderstorePackageFile)"
  Files="@(ThunderstoreFile)"
  Host="$(ThunderstoreHost)"
  OutputDir="$(ThunderPipeOutputDir)"
  OutputFile="$(ThunderPipeOutputFile)"
>
  <Output TaskParameter="OutputDir" PropertyName="ThunderPipeOutputDir" />
  <Output TaskParameter="OutputFile" PropertyName="ThunderPipeOutputFile" />
</ThunderPipePack>

ThunderPipePublish

Uploads your .zip file directly to Thunderstore.

Use pre-existing ThunderPipePublish Target that executes after Build:

<PropertyGroup>
  <RunThunderPipePublishAfterBuild>true</RunThunderPipePublishAfterBuild>
</PropertyGroup>

Or use the ThunderPipePublish Task in your own Target:

<ThunderPipePublish
  Token="$(ThunderstoreToken)"
  File="$(ThunderPipeOutputFile)"
  Team="$(ThunderstoreTeam)"
  Communities="$(ThunderstoreCommunities)"
  Categories="$(ThunderstoreCategories)"
  CommunityCategories="$(ThunderstoreCommunityCategories)"
  Host="$(ThunderstoreHost)"
  HasNSFW="$(ThunderstoreNSFW)"
>
  <Output TaskParameter="Output" PropertyName="ThunderPipePublishDownloadUrl" />
</ThunderPipePublish>

Default Values

The SDK generates several Thunderstore properties that can be use in tasks.

Here is a list of each property, with their defaults in order:

• $(ThunderstoreName)
  • $(Product)
  • $(AssemblyName)
  • $(RootNamespace)
• $(ThunderstoreVersion)
  • $(Version)
• $(ThunderstoreDescription)
  • $(Description)
• $(ThunderstoreTeam)
  • $(Authors)
• $(ThunderstoreWebsite)
  • $(RepositoryUrl)
  • $(PackageProjectUrl)
• $(ThunderstoreNSFW)
  • false
• $(ThunderstoreHost)
  • https://thunderstore.io/
• $(ThunderPipeOutputDir)
  • if $(ArtifactsPath) exists: $(ArtifactsPath)/thunderstore/$(ArtifactsPivots)
  • $(TargetDir)thunderstore/

You can see more here.

Examples

<PropertyGroup>
  <ThunderstoreTeam>TS_Team</ThunderstoreTeam>
  <ThunderstoreName>Some_Plugin</ThunderstoreName>
  <Version>0.1.0</Version>
  <Description>Short description.</Description>
  <RepositoryUrl>https://example.com/</RepositoryUrl>

  
  <ThunderstoreCommunities>lethal-company;repo;peak</ThunderstoreCommunities>

  
  <ThunderstoreCategories>mods;libraries</ThunderstoreCategories>

  
  <ThunderstoreCommunityCategories>
    repo=client-side/server-side;
    lethal-company=bepinex;
    yapyap=all-clients
  </ThunderstoreCommunityCategories>

  
  <RunThunderPipePackAfterBuild>true</RunThunderPipePackAfterBuild>

  
  <RunThunderPipePublishAfterBuild
    Condition="'$(PublishTS)' == 'true'"
  >true</RunThunderPipePublishAfterBuild
  >

  
</PropertyGroup>


<ItemGroup>
  
  <ThunderstoreFile Include="$(TargetPath)" Destination="plugins/" />
  <ThunderstorePackageFile Include="./README.md" />
  <ThunderstorePackageFile Include="./CHANGELOG.md" />
  <ThunderstorePackageFile Include="./icon.png" />
  <ThunderstorePackageFile Include="./LICENSE" />
</ItemGroup>


<ItemGroup>
  <ThunderstoreDependency Include="BepInEx-BepInExPack" Version="5.4.2305" />
</ItemGroup>