Skip to content

Commit

Permalink
Expand description, add install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ThymoNL committed Jan 31, 2024
1 parent 1064776 commit 00d5b69
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# StateSnap
StateSnap saves your stuff
StateSnap is a module for Orbiter implementing an autosave feature.
When StateSnap is enabled it will automatically save the current simulation to your Scenarios folder as "StateSnap".

This way you can revert to roughly what you were doing in case you made a mistake or Orbiter crashed.

# Installing
1. Get the dll from the release (or build it yourself, see below).
2. The pre-built dll has been tested against the latest Orbiter Beta.
2. Place the dll in the `Modules\Plugin` directory in your Orbiter installation.
3. In the Orbiter Launchpad, enable the StateSnap module from the `Modules` tab.

## Building
You need the following things:
* CMake
* MSVC Toolchain
* (Recommended) CLion

### CMake variables
`ORBITER_SDK_DIR`: Path to Orbitersdk directory.
`ORBITER_SDK_DIR`: Path to Orbitersdk directory.\
`ORBITER_PLUGIN_DIR`: Path to install plugin to.
2 changes: 1 addition & 1 deletion Resources.rc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

STRINGTABLE
BEGIN
IDS_INFO "StateSnap:\r\n\r\nThis plugin will periodically save the current scenario.\r\n\r\n
IDS_INFO "StateSnap:\r\n\r\nThis plugin will save the current scenario every 10 minutes.\r\n\r\n
Author: Thymo van Beers\r\n\
Version: 0.1\r\n\
Source Code: https:\//github.com/ThymoNL/StateSnap\r\n\r\n
Expand Down

0 comments on commit 00d5b69

Please sign in to comment.