Docs

Documentation

Everything about PEK TV, from using it to building it. These pages are generated from the project's own docs, so they match the code in the repository.

PEK TV is in beta. It works and is used every day, but expect rough edges, missing polish and the occasional bug. Feedback and bug reports are very welcome on GitHub.

Start here

Overview

What PEK TV is, what it does and how the repository is laid out.

Building PEK TV

Build the C++ backend and the Android app, environment variables, signing and CI.

Source & modules

How the source is organised: every Flutter module and backend file, and how the parts fit.

In-app updates

How PEK TV finds and installs a new release, and how to publish one.

Using PEK TV

Local metadata (NFO)

NFO files and artwork names PEK TV reads from your own folders.

Music

How the Music tab finds, tags, plays and decorates your songs.

Automatic subtitles

How subtitles are found and switched on for you.

Plugins & skins

Writing plugins

plugin.json, permissions, the backend guard, installing and publishing.

Plugin screens & hooks

The Python screen API, effects, limits, hooks, the store and installs.

Skins

The skin format, installing, removing and making skins from code.

Trakt plugin

Scrobbling, history, ratings and favorites, one account per profile.

TMDb Discover plugin

Browse, filter, trailers and where to watch.

Skin Maker plugin

The official plugin for making skins in the app.

Internals

The Flutter UI

Everything the Flutter app does, module by module, with the design decisions behind it.

Self-hosting the cloud

PEK Cloud

Accounts, sync and subtitles on Cloudflare Workers.

PEK Store

The plugin store worker and its database.

Examples

Code snippets

Repository layout, architecture diagram, release flow.

Plugin showcase

The plugins from PEK with icons, permissions and starter code.