Nauja / SoGMAPI

Modding API for Secret of Grindea
GNU Lesser General Public License v3.0
3 stars 0 forks source link
api mod-api modding modloader secrets-of-grindea secrets-of-grindea-mods secretsofgrindea secretsofgrindea-mods smapi smapi-mod sog sog-mods sogmapi sogmapi-mod

Secrets of Grindea Modding API

SoGMAPI is an open-source modding framework and API for Secret of Grindea, forked from SMAPI, 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.

Features

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

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

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

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

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

Documentation

Most of the documentation available for SMAPI should also work for SoGMAPI as this is a fork with the same structure, same installer and same modding API.

Have questions? You can ask me on GitHub or send me an email.

For players

For modders

For SoGMAPI developers