# Roadbook Format

> Roadbook is an open, versioned, MIT-licensed JSON format describing a complete travel itinerary — day-by-day schedule, bookings, scannable tickets (real barcode payloads), conditional fallbacks, on-site options, people to meet, vehicles, checklists, contacts — in one `.roadbook.json` file. It is transverse (personal, business, agency trips) and designed to be authored by LLMs and consumed by offline-first "player" applications. Current version: 1.2.

Key facts for generating a file: dates are `YYYY-MM-DD`; times are 24-hour `HH:MM` local wall-clock; enum values are English tokens (`"meal"`, `"planned"`, `"confirmed"`, `"to_book"`…); every entity has a unique `id`; unknown fields must be ignored and preserved by players; root `formatVersion` should be `"1.2"`.

## Specification
- [Field-level specification](https://roadbookformat.org/spec.html): every entity and field, integrity rules
- [JSON Schema (draft 2020-12)](https://roadbookformat.org/roadbook.schema.json): machine-readable schema, usable for structured output
- [Versioning policy](https://roadbookformat.org/versioning.html): MAJOR.MINOR rules, player obligations, release history

## Tools
- [Validator (web)](https://roadbookformat.org/validator.html): local, in-browser validation; errors are `path + message` pairs meant to be pasted back to a model
- [Validator (ESM library)](https://roadbookformat.org/roadbook-validate.mjs): zero-dependency `validateRoadbook(trip) → { ok, version, errors, warnings }`
- [Validator (CLI)](https://roadbookformat.org/cli.mjs): `node cli.mjs trip.roadbook.json`
- [Renderer (ESM library)](https://roadbookformat.org/roadbook-view.mjs): minimal read-only HTML rendering `renderTrip(trip) → html`
- [Viewers & players](https://roadbookformat.org/viewers.html): official Roadbook player, compatible viewers, how to submit one
- [AI prompt builder](https://roadbookformat.org/ai.html): generates a ready-to-copy prompt from travelers, ages, destinations, dates and style

## Examples
- [Minimal example](https://roadbookformat.org/examples/minimal.roadbook.json): one day, two items
- [Full-featured example](https://roadbookformat.org/examples/demo.roadbook.json): bookings, tickets, people, vehicles, checklists, 1.2 fields

## Optional
- [Overview](https://roadbookformat.org/): positioning, comparison with iCal/GPX/PDF, FAQ
- [License (MIT)](https://roadbookformat.org/LICENSE)