Thresh
Thresh is a low-level, modular .NET library for integrating with the League Client API (LCU).
It provides reliable transport and event primitives with DI-first integration, while keeping high-level orchestration in consumer code.
Runtime and platform support
- Supported target frameworks for runtime packages:
net8.0,net10.0 - Officially supported operating systems: Windows and macOS
- Other environments (including Linux/Wine/Proton variants) are best-effort; use
LCU_LOCKFILEexplicitly when discovery is non-standard
Lockfile discovery follows a deterministic order:
LCU_LOCKFILEenvironment override- cached lockfile path (if still valid)
- process-derived lockfile candidates
- known install paths per platform
What Thresh gives you
ILcuHttpClientfor resilient LCU HTTP accessIEventStreamfor reconnect-aware WAMP event streaming- optional typed endpoint groups and integration packages
- DI-native wiring through
AddThresh(...) - observability hooks via logging, metrics, and tracing
Start path
If you are new to the repository, use this sequence:
Guides
- Configuration
- Endpoints
- Reactive usage
- Hosting integration
- Health checks
- Observability
- Testing patterns
- Troubleshooting
- Manual validation (Windows/macOS)
- Release process
- API Reference
Maintainer path
For release readiness and docs delivery:
- Build and preview docs locally with
docfx docs/docfx.json --serve - Run manual smoke validation on real Windows/macOS machines (see Manual validation)
- Publish release and docs via GitHub workflows (see Release process)