SMAPI/README.md

SMAPI is an open-source modding API for Stardew Valley. It takes care of loading mods into the game context, and exposes events they can use to interact with the game. It's safely installed alongside the game's executable, and doesn't change any of your game files.

Contents

• For players
• For mod developers
• For SMAPI developers
  • Compiling from source
  • Debugging a local build
  • Preparing a release
• Advanced usage
  • Configuration file
  • Command-line arguments

For players

• How to install SMAPI & use mods
• Release notes
• Need help? Come chat on Discord or post in the support forums.
  Please don't submit issues on GitHub for support questions.

For mod developers

• How to develop mods
• How to update mods
• Release notes
• SMAPI/Farmhand Discord (chat with SMAPI developers)

For SMAPI developers

This section is about compiling SMAPI itself from source. If you don't know what that means, this section isn't relevant to you; see the previous sections to use or create mods.

Compiling from source

Using an official SMAPI release is recommended for most users.

If you'd like to compile SMAPI from source, you can do that on any platform using Visual Studio or MonoDevelop. SMAPI uses build configuration derived from the crosswiki mod config to detect your current OS automatically and load the correct references. Compile output will be placed in a bin folder at the root of the git repository.

Debugging a local build

Rebuilding the solution in debug mode will copy the SMAPI files into your game folder. Starting the StardewModdingAPI project with debugging will launch SMAPI with the debugger attached, so you can intercept errors and step through the code being executed.

Preparing a release

To prepare a crossplatform SMAPI release, you'll need to compile it on two platforms. See crossplatforming a SMAPI mod for the first-time setup. For simplicity, all paths are relative to the root of the repository (the folder containing src).

1. Update the version number in GlobalAssemblyInfo.cs and Constants::Version. Make sure you use a semantic version. Recommended format:

   build type	format	example
   dev build	<version>-alpha.<timestamp>	1.0.0-alpha.20171230
   beta	<version>-beta.<incrementing ID>	1.0.0-beta, 1.0.0-beta.2, <20>
   release	<version>	1.0.0

2. In Windows:

   1. Rebuild the solution in Release mode.
   2. Rename bin/Packaged to SMAPI <version> (e.g. SMAPI 1.6).
   3. Transfer the SMAPI <version> folder to Linux or Mac.
      This adds the installer executable and Windows files. We'll do the rest in Linux or Mac, since we need to set Unix file permissions that Windows won't save.

3. In Linux or Mac:

   1. Rebuild the solution in Release mode.

   2. Copy bin/internal/Packaged/Mono into the SMAPI <version> folder.

   3. If you did everything right so far, you should have a folder like this:

      SMAPI-1.x/
         install.exe
         readme.txt
         internal/
            Mono/
               Mods/*
               Mono.Cecil.dll
               Newtonsoft.Json.dll
               StardewModdingAPI
               StardewModdingAPI.AssemblyRewriters.dll
               StardewModdingAPI.config.json
               StardewModdingAPI.exe
               StardewModdingAPI.exe.mdb
               steam_appid.txt
               System.Numerics.dll
               System.Runtime.Caching.dll
            Windows/
               Mods/*
               Mono.Cecil.dll
               Newtonsoft.Json.dll
               StardewModdingAPI.AssemblyRewriters.dll
               StardewModdingAPI.config.json
               StardewModdingAPI.exe
               StardewModdingAPI.pdb
               StardewModdingAPI.xml
               steam_appid.txt
      

   4. Open a terminal in the SMAPI <version> folder and run chmod 755 internal/Mono/StardewModdingAPI.

   5. Copy & paste the SMAPI <version> folder as SMAPI <version> for developers.

   6. In the SMAPI <version> folder, delete the following files:

      • internal/Mono/StardewModdingAPI.config.json
      • internal/Windows/StardewModdingAPI.config.json
      • internal/Windows/StardewModdingAPI.xml

   7. Compress the two folders into SMAPI <version>.zip and SMAPI <version> for developers.zip.

Advanced usage

Configuration file

You can customise the SMAPI behaviour by editing the StardewModdingAPI.config.json file in your game folder. If it's missing, it'll be generated automatically next time SMAPI runs. It contains these fields:

field	purpose
DeveloperMode	Default false (except in SMAPI for developers releases). Whether to enable features intended for mod developers. Currently this only makes TRACE-level messages appear in the console.
CheckForUpdates	Default true. Whether SMAPI should check for a newer version when you load the game. If a new version is available, a small message will appear in the console. This doesn't affect the load time even if your connection is offline or slow, because it happens in the background.

Command-line arguments

SMAPI recognises the following command-line arguments. These are intended for internal use and may change without warning.

argument	purpose
--no-terminal	SMAPI won't write anything to the console window. (Messages will still be written to the log file.)