Skip to content

dzoidbrg/openbingo

Repository files navigation

OpenBingo 🎯

A modern, real-time multiplayer bingo game platform built with Next.js and Appwrite. Create custom bingo games, share them with friends, and enjoy interactive gameplay with a built-in voting system.

✨ Features

  • Real-time Multiplayer: Play bingo games with friends in real-time
  • Custom Game Creation: Create personalized bingo boards with your own events
  • Flexible Board Sizes: Choose between 3x3, 4x4, or 5x5 board layouts
  • Voting System: Democratic event verification through player voting
  • Modern UI: Clean, responsive design with dark mode support
  • Easy Sharing: Share games instantly with a simple game code
  • Interactive 3D Background: Engaging visual experience with Three.js

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn
  • Appwrite instance (self-hosted or cloud)

Installation

  1. Clone the repository:
git clone https://github.com/dzoidberg/openbingo.git
cd openbingo
  1. Install dependencies:
npm install
# or
yarn install
  1. Start the development server:
npm run dev
# or
yarn dev

🎮 How to Play

  1. Create a Game

    • Choose your board size (3x3, 4x4, or 5x5)
    • Set a voting threshold
    • Add your bingo events
    • Share the game code with friends
  2. Join a Game

    • Enter the game code
    • Choose your username
    • Wait for the host to start
  3. During the Game

    • Vote on events as they occur
    • Events are marked when they reach the voting threshold
    • First player to complete a line wins!

🛠️ Built With

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the Unlicense License - see the LICENSE file for details.

🙏 Acknowledgments

  • Thanks to all contributors who have helped shape OpenBingo
  • Inspired by the need for modern, interactive bingo experiences