We see you wish to upload a mod to Thunderstore or are just curious about this file. This file will go over the following; What to change in the setup for your own mod, how to put your mods contents into this mod, how to override other mods contents, how to upload your mod to Thunderstore, and finally how to update a mod.
This will be somewhat stepped in areas and in others written in a paragraph or table.
icon.png file;This is a file that is used for your plugins logo on Thunderstore it should be a 256x256 image showing a preview of your plugin or just a fancy version of the title. Make sure that it relates 100% to what your mod is and is not just randomly taken off the internet. If you dont want to make one you can ask for one in The Modding Discord within the Mod-Art-Request channel and using the ping @Mod Art Requests. Heres an example of a icon.png on a Thunderstore mod shown below this paragraph.
Here you can see the basic format of some of @thincreator3483's icons; A border element to keep the art within the specified area being 256x256. It has the title featured to Highlight that it is an example mod. It also features the Cog and Wrench to signify that it should be modified and not used as is, although that's only noticeable if you look extra hard. Essentially your icon should convey the point of the mod as a simple preview of its contents, and not just a quick doodle or a image off the internet as it obscures what your mod is doing.
README.md file;For this file we recommend using Markdown Live Preview to help you format your file. This file should explain what the mod does, while also being descriptive and basic. You can use Tables, Bullet Lists, Numbered Lists, or even Images to help convey what your trying to describe. If you need an example on how to format these just look at the way this files information is setup.
| Name of Element | Description Of Element |
|---|---|
| Headers | These are essentially titles for sections within your README.md |
| Tables | These are essentially tables formatted like what your currently looking at - means it will be centered a : before means write from the left a : from the right means write from the right and on both sides makes it centered again. Each row is separated by an ` |
| Bulleted Lists | Use an * for a full bullet or a - for a open bullet each bullet needs a new line below it to be valid. |
| Numbered Lists | These are basically a number followed by a period for example 1. followed by a string after it. |
| Images | These can be inserted as follows  basically a hyperlink that leads to an image instead of a site. |
| Hyperlinks | These can be inserted as follows [Text you want to link to the Hyperlink](URL). |
| Animated Images | Same format as Images. |
| Foldable Elements | These are written as follows replace the \\\\n with a new line: <details> \\\\n <summary>Click me</summary> \\\\n Your Contents \\\\n </details> |
If anything else should be covered here let @Thincreator3483 know in The Modding Discord. Once you finish setting up the README.md how you would like it to be presented either copy paste it into the provided README.md or make a new file called README.md this can be created either via renaming a .txt file in file explorer if Hide File Extensions is disabled or via creating a file in a Text Editor and saving the file while replace the .txt part or whatever its default is with .md. We personally would recommend utilizing Visual Studio Code or Atom but any will work including regular old Notepad.
CHANGELOG.md File;This file is very similar to the README.md so Utilize that guide but the thing this file should be about is different. This file should be an extremely basic but detailed version of your mods changelog being updated with every update of your mod.
Example of a Changelog that you can utilize as a base
# Changelog
## Initial Release - 1.0.0;
* Initial Release Nothing special to see here.
## GUIDELINE.md File Addition - 1.1.0;
* Added a `GUIDELINE.md` to this package to explain how to utilize it.
Change this to match either your mods pre existing changelog plus the current version or just change it to state only the Initial Release. We also should stress that this can be written in whatever format you would like, just make sure it works as a proper Changelog for your mod.
manifest.json File;