How to upload to Thunderstore - Catman-232/Homebrewery GitHub Wiki

This page was up to date as of version 4.0.0
This guide will cover things that are also on Thunderstore's wiki.

Assuming you have set up your metadata files accordingly (See How to configure your content pack mod package), you are now ready to make the zip package and upload it to Thunderstore.

Make the zip

Select the four metadata files and the plugins folder, right click on them, find Send to > and then click on Compressed (zipped) folder.

This will make a new zip file and have name edit mode active so you can rename it immediately, I don't think it particularly matters what you call it but you might as well name it the same as your content pack folder anyway. For example: making a zip for Catman-ExamplePack, and naming it Catman-ExamplePack.zip (If you have file extensions set to hidden, you don't need to add .zip to the filename, it should already be there!)


Log in to Thunderstore and make a "team"

On Thunderstore, look for the Login with... button in the top right. Log in using your Discord or Github acccount, or even Overwolf (whatever that is). After authorizing or whatever it asks you to do, click on Settings in the top right, then click on Teams in the list under Account Settings. Click on the green button labelled Create Team. You might be fortunate enough to be able to use your display name as the team name.

Tip

Thunderstore will create your mod's dependency string with this naming convention: TeamName-ModName-VersionNumber where ModName and VersionNumber are "name" and "version_number" from your mod's manifest.json file.

The mod manager will install it using that same name but without the version number part, and in turn, HB will use that folder name as the content pack's name internally. So you might as well make your content pack's folder name match that in the first place so that it will match up when the mod is uploaded.


Go to the Upload Package page

Thunderstore defaults to Risk of Rain 2 on all of the settings pages, so you'll have to navigate back to the Atlyss community, here's a link to the upload page anyway: https://thunderstore.io/c/atlyss/create/

  • Team : Select your Team from the first dropdown.
  • Communities: Select ATLYSS, it'll be right at the top by default since we're on the Atlyss page already, do not select any others, obviously.
  • Categories: Select Mods at the very least, we don't have any specialised categories yet.
  • Contains NSFW content: You must check this box if your content pack contains nudity or any other adult content!

Now drag your zip onto the button labelled Choose or drag file here, or click on it and use the File Explorer to select your zip file.

Click on Submit!

Assuming you've gotten everything sorted out correctly, you shouldn't run into any issues and in a second or two it will show a box at the bottom confirming the mod was uploaded. Note that while it shows this here, it can take a few minutes for the mod to be properly listed on the site on the Browse page's Last Updated listings.

Note

It can take an hour or two for the Thunderstore API to offer the mod to mod manager users, so please be patient!


Updating a mod

When you want to update a mod, you have to make sure that the "name" in the manifest.json is the same, and that the "version_number" is higher than the current version. On the Upload Package page, you need to select the same Team that you used previously, and select ATLYSS in the communities again of course. You don't need to reselect the Categories, if you leave it empty, Thunderstore will keep the previously selected ones.

Important

You do need to check the NSFW box again if you had it checked previously.

Remember to update your CHANGELOG.md and your README.md if neccesary!

⚠️ **GitHub.com Fallback** ⚠️