Difference between revisions of "Modding:Help"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Using mods: mention Content Patcher explicitly for r/SMAPI)
(→‎Info to include: rework a bit to better cover content)
Line 31: Line 31:
 
:# <tt>#game-support</tt> on the [https://discord.gg/stardewvalley Stardew Valley Discord] (no mic, audio, or download needed). (The channels will be hidden when you first join. Read <tt>#join-other-channels</tt> and follow the instructions there to enable the other channels.)
 
:# <tt>#game-support</tt> on the [https://discord.gg/stardewvalley Stardew Valley Discord] (no mic, audio, or download needed). (The channels will be hidden when you first join. Read <tt>#join-other-channels</tt> and follow the instructions there to enable the other channels.)
  
==Info to include==
+
==How to…==
===Details to give===
+
===Get help===
When asking for help, you should provide info to help them identify it. In particular, include your...
+
See the above sections for where to get help. Make sure you provide info to help find the problem, including…
  
* platform (e.g. Linux, Windows, Android, etc);
+
* your platform (e.g. Linux, Windows, Android, etc);
* game version;
+
* your game version;
* [https://smapi.io/log/ SMAPI log] (if playing with mods);
+
* your [https://smapi.io/log/ SMAPI log] (if playing with mods);
 
* repro steps (instructions to cause the issue);
 
* repro steps (instructions to cause the issue);
 
* screenshots of the issue (if relevant).
 
* screenshots of the issue (if relevant).
  
===How to share your log===
+
===Share your log===
 
''(Only applies if you use mods.)''
 
''(Only applies if you use mods.)''
  
Line 51: Line 51:
 
# Include the URL when asking for help.
 
# Include the URL when asking for help.
  
===How to share screenshots===
+
===Share screenshots===
 
# [https://www.take-a-screenshot.org/ Take a screenshot] of the issue.
 
# [https://www.take-a-screenshot.org/ Take a screenshot] of the issue.
 
# Upload it to a site like [https://pasteboard.co/ Pasteboard].
 
# Upload it to a site like [https://pasteboard.co/ Pasteboard].
Line 58: Line 58:
 
''Note: when asking for help on Discord, you can also paste or drag the file into Discord directly.''
 
''Note: when asking for help on Discord, you can also paste or drag the file into Discord directly.''
  
===How to share files===
+
===Share files===
 
If you need to share files:
 
If you need to share files:
  

Revision as of 15:31, 1 February 2020

Index

Stardew Valley has a very friendly community. If you need help, this page is for you!

Get help with…

Using mods

Before you ask:

  1. Check the player's guide to mods, many questions are answered there.
  2. Need help with a specific mod? Try asking on its mod page or checking the mod compatibility list first.
  3. See what to include when asking for help.

Where to ask:

  1. r/SMAPI on Reddit is the official subreddit for asking questions, getting help, and discussing SMAPI, Content Patcher, and mods.
  2. The Stardew Valley Discord (no mic, audio, or download needed) has a #modding channel for help installing/using/creating mods, or discussing mods in general. Modders also discuss their work, chat, and collaborate here. (The channels will be hidden when you first join. Read #join-other-channels and follow the instructions there to enable the other channels.)

Creating mods

Before you ask:

  1. Check the mod author guide, many questions are answered there.
  2. The guide has other sections in the sidebar! In particular, the troubleshooting and SMAPI reference pages may be useful.

Where to ask:

  1. r/SMAPI on Reddit is the official subreddit for asking questions, getting help, and discussing SMAPI + mods + content packs.
  2. The Stardew Valley Discord (no mic, audio, or download needed) has a #modding channel for help installing/using/creating mods, or discussing mods in general. Modders also discuss their work, chat, and collaborate here. (The channels will be hidden when you first join. Read #join-other-channels and follow the instructions there to enable the other channels.)

Game problems

Before you ask:

  1. Do you use mods? Check if it happens without mods first. If not, see using mods instead.
  2. See what to include when asking for help.

Where to ask:

  1. #game-support on the Stardew Valley Discord (no mic, audio, or download needed). (The channels will be hidden when you first join. Read #join-other-channels and follow the instructions there to enable the other channels.)

How to…

Get help

See the above sections for where to get help. Make sure you provide info to help find the problem, including…

  • your platform (e.g. Linux, Windows, Android, etc);
  • your game version;
  • your SMAPI log (if playing with mods);
  • repro steps (instructions to cause the issue);
  • screenshots of the issue (if relevant).

Share your log

(Only applies if you use mods.)

The SMAPI log has a lot of useful info; include it even if you don't see an error!

To share your log:

  1. Upload it to smapi.io/log (see that page for instructions).
  2. Copy the URL it gives you after uploading.
  3. Include the URL when asking for help.

Share screenshots

  1. Take a screenshot of the issue.
  2. Upload it to a site like Pasteboard.
  3. Include the URL when asking for help.

Note: when asking for help on Discord, you can also paste or drag the file into Discord directly.

Share files

If you need to share files:

  1. Upload it to a site like catbox.moe.
  2. Include the URL when asking for help.