Documentation — Trivia Broadcast Engine

Quick Start

1

Clone the Repository

Clone the Trivia Board project from GitHub to your local machine.

git clone https://github.com/L-Logix/Trivia-Board.git

2

Install Dependencies

Navigate into the project directory and install all required packages.

cd Trivia-Board && npm install

3

Run Setup Wizard

Configure your game — board size, categories, players, and media. You can also import clues from a CSV file.

npm run setup

4

Start the Server

Launch the broadcast engine. The server starts on port 3333 by default.

npm start

Setup Options

Interactive Wizard

Step-by-step prompts guide you through board size, category names, player names, values, and media settings. Perfect for first-time users.

npm run setup

CSV Import

Bulk import your clue data from a CSV file. Supports both simple (category, value, clue, answer) and grid (categories as columns, values as rows) formats.

npm run setup -- --csv path/to/clues.csv

Google Sheets

Import directly from a published Google Sheet. Paste the published URL and the system fetches and parses your clue data automatically.

npm run setup -- --sheet PUBLISHED_URL

Quick Mode

Skip all interactive prompts and use sensible defaults. Ideal for testing or when you already have a configuration file in place.

npm run setup -- --quick

URL Reference

Route	Purpose
/broadcast	Full-screen audience view — the game board, clues, answers, scores, and timer for your TV or projector
/dashboard	Host control panel — select clues, manage scoring, control the timer, and orchestrate the game
/helper-scoring	Simplified scoring view — quick access to judge answers and adjust scores without the full dashboard
/helper-board	Simplified board view — read-only clue board for an assistant to follow along
/practice	Practice / clue review mode — browse all clues with back/next navigation and answer toggle
/editor	Game data editor — modify categories, clues, values, and players after initial setup
/stats	Post-game analytics — per-player stats, category breakdowns, score distribution, and printable reports

Media Setup

To add custom media assets, place your files in the correct directories, then run the setup wizard and enable them.

Intro Video

Place your intro video file (MP4 recommended) in the public/video/ directory. The system will detect it and offer it during setup.

public/video/intro.mp4

Sound Effects

Place audio files (MP3 or WAV) in the public/audio/ directory. The setup wizard lets you map them to specific game events.

public/audio/correct.mp3

Background Music

Place background music tracks in the public/audio/ directory. Music automatically ducks during active gameplay.

public/audio/background.mp3

Bonus Images

Place bonus clue images in the public/img/ directory. Refer to them by filename in your clue data for cover-flip reveals.

public/img/bonus-clue.png

Keyboard Shortcuts

Key	Action
B / Space	Buzz in (during clue phase)
U	Unbuzz
1 / 2 / 3	Round selection (practice mode)
← / →	Navigate clues (practice mode)
Space	Toggle answer (practice mode)

Documentation Guide