Contents:
- Get SMAPI (the mod loader)
- Guide to using mods
- Check mod compatibility
- Recommended mods
- Submit mod ideas
- XNB conversions to Content Patcher
You can help translate mods into your language! See Modding:Translations for more info.
- How to create mods
- JSON validator
- The great ID spreadsheet (thanks to Cane#4059)
The Mod Author
role identifies mod creators on Discord. Each mod author also gets one or more of these sub-roles, which show what kinds of mods they make:
role | for mods |
---|---|
Blacksmith |
for mods written using SMAPI. |
Contentsmith |
for content packs, or mods containing major data changes like custom dialogue, events, and NPCs. |
Pixelsmith |
for mods containing original pixel artwork. |
You can request the role if...
- you released an original mod on any modding site (it doesn't need to be a big mod);
- you reached level 25 on the Discord server (see #welcome for more info on the levels).
If you meet the requirements, just ask in #making-mods! We'll check if you qualify, help you add yourself to the Modding:Community page, and give you the Mod Author role.
This comes with a few benefits based on your level:
- Level 25 (Farmer role):
- Orange color to distinguish yourself in chat.
- Listed on the wiki so users can find you on Discord.
- Right-click your own messages in #making-mods or #modded-farmers for an option to post them #mod-author-showcase.
- Level 50:
- Access to a private GitHub repo with the unpacked and decompiled game. This lets you read the game code and content more easily, see what changed in each game version, run the game code with a debugger, etc.
- Level 100 (Shepherd role):
- Access to the
/define
command to create custom bot commands. (Please respect command etiquette: keep commands useful and on-topic, avoid meme commands in most cases, and don't change commands added by other users without discussing the change first.)
- Access to the
There are a few useful bot commands specific to modding and game support channels you can use (see a full list of commands). Most of these commands support two forms: !command
to output the message, and !command username#0000
to also ping a specific user. Feel free to experiment in #governors-mansion!
To request a log:
command | purpose |
---|---|
!log |
Ask for a SMAPI log. |
!installforlog |
Ask for a SMAPI log (and explain how to install SMAPI temporarily). |
!patchsummary |
Ask for a SMAPI log with Content Patcher's patch summary output. |
For players:
command | purpose |
---|---|
!ask |
Reply to 'Can I ask for help here?'. |
!compat |
Link to the mod compatibility list. |
!mpmods |
How mods work in multiplayer. |
!officialbug |
How to report a bug to the game developers. |
!oom |
Link to the troubleshooting section for OutOfMemoryException errors. |
!pins |
Check the pins for useful links! |
!software |
Recommended software for mod and pixel editing. |
!unzip |
Explains how to extract .zip , .rar , and .7z files. |
Explain common acronyms:
command | topic |
---|---|
!all |
Advanced Location Loader |
!cfr |
Custom Farming Redux |
!cp |
Content Patcher |
!dga |
Dynamic Game Assets |
!ja |
Json Assets |
!json |
JSON format |
!mtn |
MTN |
!pfm |
Producer Framework Mod |
!ppja |
Project Populate Json Assets |
!smapi |
SMAPI (Stardew Modding API) |
!sve |
Stardew Valley Expanded |
!xnb |
XNB files and mods |
For modders:
command | purpose |
---|---|
!addnamespace |
How to add a missing namespace in Visual Studio. |
!embracedanger |
How to bypass SMAPI's compatibility checks (not recommended). |
!embedcode |
How to embed code blocks in Discord. |
Just for fun (use sparingly to avoid spamming the channel):
command | purpose |
---|---|
!bigpuffer |
Pufferfish ASCII art. |
!fixanything |
Have you tried turning it off and on again? |
!harmony |
Here be dragons. Venture forth with bravery, young warrior, for thou art alone in these dark lands. (Includes useful diagram.) |
!officialhug |
Give someone a hug. |
!pathos |
The SMAPI developer when a game update arrives. |
!xnbzola |
About using obsolete XNB mods, per Zola. |