# Pericynth

> Pericynth runs Minecraft plugin tests with automated clients in disposable VMs. The product and documentation are still in development; examples may change.

## Documentation

- [Docs](/docs): Basic concepts, JSON configuration, test steps, and run reports. Full text is available in the HTML response without JavaScript or authentication.
- [Quickstart](/quickstart): Account and API token, client `service.json`, running `./gradlew runCI` and `--keep-open`, browser viewer, manual Minecraft join, and observer access.
- [Login](/login) and [Account](/account): Email and password accounts with verification and reset, Google and GitHub sign-in, and personal API tokens for the HTTPS CI client.

## Developer CI over HTTPS

Pericynth runs Minecraft plugin tests with automated clients in disposable VMs.
Developers keep running `./gradlew runCI`; `client/ci.py` uploads the project to
the website over HTTPS with a personal API token (`PERICYNTH_API_TOKEN`) instead
of SSH. The client streams live events, renews its run lease every 15 seconds,
downloads bounded logs and screenshots into `logsDir/RUN_ID/`, and exits 0 when
the assertions pass. `--keep-open` opens an interactive prompt with player
control, takeover/reconnect and a local Minecraft join address bridged over an
authenticated WebSocket; `--view RUN_ID player0` observes a run without stopping
it. Runs, reports, viewer sessions and cancellations are owned by the
authenticated account; another account cannot see or stop them.