Developers

Tilecast is an AGPL-3.0-only project in the gbyo/tilecast repository. The repository contains the server, Studio, the Android, Linux, and Windows Players, shared packages, deployment files, and this documentation site.

Choose a path

Development setupRun Tilecast Server and Studio from source, check your changes, and work on these docs.

ArchitectureSee the repository layout and find the engineering contract for each area.

Testing and CIRun application tests, review visual differences, and see which CI checks a change selects.

Player developmentDecide where Player code belongs, then build the Android Player and Tilecast Edge.

Plugin developmentAdd a bundled plugin without adding plugin-specific wiring to the rest of Tilecast.

iOS developmentBuild and test the iOS and iPadOS app, and decide whether a feature belongs in Studio or in the app.

Releasing TilecastCut a Stable or Beta release, resume one that stopped, and see what the workflow checks before it publishes.

To explore Studio with sample data instead of an empty database, run a demo installation. Security reports follow the private process in the repository’s Security Policy.

Read the contribution guide

Technical references

• HTTP API overview explains the shared API contract and links to the OpenAPI description.
• Command-line interface and MCP cover the remote tilecast CLI, including how to build it from apps/cli.
• Build a first-party plugin covers the bundled Plugin API workflow, including CLI and MCP automation.
• Call Tilecast services from an external package covers versioned service grants and Player Capability operations for third-party packages.
• Architecture lists the engineering contracts that live with the code.