Skip to content

GOKZ.TOP Docs

Welcome to the documentation space for GOKZ.TOP.

This site will collect public guides for players, server operators, plugin maintainers, and API users. The first production pages should focus on the topics people need to understand or operate outside the main website UI.

Planned Topics

  • How the rating and points systems work
  • How to apply for and use an API key
  • How verified player stream links are tracked on /live
  • How to install and configure SourceMod plugins
  • Server operator setup and troubleshooting
  • General FAQs for leaderboards, maps, profiles, and records

Current Status

This is an initial MkDocs Material scaffold. More complete pages will be added as product behavior and community workflows are documented. The public website now includes a /live page that tracks verified player Bilibili streams, including recent offline history once a stream has been observed.

Authenticated players can now add Discord webhooks from /settings to receive embed-based notifications when their verified Twitch or Bilibili stream starts. The first version sends all supported stream-start events to every enabled webhook and includes player identity plus the latest stream preview image when available.

Players can also self-verify Bilibili links from /settings by placing a short verification code in their public Bilibili profile text and confirming it from the website.

Server operators can now publish richer live server snapshots through the gokz-top-servers SourceMod plugin, which reuses the existing cfg/sourcemod/gokz-top/gokz-top-core.cfg server-group key and caches the server's resolved public IPv4 locally before pushing /v1/servers/status.