ThunderPipe is a command-line tool for validating and publishing mod packages to Thunderstore.
You can install ThunderPipe from NuGet by running the following command:
dotnet tool install ThunderPipeAlternatively, you can install it by downloading the package from NuGet or GitHub Releases directly, and installing the local file:
dotnet tool install ThunderPipe --add-source <path-to-download>Important
The commands shown in further sections will omit the dotnet tool run part, due to being installed globally. This can be achieved by adding the --global flag in the installation command.
Uploads your .zip file directly to Thunderstore.
ThunderPipe publish <file> <team> <community> --token <your-token>| Argument | Description |
|---|---|
<file> |
Path to your .zip file |
<team> |
Name of the team that owns the service account |
<community> |
Slug of the community |
<your-token> |
API token of the service account to use |
Checks if your package meets Thunderstore's requirements before you attempt to publish it.
ThunderPipe validate package <package-folder>| Argument | Description |
|---|---|
<package-folder> |
Path to the folder containing the package's files |
Creates a manifest.json file that meets Thunderstore's requirements.
ThunderPipe create manifest <name> <version>| Argument | Description |
|---|---|
<name> |
Name of the package |
<version> |
Version of the package |
upload-thunderstore-package is a GitHub Action that wraps ThunderPipe to automate the full publish pipeline. Under the hood, the action automates the full validation, the build, the packaging and the publishing.
If you want more in-depth information about this tool, you can visit the wiki.
Contributions are welcome! If you encounter a bug or have a feature request, please open an issue.
Made with ❤️ for the modding community