Game Show Overlay

A browser-based game show overlay system for managing contestants, scores, and buzzer functionality in a game show setting.

Features

• Real-time scoreboard updates
• Contestant buzzer system
• Admin panel for managing contestants and scores
• Responsive design for both admin and contestant views

Prerequisites

• Node.js (v14 or higher)

Setup

1. Clone the repository:

git clone <repository-url>
cd obs-gameshow-overlay

2. Install backend dependencies:

npm install

3. Install frontend dependencies:

cd client-new
npm install

4. Create a .env file in the root directory:

PORT=3001

Running the Application

1. Start the backend server:

npm run dev

2. In a new terminal, start the frontend:

cd client-new
npm start

3. Access the application:
   • Admin panel: http://localhost:3000/admin
   • Contestant view: http://localhost:3000/contestant/{contestantId}

Usage

Admin Panel

• Add contestants using the "Add Contestant" form
• Toggle game state using the "Game Active" switch
• Update scores for each contestant
• Reset buzzers when needed

Contestant View

• View current score
• Use the buzzer button to buzz in
• See game state and buzzer status

Development

• Backend code is in the src directory
• Frontend code is in the client-new/src directory
• The application uses TypeScript for type safety
• Material-UI is used for the user interface
• Socket.IO handles real-time communication

For deployment instructions, see DEPLOYMENT.md. For event logging and DaVinci Resolve integration, see LOGGING_GUIDE.md.

License

MIT