The complete list of important project documents: policies, license, technical and process documents.
| Document | Contents |
|---|
| PRIVACY.md | Local data, optional telemetry (disabled by default), third-party services, contact for privacy requests. |
| SECURITY.md | Private vulnerability reporting, security scope, threat model, credential storage, supported versions. |
| CODE_SIGNING_POLICY.md | Current Windows signing status, release provenance, and artifact verification. |
The same policies in a readable form: Privacy, Security, Code signing.
| Document | Contents |
|---|
| LICENSE | GNU GPL v3.0: you may use, study, modify, and redistribute under the terms of GPLv3. |
| NOTICE | Copyright (© 2026 AmadoMuerte), redistribution obligations, third-party component notices (go-keyring, dbus, wincred — MIT/permissive). |
| Document | Contents |
|---|
| README.md | Project overview, features, download, first steps, building from source. Russian version: docs/README.ru.md. |
| AGENTS.md | Project rules for agents and contributors: workflow, layer structure, data safety, branching (main/dev), PR requirements. |
| Document | Contents |
|---|
| authentication.md | Vintage Story authentication protocol, network boundary, session storage, transactions, legacy-secret migration, launch credential lifetime. |
| game-versions.md | The official version feed, platform selection, installation pipeline, MD5/SHA-256, known boundaries. |
| modpack.md | The mod update analysis library: Catalog contract, statuses, candidate selection, compatibility, dependencies. |
| operations-page.md | Operations page contract: statuses, cancellation as rollback, history deletion, required regression tests. |
| windows-updater.md | Windows auto-update architecture: SHA256SUMS vs Authenticode, trust model, and installation modes. |
| Document | Contents |
|---|
| CONTRIBUTING.md | Environment setup, required checks before a PR, localization, architecture expectations, commit workflow. |
A developer summary is on the Development page.
