Ecosystem · players & viewers
Where to open a roadbook
A .roadbook.json file is meant to be played: tickets rendered as scannable codes, one view per traveler, offline on the road. These applications read the format. Roadbook is an open specification: any application may implement it — no registration, API key or permission is required — and may advertise itself as "Roadbook ≤ 1.2 compatible" once it meets the compatibility requirements. The official player below is one implementation, not a requirement.
Official player#
roadbook.plus — reference player & builder
The reference implementation the specification is validated against. Installable offline-first PWA: today / trip / tickets / info tabs, per-traveler links with roles (owner, editor, viewer), scannable QR / Code 128 tickets and vouchers, surprise mode for kids, "what to wear today", plan B and on-site options, sync between phones, in-app editing, import / export of .roadbook.json, and an AI assistant that edits the trip from a conversation.
spec ≤ 1.2platform web · PWAoffline yesimport .roadbook.jsonurl roadbook.plusstatus live
roadbook.plus is the official player: paste or drop any .roadbook.json and it opens locally, without an account; an account adds sync between devices, sharing links per traveler and several trips. Hosted trips, the conversational builder and the planned MCP server live on the player side, not on this specification site. It is one implementation of the open format — not a requirement to use it.
Minimal preview#
This site ships a deliberately plain, read-only renderer (roadbook-view.mjs, MIT) used by the validator's Preview trip button — enough to eyeball a file, not to travel with it. Try it: open the demo in the validator with preview.
Compatible viewers#
| Name | Platform | Spec | Notes |
|---|---|---|---|
| — none listed yet — | Be the first: submit yours below. |
Submit a compatible viewer#
Built a player, a viewer, an importer or a generator that reads or writes this format? We list tools that load the demo file without error and follow the player obligations.
Building your own?#
- Test against the nine examples (manifest) — every one must open; the demo exercises nearly every field.
- Claiming compatibility: the reader / writer requirements are on the versioning page.
- Start from the spec and the JSON Schema; run the validator on every file you write.
- Follow the three player obligations: ignore and preserve unknown fields, advertise the highest version you fully implement, write the version you actually emit.
- Tickets: render
payloadwith the declaredformat(qr, code128, pdf417, aztec, ean13, datamatrix) — the code must scan. - Media are URLs: fetch and cache them for offline use; never expect inline files.
- Reuse
roadbook-view.mjsas a starting point for a read-only rendering — MIT, no dependencies.