Thunderstore
Let's go over the prerequisites for Thunderstore
Redactado por Chaosyr
First off let's get the Key Terms out of the way than let's delve into each part of the Step By Step.
Key Terms:
This section goes over terms you should know if you want to upload a package to Thunderstore.
Thunderstore Terms
These are the must know terms when it comes to both Thunderstore and the guides related to it.
- Package: Your Uploaded Content.
- Tags: Categories in which will be listed on your uploaded content.
- Community: The listing for the game in this case Hytale.
- Dependency String: A package that your uploaded content depends upon's hyphenated package identifier.
- Package Identifier: Team, Name, Version
- Team: The Team in which the package was uploaded under.
- Name: The packages name.
- Version: The packages version.
Package Files
The following describe what each package file is.
| File Name | What it Contains | Optionality |
|---|---|---|
| icon.png | This is the icon of your uploaded content, it should resemble the content of your mod in visual form, and must be a ratio of 256x256. | Required |
| README.md | This is the README of your uploaded content, it should contain a rough description of what your uploaded content contains in Markdown, note I'd advise using the Wiki System covered later to discuss the uploaded content more in depth. | Required |
| CHANGELOG.md | This is the CHANGELOG of your uploaded content, it should contain a bulleted list of changes made within each version, its also a Markdown so you can make versions foldouts, headers, etc. I'd advise listing every version ever in the file if your going to do it properly. | Optional but Highly recommended |
| manifest.json | This is the json file containing the packages meta-data, all fields related are required to be present. | Required |
Manifest Fields
The following are a rough description of what each field in the manifest does, along with its limitations and examples.
| Item | What it is | Example Usage |
|---|---|---|
| name | The name of your uploaded content, it may not contain any spaces, and it is Alphanumeric, it may not be changed after uploading without uploading a new package. | "Example_Hytale_UploadedContent": Example Hytale UploadedContent |
| description | A short descriptor of the uploaded content which will be shown beside your contents name and icon, it has a max of 250 characters. | "This is a Example Hytale Content, it is not meant to be used in practice." |
| version_number | The version number of the uploaded content, it uses Semantic Version Format aka. Major.Minor.Patch, once a version is uploaded it cannot be modified or removed without having a explicit reason for removal and direct approval from a Thunderstore Moderator or Developer. | "0.0.1": Major 0, Minor 0, Patch 1 or 0.0.1 |
| dependencies | The dependency strings for the uploaded content in which this content requires in order to function. | ["creator-C#_Hytale_Bridge-1.2.5", "Hytale-HytaleAPI-8.8.1"] |
| website_url | The website url in which your uploaded content will link on its page as a main URL. | "https://github.com/Cecil-Libraries/Cecil-ANSI-Utils" |
Community Tags
The following is a comprehensive list of Tags used by the Thunderstore Community Page of Hytale and what they are meant for.
- Pre-Release: Marks the content as being for the Pre-Release patchline.
- Release: Marks the content as being for the Release patchline.
- Worlds: Marks the content as a World which includes it within the Worlds section.
- Universes: Marks the content as a Universe which includes it within the Universes section, these are bundles of worlds.
- Saves: Marks the content as a Save which includes it within the Saves section.
- Plugins: Marks the content as a Plugin which includes it within the Plugins section, note if you apply this you should apply Mods as well.
- Early Plugins: Marks the content as a EarlyPlugin which includes it within the Plugins section, note if you apply this you should apply Mods as well.
- Asset Packs: Marks the content as a Asset Pack which includes it within the Asset Packs section, note if you apply this you should apply Mods as well.
- Mods: Marks the content as a Mod which includes it within the Mods section.
- Tools: Marks the content as a Tool which includes it within the Other section, if not tied to any prior content types.
- Audio: Marks the content as Audio which includes it within the Other section, if not tied to any prior content types.
- Libraries: Marks the content as a Library which includes it within the Other section, if not tied to any prior content types.
- Combos: Marks the content as a Combo which includes it within the Combos section, think of this as bundling content types together such as a universe with a Mod.
- Misc: Marks the content as a Miscellaneous item which includes it within the Other section, if not tied to any prior content types.
Note this may change over time check back on this page every once in a while or if you see a new Tag appear in the Thunderstore uploads.
Next dive into how to setup your package: Package Setup Basics