• Stars
    star
    1,768
  • Rank 26,334 (Top 0.6 %)
  • Language
    C#
  • License
    GNU Lesser Genera...
  • Created over 8 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The modding API for Stardew Valley.

SMAPI is an open-source modding framework and API for Stardew Valley that lets you play the game with mods. It's safely installed alongside the game's executable, and doesn't change any of your game files. It serves seven main purposes:

  1. Load mods into the game.
    SMAPI loads mods when the game is starting up so they can interact with it. (Code mods aren't possible without SMAPI to load them.)

  2. Provide APIs and events for mods.
    SMAPI provides APIs and events which let mods interact with the game in ways they otherwise couldn't.

  3. Rewrite mods for compatibility.
    SMAPI rewrites mods' compiled code before loading them so they work on Linux/macOS/Windows without the mods needing to handle differences between the Linux/macOS and Windows versions of the game. In some cases it also rewrites code broken by a game update so the mod doesn't break.

  4. Intercept errors and automatically fix saves.
    SMAPI intercepts errors, shows the error info in the SMAPI console, and in most cases automatically recovers the game. That prevents mods from crashing the game, and makes it possible to troubleshoot errors in the game itself that would otherwise show a generic 'program has stopped working' type of message.

    SMAPI also automatically fixes save data in some cases when a load would crash, e.g. due to a custom location or NPC mod that was removed.

  5. Provide update checks.
    SMAPI automatically checks for new versions of your installed mods, and notifies you when any are available.

  6. Provide compatibility checks.
    SMAPI automatically detects outdated or broken code in mods, and safely disables them before they cause problems.

  7. Back up your save files.
    SMAPI automatically creates a daily backup of your saves and keeps ten backups (via the bundled Save Backup mod), in case something goes wrong.

Documentation

Have questions? Come ask the community to get help from SMAPI developers and other modders!

For players

For modders

For SMAPI developers

Translating SMAPI

SMAPI rarely shows text in-game, so it only has a few translations. Contributions are welcome! See Modding:Translations on the wiki for help contributing translations.

locale status
default ✓ fully translated
Chinese ✓ fully translated
French ✓ fully translated
German ✓ fully translated
Hungarian ✓ fully translated
Italian ✓ fully translated
Japanese ✓ fully translated
Korean ✓ fully translated
Polish ✓ fully translated
Portuguese ✓ fully translated
Russian ✓ fully translated
Spanish ✓ fully translated
Thai ✓ fully translated
Turkish ✓ fully translated
Ukrainian ✓ fully translated

More Repositories

1

StardewMods

Mods for Stardew Valley using SMAPI.
C#
675
star
2

FluentHttpClient

A modern async HTTP client for REST APIs. Its fluent interface lets you send an HTTP request and parse the response in one go.
C#
341
star
3

StardewXnbHack

A simple one-way XNB unpacker for Stardew Valley.
C#
131
star
4

Wikimedia-contrib

A collection of user scripts and Tool Labs tools intended for users of Wikimedia Foundation wikis.
PHP
45
star
5

smapi-mod-dump

A dump of all compiled SMAPI mods, used for compatibility testing.
29
star
6

NaturalTimeParser

A partial C# implementation of natural time formats like "last month +3 days" which can be used in date arithmetic.
C#
28
star
7

stewbot

A Python IRC script which automates interactions with MediaWiki wikis based on commands given by users on IRC; primarily intended for Wikimedia steward or administrator operations, but work is being done to enable Wikia and generic wiki use.
Python
14
star
8

webapi.nhibernate-odata

Resolves LINQ compatibility issues between ASP.NET Web API OData and NHibernate.
C#
10
star
9

DesignByContract

A high-performance aspect-oriented argument validation framework built on top of the free edition of PostSharp.
C#
10
star
10

StardewScripts

Various scripts for Stardew Valley modding, from splitting spritesheets to downloading & analyzing all mods.
C#
10
star
11

StardewCommunityMods

Stardew Valley mods maintained by the community.
9
star
12

FluentJira

A tiny framework for using JIRA's REST API from C#. It handles authentication and maps REST responses to strongly-typed models.
C#
8
star
13

PredicateSecurity

Provides relational security on content collections (including deferred LINQ queries for NHibernate or Entity Framework). This lets you define security groups and permissions using LINQ criteria, and then filter collections based on these security rules.
C#
8
star
14

Wikimedia-contrib.toolserver

Obsolete!
PHP
6
star
15

FluentNexus

A modern async HTTP client for the Nexus Mods API.
C#
5
star
16

JPoker

A simple implementation of Texas Hold 'em to learn cards and Java.
Java
5
star
17

Stardew.ModBuildConfig

MSBuild configuration for a crossplatform Stardew Valley mod using SMAPI.
4
star
18

LanguageData

A C# view of the Unicode CLDR database of the world's languages, for use in other packages. This library currently provides a complete view of pluralisation rules.
C#
4
star
19

canimod.github.io

A collaborative GitHub Pages website about modding Stardew Valley.
4
star
20

ModDependencyAnalyzer

Generates a directed graph of mod dependencies from your Stardew Valley mods folder.
C#
3
star
21

ChestsAnywhere

Obsolete.
2
star
22

ConfigStringParser

Provides a strongly-typed parser for building and consuming arbitrary connection strings.
C#
2
star
23

StardewGameFolderCheck

A utility which validates the integrity of a Stardew Valley game folder for troubleshooting.
C#
2
star
24

HatMouse

A quick and dirty site to show Steam game prizes for events on the Stardew Valley Discord server.
C#
1
star
25

SMAPI-ModTranslationClassBuilder

Autogenerate a strongly-typed class to access i18n translation files from your SMAPI mod code.
C#
1
star
26

webscript-helpers

A collection of generic scripts for writing Webscript.io webhooks.
Lua
1
star