https://github.com/nauja/sogmapi

Modding API for Secret of Grindea
https://github.com/nauja/sogmapi

api mod-api modding modloader secrets-of-grindea secrets-of-grindea-mods secretsofgrindea secretsofgrindea-mods smapi smapi-mod sog sog-mods sogmapi sogmapi-mod

Last synced: 23 days ago
JSON representation

Modding API for Secret of Grindea

• Host: GitHub
• URL: https://github.com/nauja/sogmapi
• Owner: Nauja
• License: lgpl-3.0
• Created: 2017-03-02T17:31:40.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-20T18:16:05.000Z (almost 3 years ago)
• Last Synced: 2025-04-06T14:14:12.667Z (10 months ago)
• Topics: api, mod-api, modding, modloader, secrets-of-grindea, secrets-of-grindea-mods, secretsofgrindea, secretsofgrindea-mods, smapi, smapi-mod, sog, sog-mods, sogmapi, sogmapi-mod
• Language: C#
• Homepage:
• Size: 6.89 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: docs/README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Secrets of Grindea Modding API

SoGMAPI is an open-source modding framework and API for [Secret of Grindea](http://store.steampowered.com/app/269770/), forked from [SMAPI](https://github.com/Pathoschild/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](https://github.com/Pathoschild/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

* [Player guide (SMAPI)](https://stardewvalleywiki.com/Modding:Player_Guide)

### For modders

* [Modding documentation (SMAPI)](https://smapi.io/docs)

* [Mod build configuration](technical/mod-package.md)

* [Release notes](release-notes.md)

### For SoGMAPI developers

* [Technical docs](technical/sogmapi.md)