Docs: Marathons

Marathons

A marathon is one event: its dates, its layout, its signups, schedule, outputs and donations. Create one from the organization page with a name and, optionally, a layout. It starts as a draft with one output called "Main".

Marathon pages

Each marathon has a few addresses under /<organization>/m/<marathon>:

PageWho sees itWhat it is
/everyone, once publishedthe public page: what's on now, what's next, totals, signup windows, open incentives, latest donations
/dashboardorganization membersthe tools your role can reach, with pending counts
/settingsadminssettings, dates, signup questions, outputs
/submitanyone signed inrun and volunteer signup
/scheduleeveryone, once publishedthe public schedule
/participantseveryone, once publishedrunners, hosts, commentators and staff with their roles
/donate, /trackereveryone, once publisheddonation page and donation tracker
/liveoperators and crewthe live dashboard

The dashboard

The marathon dashboard opens to every member and shows only what your role reaches: live, signup review, schedule builder, staffing, team, donations. Admins also get a setup checklist (dates, signup window, layout, an output, the schedule, publishing), and each item leads to the place that completes it.

Settings

The Settings tab holds the name, address, logo, description and the channels the marathon streams on. Two settings affect the overlays directly:

  • Overlay language: the language of labels in the overlay, such as "Estimate" or "Up next".
  • Time zone and currency: how times and donation amounts are formatted.

The layout is picked here too. Overlays show the layout's latest saved version: autosaved edits stay in the editor until someone presses Save version, see Saving and history.

Dates and signups

Dates and submissions sets the marathon's start and end, the run signup window and, optionally, a separate volunteer window (it defaults to the run window). You can also cap the number of games per runner and the longest estimate allowed.

Dates are typed on the marathon's clock. Signups stay closed until the start, the end and the window are all set.

Signup questions

Add your own questions to the signup form: short text, long text, a choice from a list, or yes/no. Each one applies to runs, volunteers or both, and can be required. Answers show on the review page.

Outputs

An output is one browser source in OBS. Each has its own URL with a secret key.

  • Follow outputs show the scene picked on the live dashboard. Most marathons need one.
  • Fixed outputs always show the same scene, for a separate source such as an omnibar you layer on its own.

Copy the URL and add it to OBS as a browser source, see OBS. Rotate key gives the output a new URL and disconnects every overlay using the old one; do it if the URL leaked.

OBS control (obs-websocket URL and password) lets the dashboard drive OBS through that overlay. Turn it on for one output only, usually the main follow output. Details in OBS control.

Publishing

A draft is visible only to the organization's members, as a preview. Publish opens the public page, schedule, participants, donation page and tracker to everyone. You can unpublish later.

Team

Team lists everyone working on the marathon with the roles they have on it: runner, commentator, host, operator, moderator. These roles come from accepted signups, so nothing needs to be assigned by hand. They are separate from organization roles; joining the organization happens when a volunteer role is accepted, see Review.