{"id":31959975,"url":"https://github.com/etrusci-org/hylandbook","last_synced_at":"2026-04-19T05:33:33.749Z","repository":{"id":314604183,"uuid":"1045210961","full_name":"etrusci-org/hylandbook","owner":"etrusci-org","description":"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.","archived":false,"fork":false,"pushed_at":"2025-09-27T07:49:49.000Z","size":42195,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-23T22:07:45.318Z","etag":null,"topics":["command-line","command-line-tool","exporter","logger","schedule-one","sqlite","sqlite-database","sqlite3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/etrusci-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-26T20:20:07.000Z","updated_at":"2025-10-03T12:10:15.000Z","dependencies_parsed_at":"2025-10-14T15:52:10.717Z","dependency_job_id":"3a0e0068-ac5d-4636-b0e2-fd6a089fa4d4","html_url":"https://github.com/etrusci-org/hylandbook","commit_stats":null,"previous_names":["etrusci-org/hylandbook"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/etrusci-org/hylandbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etrusci-org%2Fhylandbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etrusci-org%2Fhylandbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etrusci-org%2Fhylandbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etrusci-org%2Fhylandbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/etrusci-org","download_url":"https://codeload.github.com/etrusci-org/hylandbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/etrusci-org%2Fhylandbook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31996441,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","command-line-tool","exporter","logger","schedule-one","sqlite","sqlite-database","sqlite3"],"created_at":"2025-10-14T15:52:03.905Z","updated_at":"2026-04-19T05:33:33.730Z","avatar_url":"https://github.com/etrusci-org.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HYLANDBOOK\n\nHYLANDBOOK watches your [Schedule I](https://scheduleonegame.com) save data files and logs progress to a local [SQLite](https://sqlite.org) database.  \nIt 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.  \nAll save data files are accessed read-only - nothing is ever modified.  \nNote: Changes in your save data can only be detected after you save in-game.\n\nCurrently the following values from your save data are logged:\n- save data directory name\n- organisation name\n- game seed\n- game version\n- total time played\n- time of day\n- elapsed days\n- cash balance\n- online balance\n- networth\n- lifetime earnings\n- level rank\n- level tier\n- level xp\n- total xp over all levels\n- discovered products count\n- owned businesses count\n- owned properties count\n- owned vehicles count\n\n\n\n\n## Quickstart\n\n1. Download `hylandbook.exe`.\n2. Run `hylandbook.exe \"C:\\path to\\SaveGame_1\"`.\n3. Save in-game from time to time.\n4. Use the data from `book.db` or export files.\n\nFor detailed help read on.\n\n\n\n\n## Requirements\n\nLast tested on game version `0.4.0f5`.\n\n- **Schedule I** save game folder\n- **Windows OS (64-bit)**\n\noptionally...\n\n**Users**:  \nIf you want to run it directly from the source code, [Python 3](https://python.org) is needed.  \nTo run it from the source code: `python3 -m hylandbook`\n\n**Developers**:  \nTo install the development dependencies, run `install_pyreq.cmd`.  \nTo build the executable, run `bakedist.cmd`.\n\n\n\n\n## Installation\n\n**1. Download the pre-built executable**:  \nGo to the [latest release page](https://github.com/etrusci-org/hylandbook/releases/latest) and download `hylandbook.exe`.\n\n**2. Put it somewhere easy to find**:  \nSave it in a folder like `Documents` or `Downloads`.  \n**!** Don't put it in `Program Files` or other system folders - those need special permissions.  \nFor the examples below, we assume you've saved it to your `Downloads` folder.\n\n\n\n\n## Run it the easy way\n\nTo make things easier, I've included a ready-made script file. This lets you run HYLANDBOOK with a double-click, without typing commands.\nYou can find it alongside the [release files](https://github.com/etrusci-org/hylandbook/releases/latest).\n\n**1. Save the script**:  \nSave the file `run_hylandook.cmd` in the same folder as `hylandbook.exe`.\n\n**2. Edit the save game path**:  \nRight-click `run_hylandook.cmd` and choose **Edit** (this will open it in Notepad).\n\nYou'll see a line like this:  \n```txt\n\"PATH_TO_SAVEGAME_FOLDER_HERE\"\n```\nReplace `PATH_TO_SAVEGAME_FOLDER_HERE` with the actual path to your save game folder.  \nThen save and close the file. For example:\n\nBefore:\n\n```txt\n.\\hylandbook.exe ^\n    \"PATH_TO_SAVEGAME_FOLDER_HERE\" ^\n    --export-current txt ^\n    --export-keys organisation networth lifetimeearnings rank elapseddays\n```\n\nAfter:\n\n```txt\n.\\hylandbook.exe ^\n    \"C:\\Users\\Alice\\AppData\\LocalLow\\TVGS\\Schedule I\\Saves\\12345678909876543\\SaveGame_1\" ^\n    --export-current txt ^\n    --export-keys organisation networth lifetimeearnings rank elapseddays\n```\n\n**3. Run it**:  \nNow you can just double-click `run_hylandbook.cmd` and it will launch `hylandbook.exe` with the save game path you've edited in.\nAdditionally it will export/update a text file containing some stats whenever save data changes are detected.  \nYou can right-click `run_hylandbook.cmd` and choose **Create shortcut**, then move the created shortcut to your **Desktop**.  \nThis way you can launch it directly from the Desktop.\n\n\n\n\n## Run it the manual way\n\n**1. Open a command window**:  \nPress **Windows + R**, type `cmd`, and press **Enter**.\n\n**2. Go to the folder where you saved it**:  \nIn the command window, type:\n\n```txt\ncd \"C:\\path\\to\\Downloads\"\n```\n\nReplace the path with the folder where you saved `hylandbook.exe`.  \n**!** 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:\n\n```txt\nE:\ncd \"E:\\path\\to\\Downloads\"\n```\n\n**3. Run it**:  \nType this and press **Enter**:\n\n```txt\nhylandbook.exe \"C:\\path to\\Schedule I\\SaveGame\"\n```\n\nReplace the path with the location of your actual SaveGame folder.  \nUsually you should find your save game folder in:  \n`C:\\Users\\\u003cYourName\u003e\\AppData\\LocalLow\\TVGS\\Schedule I\\Saves\\\u003cYourSteamID\u003e`\n\n**4. Stop it**:  \nTo stop at any time, press **CTRL + C** in the command window or just close the window.\n\n**See all options**:  \nTo view all options and their help text run it with the `--help` option.\n\n```txt\nhylandbook.exe --help\n```\n\n\n\n## Where data is saved\n\nBy default HYLANDBOOK creates a folder called `hb_data` in the folder from where you run `hylandbook.exe` (this is the \"current working directory\").\n\nIf you prefer the data to go somewhere else, use the `--data-dir` option to set a different folder:\n\n```txt\nhylandbook.exe \"C:\\path to\\Schedule I\\SaveGame\" --data-dir \"C:\\path to\\your hylandbook data folder\"\n```\n\n\n\n\n## Detailed usage and options\n\nSynopsis:\n\n```txt\nhylandbook.exe SAVEGAME_PATH [options]\n```\n\n**Required**:\n\n`SAVEGAME_PATH`  \nPath to a Schedule I `SaveGame_*` directory, enclose it in quotes if it contains spaces.  \nExample: `\"C:\\path to\\SaveGame_1\"`\n\n**Options**:\n\nAll options are optional and will use their defaults if not set by you.  \nYou can either use the long or short form, e.g. `-i` and `--check-interval` are the same.\n\n`-i, --check-interval SECONDS`  \nHow frequently to check the save data for changes, in seconds.  \nDefault: `60`  \nMinimum: `10`  \nExample: `-i 120`\n\n`-c, --export-current [TYPE ...]`  \nOne or more types of *current* export files to update each time save data changes are detected.  \nIf 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`.  \nDefault: *no export*  \nChoices: `json` `txt` `html`  \nExample: `-c json txt`\n\n`-y, --export-history [TYPE ...]`  \nOne or more types of *history* export files to update each time save data changes are detected.  \nIf 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`.  \nDefault: *no export*  \nChoices: `json` `csv` `html`  \nExample: `-y json csv`\n\n`-m, --history-limit NUMBER`  \nLimit the number of recent rows that are exported in *history* export files.  \nDefault: *no limit*  \nMinimum: `1`  \nExample: `-m 25`\n\n`-k, --export-keys [KEY ...]`  \nValue keys of data to export. Only applies to *current* exports.  \nDefault: *export all data*  \nChoices: `_t` `save_dir` `organisation` `seed` `save_id` `gameversion` `playtime` `timeofday` `elapseddays` `cashbalance` `onlinebalance` `networth` `lifetimeearnings` `rank` `tier` `xp` `totalxp` `discoveredproducts` `ownedbusinesses` `ownedproperties` `ownedvehicles`  \nExample: `-k organisation rank tier networth`\n\n`-d, --data-dir PATH`  \nPath to folder where HYLANDBOOK will save data. Will be created automatically if it does not exist yet.  \nDefault: `\u003ccurrent working directory\u003e\\hb_data`  \nExample: `-d \"C:\\path to\\another data folder\"`\n\n`-h, --help`  \nShow this help.  \nExample: `-h`\n\n\n\n\n## Database schema\n\nEngine: SQLite3\n\n```txt\n TABLE: saves                       TABLE: logs\n ________________________           ______________________________\n/                        \\         /                              \\\n| save_id      [INTEGER] |----+    | log_id             [INTEGER] |\n| save_dir     [TEXT]    |    |    | log_time           [REAL]    |\n| organisation [TEXT]    |    +----| save_id            [INTEGER] |\n| seed         [INTEGER] |         | gameversion        [TEXT]    |\n\\________________________/         | playtime           [INTEGER] |\n                                   | timeofday          [INTEGER] |\n                                   | elapseddays        [INTEGER] |\n                                   | cashbalance        [REAL]    |\n                                   | onlinebalance      [REAL]    |\n                                   | networth           [REAL]    |\n                                   | lifetimeearnings   [REAL]    |\n                                   | rank               [INTEGER] |\n                                   | tier               [INTEGER] |\n                                   | xp                 [INTEGER] |\n                                   | totalxp            [INTEGER] |\n                                   | discoveredproducts [INTEGER] |\n                                   | ownedbusinesses    [INTEGER] |\n                                   | ownedproperties    [INTEGER] |\n                                   | ownedvehicles      [INTEGER] |\n                                   \\______________________________/\n```\n\n```txt\nCREATE TABLE 'saves' (\n    'save_id' INTEGER NOT NULL,\n    'save_dir' TEXT NOT NULL,\n    'organisation' TEXT NOT NULL,\n    'seed' INTEGER NOT NULL,\n    PRIMARY KEY('save_id' AUTOINCREMENT)\n);\n\nCREATE TABLE 'logs' (\n    'log_id' INTEGER NOT NULL,\n    'log_time' REAL NOT NULL,\n    'save_id' INTEGER NOT NULL,\n    'gameversion' TEXT DEFAULT NULL,\n    'playtime' INTEGER DEFAULT NULL,\n    'timeofday' INTEGER DEFAULT NULL,\n    'elapseddays' INTEGER DEFAULT NULL,\n    'cashbalance' REAL DEFAULT NULL,\n    'onlinebalance' REAL DEFAULT NULL,\n    'networth' REAL DEFAULT NULL,\n    'lifetimeearnings' REAL DEFAULT NULL,\n    'rank' INTEGER DEFAULT NULL,\n    'tier' INTEGER DEFAULT NULL,\n    'xp' INTEGER DEFAULT NULL,\n    'totalxp' INTEGER DEFAULT NULL,\n    'discoveredproducts' INTEGER DEFAULT NULL,\n    'ownedbusinesses' INTEGER DEFAULT NULL,\n    'ownedproperties' INTEGER DEFAULT NULL,\n    'ownedvehicles' INTEGER DEFAULT NULL,\n    PRIMARY KEY('log_id' AUTOINCREMENT),\n    FOREIGN KEY ('save_id') REFERENCES 'saves'('save_id')\n);\n```\n\n\n\n\n## License\n\nHYLANDBOOK is licensed under **The MIT License**  \n**Copyright (c) 2025 arT2 (\u003chttps://etrusci.org\u003e)**\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetrusci-org%2Fhylandbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fetrusci-org%2Fhylandbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetrusci-org%2Fhylandbook/lists"}