Skip to content

Rezeptor

Tested BYOS Proton-GE

Rezeptor Documentation

Official handbook for Rezeptor — install, validate, launch, and cleanly remove Windows software under Proton-GE on Linux. For users and recipe authors.

Important for newcomers

Rezeptor does not redistribute Windows applications. You bring your legal source (BYOS). Each recipe knows how to install, repair, validate, launch, and uninstall under Proton-GE.

Quick start in four steps

  1. Download a release or run ./setup.sh in a clone
  2. Pick a recipe → set source → Install
  3. Check status (F5) → Launch
  4. Overview → User guide

Switch language: top right (DE / EN).

Paths

Goal Page
Install & first steps Quick start
GUI, sources, lifecycle User guide
What’s bundled? Recipe catalog

AppImage / Flatpak / tar.gz

Goal Page
Start & recipe types Developer
recipe.yml / install_steps RECIPE-AUTHORING
Shared core CORE-API
Validate → repair VALIDATE-REPAIR

Contributing

Topics

  • Quick start


    Installation, first steps, and data locations.

    Quick start

  • User guide


    GUI, sources, validate, repair, uninstall.

    User guide

  • Recipe catalog


    Official vs community recipes, trust, multi-source.

    Catalog

  • For developers


    Authoring recipes, Core API, validate/repair contract.

    Developer overview

  • Project layout


    Repo layout, recipes/, core/, launcher/.

    Layout

  • Trust & manifest


    SHA256 integrity, Dev mode, community path.

    Trust

  • Patterns


    Installer, portable, Steam+fix, trainer.

    Offline installer

  • Contributing


    PRs, lint, tests, translations.

    Contributing

Brand status colors

Chip Meaning
Tested Guaranteed / checked recipe path
Experimental Not hard-guaranteed yet
BYOS You bring the source — no downloads in-repo

See BRAND.md.

In the repository

Topic Link
Releases (AppImage / Flatpak / tar.gz) GitHub Releases
Project README README.md
Contributing (translations) CONTRIBUTING-TRANSLATIONS.md
Brand BRAND.md
make validate                 # shellcheck, syntax, compile, i18n-check, ruff, recipes-check, recipe-lint, manifest
make test                     # bats
make pytest                   # launcher unit tests under tests/*.py (needs pytest + PyQt6)

Preview the site locally

python3 -m venv .venv-docs
. .venv-docs/bin/activate
pip install -r requirements-docs.txt
mkdocs serve