Start here
Overview
The Teho Server API lets your server send features directly to Teho: a waypoint at an objective, a timer for the next round, or a notification when a match is ready. Your plugin controls the state; Teho handles how it appears in game.
Use the platform plugin for your server, then configure its built-in features or connect your own code through the API. Players without Teho can still join; Teho-specific features depend on the capabilities negotiated for each player.
Set up a server
Start with the installation guide for Paper, Spigot and Folia, Velocity, BungeeCord and Waterfall, or another platform. Proxy networks have a separate setup guide.
Once installed, set your server name and choose which features to enable in the configuration. The command reference covers in-game testing and permission nodes.
Integrate your plugin
The quickstart walks through adding the SDK and sending a notification. From there, the Java API explains player sessions and feature APIs, while events covers readiness and player interactions.
Check the module reference for the feature you want to build. Each module documents its messages, requirements and examples. Read core concepts before using features that request consent or share player data.
For a larger example, follow the match HUD or ranked queue guide. Servers written in other languages can use the Node.js, Python and Rust libraries, or implement the wire protocol.
Source and support
The SDK source is available on GitHub, and release artifacts are hosted in the package repository. See the changelog for SDK and protocol changes.
For integration questions, join the Teho developer Discord. Include your server platform, SDK version and the relevant code or error when asking for help.
Credits
Thanks to the Lunar Client team for Apollo. Its approach to server integrations and developer documentation helped inspire Teho Server API and this site.