Modding:Modder Guide/Testing and Releasing

Creating SMAPI mods

---

• Get started
• Game fundamentals
• Test & troubleshoot
• Release
• API reference

  Basic SMAPI APIs:

  • Mod structure
  • Manifest
  • Events
  • Configuration
  • Load & edit content
  • Data
  • Input
  • Logging
  • Reflection
  • Multiplayer
  • Translation
  • Update checks
  • Utilities

  Advanced SMAPI APIs:

  • Content packs
  • Mod console commands
  • Mod integrations
  • Harmony patching

• Specific guides

← Modding:Index

Once you're ready to share your mod, it's time to test and release it!

Test on all platforms

If you want to test your mod on all platforms, there's some first-time setup you need to get out of the way. Essentially you need to test your mod twice: once on Windows, and again on Linux or Mac. You can do that by testing one version on your computer, and the other in a virtual machine.

• If your main computer is Windows:
  1. Install VirtualBox.
  2. Add this premade Linux virtual machine (requires a 64-bit computer).
     In VirtualBox, click Machine » Add and choose the downloaded .vbox file. This is a Manjaro virtual machine with Chromium (web browser), Steam, and MonoDevelop preinstalled.
  3. Launch the virtual machine, and install Stardew Valley from the Steam client (preinstalled) or GOG website.
     Tip: don't change the default install path, or you'll need to customise the mod's build configuration.

• If your main computer is Linux or Mac:
  1. Install VirtualBox.
  2. Create a VM with Windows.
  3. Install Visual Studio Community in your VM.
  4. Install Stardew Valley in your VM.

Release your mod

Ready to share your mod with the world? Here's how:

1. Open your project's bin/Debug or bin/Release folder (depending on your build configuration).
2. There should be a .zip file there for your mod version.
3. Upload that file to Nexus Mods.

In your mod description, providing clear install steps will help reduce support questions. Example BBCode:

[size=5]Install[/size]
[list=1]
[*][url=https://smapi.io]Install the latest version of SMAPI[/url].
[*]Download this mod and unzip it into [font=Courier New]Stardew Valley/Mods[/font].
[*]Run the game using SMAPI.
[/list]