stardew-git

A tool that versions changes in Stardew Valley savegames with git.


Keywords
Stardew Valley, git, savegame, version control
License
MIT
Install
npm install stardew-git@1.0.3

Documentation

stardew-git NPM version Pipeline status

A tool that versions changes in Stardew Valley savegames with git.

About

This tool allows you to put your Stardew Valley savegames under version control to back it up and also allow you to go back in time by checking out earlier commits.

It will create commits with this name pattern: Day #123.

How

Stardew Valley savegames are simple (but huge!) XML files, that are saved as one-liners (though there are some quest texts that include linefeeds). This tool simply pretty-prints your savegame and the SaveGameInfo file and commits them to a git repository (which it creates for you).

Requirements

Git needs to be installed on your system.

... and Stardew Valley of course.

Usage

Syntax

stardew-git [-p|--push] <savegamePath>

The --push flag is optional and allows the tool to automatically push.

Windows

The game was only released for Windows PCs so far, but the syntax would still be the same; the command, optionss and the path to the savegame's directory.

stardew-git [-p|--push] %APPDATA%\StardewValley\Saves\<YourSavegame>

Roadmap

  • Add the possibility to use a config file
  • Allow multiple savegames to be watched simultaneously

Disclaimer

By using this tool you agree to the following:

I can not be held responsible for any kind of damage done to your savegames. Nothing is perfect and bugs may exist.

Please perform a backup of your savegames before using this tool and report bugs that you may encounter.