https://github.com/etrusci-org/hylandbook

HYLANDBOOK watches your Schedule I save data files and logs progress to a local SQLite database. It can also automatically create/update export files with the current and history data. [ Demos: https://youtube.com/watch?v=bfY-a1li53U | https://twitch.tv/videos/2578729179 ] Last tested on game version 0.4.0f8.
https://github.com/etrusci-org/hylandbook

command-line command-line-tool exporter logger schedule-one sqlite sqlite-database sqlite3

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/etrusci-org/hylandbook
Owner: etrusci-org
License: other
Created: 2025-08-26T20:20:07.000Z (11 months ago)
Default Branch: main
Last Pushed: 2025-09-27T07:49:49.000Z (10 months ago)
Last Synced: 2025-10-23T22:07:45.318Z (9 months ago)
Topics: command-line, command-line-tool, exporter, logger, schedule-one, sqlite, sqlite-database, sqlite3
Language: Python
Homepage:
Size: 40.2 MB
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# HYLANDBOOK

HYLANDBOOK watches your [Schedule I](https://scheduleonegame.com) save data files and logs progress to a local [SQLite](https://sqlite.org) database.
It can also automatically create/update export files with the *current* and *history* data - nifty for showing live stats in [OBS Studio](https://obsproject.com) without programming knowledge, for example.
All save data files are accessed read-only - nothing is ever modified.
Note: Changes in your save data can only be detected after you save in-game.

Currently the following values from your save data are logged:
- save data directory name
- organisation name
- game seed
- game version
- total time played
- time of day
- elapsed days
- cash balance
- online balance
- networth
- lifetime earnings
- level rank
- level tier
- level xp
- total xp over all levels
- discovered products count
- owned businesses count
- owned properties count
- owned vehicles count

## Quickstart

1. Download `hylandbook.exe`.
2. Run `hylandbook.exe "C:\path to\SaveGame_1"`.
3. Save in-game from time to time.
4. Use the data from `book.db` or export files.

For detailed help read on.

## Requirements

Last tested on game version `0.4.0f5`.

- **Schedule I** save game folder
- **Windows OS (64-bit)**

optionally...

**Users**:
If you want to run it directly from the source code, [Python 3](https://python.org) is needed.
To run it from the source code: `python3 -m hylandbook`

**Developers**:
To install the development dependencies, run `install_pyreq.cmd`.
To build the executable, run `bakedist.cmd`.

## Installation

**1. Download the pre-built executable**:
Go to the [latest release page](https://github.com/etrusci-org/hylandbook/releases/latest) and download `hylandbook.exe`.

**2. Put it somewhere easy to find**:
Save it in a folder like `Documents` or `Downloads`.
**!** Don't put it in `Program Files` or other system folders - those need special permissions.
For the examples below, we assume you've saved it to your `Downloads` folder.

## Run it the easy way

To make things easier, I've included a ready-made script file. This lets you run HYLANDBOOK with a double-click, without typing commands.
You can find it alongside the [release files](https://github.com/etrusci-org/hylandbook/releases/latest).

**1. Save the script**:
Save the file `run_hylandook.cmd` in the same folder as `hylandbook.exe`.

**2. Edit the save game path**:
Right-click `run_hylandook.cmd` and choose **Edit** (this will open it in Notepad).

You'll see a line like this:
```txt
"PATH_TO_SAVEGAME_FOLDER_HERE"
```
Replace `PATH_TO_SAVEGAME_FOLDER_HERE` with the actual path to your save game folder.
Then save and close the file. For example:

Before:

```txt
.\hylandbook.exe ^
"PATH_TO_SAVEGAME_FOLDER_HERE" ^
--export-current txt ^
--export-keys organisation networth lifetimeearnings rank elapseddays
```

After:

```txt
.\hylandbook.exe ^
"C:\Users\Alice\AppData\LocalLow\TVGS\Schedule I\Saves\12345678909876543\SaveGame_1" ^
--export-current txt ^
--export-keys organisation networth lifetimeearnings rank elapseddays
```

**3. Run it**:
Now you can just double-click `run_hylandbook.cmd` and it will launch `hylandbook.exe` with the save game path you've edited in.
Additionally it will export/update a text file containing some stats whenever save data changes are detected.
You can right-click `run_hylandbook.cmd` and choose **Create shortcut**, then move the created shortcut to your **Desktop**.
This way you can launch it directly from the Desktop.

## Run it the manual way

**1. Open a command window**:
Press **Windows + R**, type `cmd`, and press **Enter**.

**2. Go to the folder where you saved it**:
In the command window, type:

```txt
cd "C:\path\to\Downloads"
```

Replace the path with the folder where you saved `hylandbook.exe`.
**!** If you saved it on a different drive (like `D:` or `E:`), type the drive letter first and press **Enter** before using `cd`. For example:

```txt
E:
cd "E:\path\to\Downloads"
```

**3. Run it**:
Type this and press **Enter**:

```txt
hylandbook.exe "C:\path to\Schedule I\SaveGame"
```

Replace the path with the location of your actual SaveGame folder.
Usually you should find your save game folder in:
`C:\Users\\AppData\LocalLow\TVGS\Schedule I\Saves\`

**4. Stop it**:
To stop at any time, press **CTRL + C** in the command window or just close the window.

**See all options**:
To view all options and their help text run it with the `--help` option.

```txt
hylandbook.exe --help
```

## Where data is saved

By default HYLANDBOOK creates a folder called `hb_data` in the folder from where you run `hylandbook.exe` (this is the "current working directory").

If you prefer the data to go somewhere else, use the `--data-dir` option to set a different folder:

```txt
hylandbook.exe "C:\path to\Schedule I\SaveGame" --data-dir "C:\path to\your hylandbook data folder"
```

## Detailed usage and options

Synopsis:

```txt
hylandbook.exe SAVEGAME_PATH [options]
```

**Required**:

`SAVEGAME_PATH`
Path to a Schedule I `SaveGame_*` directory, enclose it in quotes if it contains spaces.
Example: `"C:\path to\SaveGame_1"`

**Options**:

All options are optional and will use their defaults if not set by you.
You can either use the long or short form, e.g. `-i` and `--check-interval` are the same.

`-i, --check-interval SECONDS`
How frequently to check the save data for changes, in seconds.
Default: `60`
Minimum: `10`
Example: `-i 120`

`-c, --export-current [TYPE ...]`
One or more types of *current* export files to update each time save data changes are detected.
If you choose `html`, an additional `current_template.html` file will be created which you can edit to your liking. This template will then be used to generate `current.html`.
Default: *no export*
Choices: `json` `txt` `html`
Example: `-c json txt`

`-y, --export-history [TYPE ...]`
One or more types of *history* export files to update each time save data changes are detected.
If you choose `html`, an additional `history_template.html` file will be created which you can edit to your liking. This template will then be used to generate `history.html`.
Default: *no export*
Choices: `json` `csv` `html`
Example: `-y json csv`

`-m, --history-limit NUMBER`
Limit the number of recent rows that are exported in *history* export files.
Default: *no limit*
Minimum: `1`
Example: `-m 25`

`-k, --export-keys [KEY ...]`
Value keys of data to export. Only applies to *current* exports.
Default: *export all data*
Choices: `_t` `save_dir` `organisation` `seed` `save_id` `gameversion` `playtime` `timeofday` `elapseddays` `cashbalance` `onlinebalance` `networth` `lifetimeearnings` `rank` `tier` `xp` `totalxp` `discoveredproducts` `ownedbusinesses` `ownedproperties` `ownedvehicles`
Example: `-k organisation rank tier networth`

`-d, --data-dir PATH`
Path to folder where HYLANDBOOK will save data. Will be created automatically if it does not exist yet.
Default: `\hb_data`
Example: `-d "C:\path to\another data folder"`

`-h, --help`
Show this help.
Example: `-h`

## Database schema

Engine: SQLite3

```txt
TABLE: saves TABLE: logs
________________________ ______________________________
/ \ / \
| save_id [INTEGER] |----+ | log_id [INTEGER] |
| save_dir [TEXT] | | | log_time [REAL] |
| organisation [TEXT] | +----| save_id [INTEGER] |
| seed [INTEGER] | | gameversion [TEXT] |
\________________________/ | playtime [INTEGER] |
| timeofday [INTEGER] |
| elapseddays [INTEGER] |
| cashbalance [REAL] |
| onlinebalance [REAL] |
| networth [REAL] |
| lifetimeearnings [REAL] |
| rank [INTEGER] |
| tier [INTEGER] |
| xp [INTEGER] |
| totalxp [INTEGER] |
| discoveredproducts [INTEGER] |
| ownedbusinesses [INTEGER] |
| ownedproperties [INTEGER] |
| ownedvehicles [INTEGER] |
\______________________________/
```

```txt
CREATE TABLE 'saves' (
'save_id' INTEGER NOT NULL,
'save_dir' TEXT NOT NULL,
'organisation' TEXT NOT NULL,
'seed' INTEGER NOT NULL,
PRIMARY KEY('save_id' AUTOINCREMENT)
);

CREATE TABLE 'logs' (
'log_id' INTEGER NOT NULL,
'log_time' REAL NOT NULL,
'save_id' INTEGER NOT NULL,
'gameversion' TEXT DEFAULT NULL,
'playtime' INTEGER DEFAULT NULL,
'timeofday' INTEGER DEFAULT NULL,
'elapseddays' INTEGER DEFAULT NULL,
'cashbalance' REAL DEFAULT NULL,
'onlinebalance' REAL DEFAULT NULL,
'networth' REAL DEFAULT NULL,
'lifetimeearnings' REAL DEFAULT NULL,
'rank' INTEGER DEFAULT NULL,
'tier' INTEGER DEFAULT NULL,
'xp' INTEGER DEFAULT NULL,
'totalxp' INTEGER DEFAULT NULL,
'discoveredproducts' INTEGER DEFAULT NULL,
'ownedbusinesses' INTEGER DEFAULT NULL,
'ownedproperties' INTEGER DEFAULT NULL,
'ownedvehicles' INTEGER DEFAULT NULL,
PRIMARY KEY('log_id' AUTOINCREMENT),
FOREIGN KEY ('save_id') REFERENCES 'saves'('save_id')
);
```

## License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/etrusci-org/hylandbook

Awesome Lists containing this project

README