Search Results for

    Show / Hide Table of Contents

    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_LOCKFILE explicitly when discovery is non-standard

    Lockfile discovery follows a deterministic order:

    1. LCU_LOCKFILE environment override
    2. cached lockfile path (if still valid)
    3. process-derived lockfile candidates
    4. known install paths per platform

    What Thresh gives you

    • ILcuHttpClient for resilient LCU HTTP access
    • IEventStream for 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:

    1. Overview
    2. Package guidance
    3. Quickstart
    4. Security model
    5. Production patterns

    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:

    1. Build and preview docs locally with docfx docs/docfx.json --serve
    2. Run manual smoke validation on real Windows/macOS machines (see Manual validation)
    3. Publish release and docs via GitHub workflows (see Release process)
    • Edit this page
    In this article
    Back to top Generated by DocFX