Building-from-Source.md

Building from Source

For development or advanced users. Most people should use a Release or WinGet instead.

Note: Code pull requests are not accepted at this time. See CONTRIBUTING.md. Issues and feedback are welcome.

Prerequisites

• Windows 10/11, or Linux (tested on Ubuntu 24.x LTS)
• Python 3.10+ (3.13 works fine)
• pip (usually included with Python)
• Git

Setup

git clone https://github.com/Matteo842/SaveState.git
cd SaveState

Create and activate a virtual environment:

python -m venv venv
# Windows
.\venv\Scripts\activate
# Linux/macOS
source venv/bin/activate

Install dependencies and run:

pip install -r requirements.txt
python main.py

Dependencies

Required:

Package	Role
PySide6	GUI (Qt for Python)
winshell	.lnk shortcuts and special folders (Windows)
pywin32	Used with winshell / COM shortcuts (Windows)

Optional (enhanced features):

Package	Role
vdf	More accurate Steam names/libraries
nbtlib	Minecraft world names from level.dat
thefuzz	Fuzzy string matching for save detection

Without the optional packages, core backup/restore still works; Steam/Minecraft naming and fuzzy matching may be less precise.