LEAGUE OSDOCUMENTATION

README.md

/doc

PUBLIC DOCUMENTATION

League OS Documentation

League OS is a League of Legends statistics experience presented as a virtual operating system. This guide covers the public product flow and the architecture behind it.

What is League OS?

League OS turns profiles, matches, leaderboards, and live data into a focused desktop experience. The terminal is the primary navigation surface, while each virtual page or application owns its own presentation.

Quick start

Open a terminal and use familiar shell commands to move through the virtual filesystem. Profile and match routes remain inside the current terminal session.

ls\ncd /profile\nsummoner GameName#TAG\nmatch EUW1_1234567890\nhelp\nman summoner
  • Use cd and pwd to inspect the current virtual location.
  • Use summoner to search for a Riot ID in the active shard.
  • Use open to render a mapped virtual page or the current profile.
  • Use Ctrl+C to close an active terminal application and return to the shell.

The virtual filesystem

Virtual paths are product routes, not repository paths. Directories can be traversed, pages open a mapped window, data nodes can be read, and actions represent executable behavior.

  • Profiles use a dynamic path and are resolved from the canonical identity.
  • Leaderboards use region, rank, queue, and page state owned by the leaderboard flow.
  • Public pages such as /doc use direct browser routes and remain separate from the desktop shell.
  • Unknown paths fail through the shared resolver instead of fabricating content.

Profiles and identity

A selected profile is identified by its stable PUUID and shard after resolution. The visible Riot ID is used for discovery, while the resolved identity drives profile data and cross-view navigation.

Architecture at a glance

user intent\n  -> command or public route\n  -> virtual filesystem / application owner\n  -> typed query or state transition\n  -> rendered window
  • Domain types own parsing, normalization, lookup, and relationships.
  • The API layer owns endpoint construction, transport, mapping, errors, and cache policy.
  • The OS store owns windows and terminal sessions, not server payloads.
  • Renderers coordinate interaction and present data from their canonical owner.

Themes and access

Themes change the visual language of the desktop without changing the meaning of semantic states. The documentation and legal pages remain readable across viewport sizes and preserve normal browser navigation.

  • Use the command palette to discover available themes and shortcuts.
  • Use direct public URLs when sharing a profile, match, documentation, or legal page.
  • Read the Terms of Service and Privacy Policy before publishing or integrating the service.