You'll need at least 2 players (4+ is best) to start a game. Each round brings different question types to keep things interesting:

• Regular Questions - Hit the buzzer first to answer. Right answer? Earn the points. Wrong? Lose them.
• Stake Questions - Bet your own points before you see the question. Go safe or risk it all.
• Secret Questions - These can be passed to any player you choose. Use it wisely.
• No Risk Questions - No penalties here. Great for trying your best without the pressure.

• Regular Rounds - Players take turns picking themes and questions from the board. Quick reflexes and smart strategy win points.
• Final Round - The climax. First eliminate themes you don't want, then bid on how confident you are, and finally submit your answer against the clock.

Join games in the role that suits you best:

• Showman (Host) - Control the game's pace, validate player answers, award or deduct points, and ensure fair play
• Player - Buzz in to answer, manage your points, make strategic bids, and compete for the top score
• Spectator - Enjoy the action and test your knowledge without affecting the game outcome

• Package System - Play community-created question packages on any topic
• SIGame Compatibility - Import .siq packages from SIGame (Work in Progress)
• Create Your Own - Build and share custom packages with the community

• Responsive UI - Beautiful, intuitive interface built with Flutter
• Real-time Sync - Low-latency gameplay with Socket.IO
• Media Support - Rich content with images, audio, and video
• Dark/Light Themes - Customizable appearance
• Multilingual - Support for multiple languages

Note: Screenshots will be added here soon!

Download the latest version for your platform from the Releases Page.

• Web: Browser version
• Windows: .exe installer
• Linux: .AppImage, .flatpak, or .tar.gz
• macOS: macOS support (Work in Progress)
• Android: .apk or Google Play Store (Coming Soon)
• iOS: iOS support (Coming Soon)

1. Download the .exe installer from the Releases Page
2. Double-click the installer and follow the installation wizard
3. Launch OpenQuester from the Start Menu or Desktop shortcut
4. (Optional) For package encoding features, install FFmpeg and add it to your system PATH

Option 1: AppImage (Recommended)

# Download the AppImage
wget https://github.com/OpenQuester/OpenQuester/releases/latest/download/OpenQuester-x86_64.AppImage

# Make it executable
chmod +x OpenQuester-x86_64.AppImage

# Run the application
./OpenQuester-x86_64.AppImage

# (Optional) Install FFmpeg for package encoding
sudo apt install ffmpeg  # Debian/Ubuntu
sudo dnf install ffmpeg  # Fedora
sudo pacman -S ffmpeg    # Arch Linux

Option 2: Flatpak

# Install from local flatpak bundle
flatpak install openquester.flatpak

# Run the application
flatpak run com.asion.openquester

# Note: FFmpeg is included in the Flatpak bundle

Option 3: Extract tar.gz

# Download and extract
wget https://github.com/OpenQuester/OpenQuester/releases/latest/download/openquester-linux-x64.tar.gz
tar -xzf openquester-linux-x64.tar.gz

# Run the application
cd bundle
./openquester

# (Optional) Install FFmpeg for package encoding
sudo apt install ffmpeg  # Debian/Ubuntu
sudo dnf install ffmpeg  # Fedora
sudo pacman -S ffmpeg    # Arch Linux

For the latest features and updates, check our GitHub Actions for development builds.

• Flutter - Cross-platform UI framework
• Dart - Programming language optimized for UI
• Auto Route - Navigation and routing
• GetIt - Dependency injection

• TypeScript - Type-safe JavaScript
• Node.js - JavaScript runtime
• Express - Web application framework
• Socket.IO - Real-time bidirectional communication
• TypeORM - Object-relational mapping
• PostgreSQL - Relational database
• Redis - In-memory data structure store
• MinIO - S3-compatible object storage

• Docker - Containerization
• GitHub Actions - CI/CD pipelines
• MinIO - Object storage (S3)
• Jest - Backend testing framework
• ESLint - Code linting

See the Installation Instructions above for detailed steps on how to download, install, and run OpenQuester on your platform.

Quick steps:

1. Download the application from the Releases Page
2. Install following the platform-specific instructions
3. Launch OpenQuester
4. Join or Create a game room
5. Play and enjoy!

• Node.js 18+ and npm/yarn
• Flutter 3.24+
• Docker and Docker Compose (for backend development)
• PostgreSQL 14+ (or use Docker)
• Redis 7+ (or use Docker)
• FFmpeg (for package encoding support)
  • Windows:
    • winget install Gyan.FFmpeg (Windows Package Manager)
    • choco install ffmpeg (Chocolatey)
    • Or download from ffmpeg.org and add to PATH
  • Linux: sudo apt install ffmpeg (Debian/Ubuntu), sudo dnf install ffmpeg (Fedora)
  • macOS: brew install ffmpeg

# Clone the repository
git clone https://github.com/OpenQuester/OpenQuester.git
cd OpenQuester

# Backend setup
cd server
npm install
cp docs/env_examples/.env.example .env
# Edit .env with your configuration
docker compose up -d  # Start PostgreSQL, Redis, MinIO
npm run dev

# Frontend setup (in a new terminal)
cd client
flutter pub get
flutter run

For detailed setup instructions, see:

• Frontend Setup Guide

• Online Documentation - Complete documentation site
• API Documentation - Backend API reference
• Game Flow - Understanding the game mechanics
• Final Round - Final round implementation details
• Media Sync - Media synchronization system
• Package Format - Creating custom packages (Coming Soon)

We welcome contributions from developers, designers, translators, and quiz enthusiasts!

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

• Follow the existing code style and conventions
• Write meaningful commit messages (use Conventional Commits)
• Add tests for new backend features
• Update documentation as needed
• Ensure all tests pass before submitting PR

• 🐛 Bug fixes and testing
• ✨ New features and enhancements
• 🎨 UI/UX improvements
• 🌍 Translations and localization
• 📝 Documentation improvements
• 📦 Question package creation
• 🎮 Game balance and mechanics

• GitHub Discussions - Ask questions, share ideas
• GitHub Issues - Report bugs, request features
• Discord DM - sukui_ or asion.desu
• Discord Server - Chat with the community and developers (Coming Soon)

We take your privacy seriously. OpenQuester collects minimal data necessary for gameplay.

• Privacy Policy - Full privacy policy
• Security Policy - Report security vulnerabilities (Coming Soon)

Status: 🚧 Active Development (Beta)

OpenQuester is open-source software licensed under the MIT License.

This means you can freely use, modify, and distribute this software, even for commercial purposes, as long as you include the original copyright and license notice.

• SIGame - Inspiration for gameplay mechanics
• Flutter Team - Amazing cross-platform framework
• Open Source Community - For all the incredible tools and libraries
• Contributors - Everyone who has helped build OpenQuester