Documentation

From an idea to a verified screen

Set up your agent, install the Player, and publish your first content. Then use the references to build, update, and inspect it.

Your first screen

  1. 01 / Quickstart

    Install the official plugin in your agent.

  2. 02 / Players

    Set up the Player on the screen device.

  3. 03 / Agents

    Ask your agent to publish and verify a menu, video, dashboard, or application.

Agent-specific setup guides sit under Quickstart: Meta Muse, Grok Bot, ChatGPT dots, Claude Code, Hermes, ChatGPT Codex, and Gemini Spark, which runs the official plugin inside a Spark task rather than a terminal.

To show the tab you are looking at on a screen, use the browser extension.

To read a scanner, a button or a sensor, or drive a relay or a printer, from an application on a screen, see hardware an application can use and buttons and relays on GPIO.

Signage and kiosk infrastructure for AI agents. The official plugin at github.com/screenrig/plugin bundles the skill and CLI. Players: the Player web app (PWA), Android on Google Play, Amazon Signage Stick, Apple TV, macOS, iPhone and iPad, Windows, Linux and Raspberry Pi packages, LG webOS Signage, BrightSign, and Samsung Smart Signage (Tizen).

Every plan has unlimited screens, and downloads are free.

Documentation sections

Run it from the dashboard

Pair screens, build playlists in the page editor, schedule what plays, approve an agent's changes, watch alerts and logs, and manage people, organizations and ads. Dashboard is the guide to each page and where it is.

Live cards and synced folders

Add clocks, weather, menus, queues and gauges to a playlist. Browse the card gallery or read the card reference for layouts, themes, properties and live data. A data source keeps a card current from a calendar or other outside address, and a connection saves one sign-in to Microsoft or Google for room sources, Power BI dashboards and media sync. A media sync keeps a media folder in step with a SharePoint, OneDrive, Dropbox or Google Drive folder, or a Canva design, and a BI view puts a live Grafana, Power BI, Tableau or web-page dashboard on a screen.

Schedules from a spreadsheet

Import a spreadsheet of screen codes, file names, and start and end times. Schedule import checks every row, names each error by row and column, previews the calendar your screens would follow, and applies all of it or none of it.

Reports and exports

Roll uptime, alerts and publishing up by screen folder or tag, download any report as CSV, XLSX or PDF, hand a sponsor a proof of play, email a report on a schedule and export a whole project. Reports and exports lists the reports, the schedules and the export format.

Audit log

See who changed what, when and through which surface, with each changed field before and after. Audit log lists what is recorded, the filters, how to verify the chain and how to export it.

Player status codes

Look up the chip a screen shows or a code screen show reports. Player status codes explains each status chip, page failure, update, storage and card code, its usual cause and the command that fixes it.

Organization sign-in

Organization admins connect single sign-on with Microsoft Entra ID, Okta, Google Workspace or any OpenID Connect or SAML 2.0 provider, and provision people and project access over SCIM.

Permissions by screen folder

Limit a member or an agent to the screen folders and screens they work on, protect the folders whose screens need a second approver, and reserve campaigns for approvers. Permissions covers the scope, the review rule, who is a member or a guest of an organization, what its admins do, the organization's shared Library and the fix for each refusal.

Buying or selling ads?

The same account, plugin and dashboard run invitation-only advertising. Sellers opt screens in and invite buyers; buyers need no screen, and a seller can also run direct campaigns for its own advertisers. Buying and selling setup · Advertising commands · Rates and fees

Reading this as an agent?

Use the reference context for public documentation and pricing; it follows the pages listed above.

The installed plugin's skill is the operating guide. Read the relevant reference for exact parameters, then verify the published result with Player evidence.

Need transport details?

The generated API reference describes the pinned transport contract and schemas. MCP clients such as Claude, ChatGPT and Grok connect to the remote MCP server with OAuth; it runs the same project tools. Authentication covers how agents sign in, Read only, Propose and Manage, review for agent changes, and revoking access; service clients give servers and CI jobs their own key or secret. The origin map explains which service owns each surface. Use the bundled CLI for the customer workflow.