Skip to content

danieldcastro/secret_hitler_companion

Repository files navigation

Secret Hitler Companion 🥸

🇧🇷 Read this in Português

Flutter Dart MIT License Status Shorebird Crowdin

A companion app for the board game Secret Hitler, designed to make the game sessions more immersive and organized.

⚠️ Important: This app does not replace the board game.
You need the official Secret Hitler physical board game to use the app.

📌 Project status: In progress (MVP).
Features may change rapidly until the stable version.

✨ Features

  • 🎭 Role distribution: automatic and secret assignment of each player's role.
  • 🎙️ Automated narration: guides each phase of the game (Night, Election, Voting, Presidential Powers, etc.).
  • 📖 Integrated rules: quick reference to the official rules.
  • 🎵 Background music and sound effects: music and sounds triggered at specific moments.
  • 🧑‍🤝‍🧑 Player management: register player names to streamline the game flow.
  • 👅 Multi-language translation: collaborative translation system via Crowdin.

🛠️ Technologies

🚀 How to run the project

Prerequisites

  • Flutter installed on your machine
  • Dart SDK included

Steps

# Clone the repository
git clone https://github.com/danieldcastro/secret-hitler-companion.git

# Go to the project folder
cd secret-hitler-companion

# Install dependencies
flutter pub get

# Run the app
flutter run

📌 Roadmap

  • Home screen with navigation menu
  • Player registration flow
  • Role distribution system
  • Guided first rounds narration
  • Themed sounds and music
  • Multi-language translation via Crowdin
  • OTA updates and CI deployment via Shorebird

🤝 Contributions

Contributions are welcome! Open an issue for suggestions or bug reports, or send a pull request with improvements.

If you want to help with app translation, participate via Crowdin.

⚖️ License

This project is only an unofficial companion for the game Secret Hitler. Secret Hitler was created by Max Temkin, Mike Boxleiter, and Tommy Maranges.

This app is a non-commercial, open source project, with no official affiliation with the game's creators.

Licensed under the MIT License.

🎲 Enjoy playing Secret Hitler with a more immersive digital experience!

👉 Learn more about Secret Hitler

About

A companion app for the board game Secret Hitler, designed to make sessions more immersive and organized.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors