Getting Started: Uploading your Crucible Package Mod to Thunderstore

Crucible package mods can use Thunderstore to make installation easy. If Crucible is added a dependency to your mod then Crucible will be automatically downloaded when someone goes to download your mod from Thunderstore.

Thunderstore package files

To upload a crucible package mod to Thunderstore you will need to create three files:

manifest.json

Here is an example maifest.json file:

{
  "name": "Your Mod Name",
  "version_number": "1.0.0",
  "website_url": "https://github.com/RoboPhred/potioncraft-crucible",
  "description": "A short description of the mod to be shown next to the icon in the mod list.",
  "dependencies": [
    "Crucible-Crucible_Modding_Framework-2.0.0"
  ]
}

For a full specification see Package format requirements

To check your manifest.json file for errors use the Manifest Validator tool

name

The name of your mod. This will set the name that is shown within Thunderstore

version_number

A three part version number following this format X.X.X. Each time you upload a new version this version string will need be bigger than the last.

website_url

A url which will be displayed in the header of your mod page. This can be any website. If your mod does not have any github page or website you can simple use https://github.com/RoboPhred/potioncraft-crucible to link back to the crucible repository.

description

A short description of the mod, shown on the mod list. Max 250 characters.

dependencies

A json array which should contain the dependency string for Crucible. This should always look like Crucible-Crucible_Modding_Framework-X.X.X where X.X.X is the latest Crucible version on Thunderstore. See the above manifest example to see exactly how this array should be formatted.

You can always find the latest dependency string by going to the Crucible Modding Framework Thunderstore Page and copying the Dependency string in the header.

README.md

The Readme file which will make up the body of your mod page. This uses the standard Markdown format.

Use the Markdown Preview tool to see how your Readme file will look once uploaded to Thunderstore.

See Markdown Guide for a helpful guide for learning Markdown.

icon.png

A PNG image which will be shown in the Thunderstore mod list as your mod's icon.

Thunderstore Package format

To upload your mod to Thunderstore your mod's files and all of the above Thunderstore specific files will need to put into a zip file.

The zip file can be uploaded here once you have created a Thunderstore account.

File Structure

When downloaded all of the files inside the zip folder will be placed into a single folder meaning any folders you include will not be present when the mod is ran. You can still create folders within your zip file for your own organization but those folders will not be present when downloaded by a player.

This means you must name each included file a different name and reference your files without any folders specified in your package.yml file. If you have created a mod which uses an image like this:

sprite: ingredient1\sprite.png

Crucible will not be able to find that file once your folder structure has been flattened. Instead when uploading your mod to Thunderstore you need to rename your files to be unique and then reference your resource files like this:

sprite: ingredient1_sprite.png