Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 4.43 KB

README.md

File metadata and controls

78 lines (52 loc) · 4.43 KB

The Investigator's Clues

The Investigator's Clues is an unofficial application to help Blood on the Clocktower's players to track the game status and register the clues they collected, and to help the storyteller to setup the game and track its status. This is a free and open source multi-platform project developed with Flutter, which supports Android, Web and iOS.
This application is not affiliated with The Pandemonium Institute.
All roles and characters are the property of Steven Medway and The Pandemonium Institute.

Main features

  • Monitoring game status as storyteller or player:
    • Add game setup, by registering the script, number of players and their names (optional);
    • Manually ou randomly select script roles according to the players number (Storyteller mode only);
    • Manually ou randomly select bluff for Demon and Lunatic, if in play (Storyteller mode only);
    • Allow player to draw their character (Storyteller mode only);
    • Register information about each player (e.g. name, specific notes, are they dead?, do they have ghost vote, character, did they vote/nominate?);
    • Add/delete players, travellers and fabled;
    • Track the global number of alive players, ghost votes, number of votes required to successfully execute and number of players per team;
    • Save general notes about the game and write/show some token to the other players or Storyteller;
    • Track current game phase;
    • Add reminders to each player (Storyteller mode only);
    • Check first and other nights order tips and jinxes (Storyteller mode only);
  • List of the official and custom scripts available in BotC Scripts database, with script's characters, night order and jinxes;
  • List of all the official characters (townsfolk, outsiders, minions, demo, travellers and fabled), including the experimental ones, with summary and the detailed information about each of them as per Blood on the Clocktower Wiki.

Acknowledgments and Copyrights

How to Update

Add new released character

  • Get new token image and save it in the lib/assets/images/character_tokens folder;
  • Add character info in lib/assets/data/characters.json, according to the existing json schema;
  • Update jinks in lib/assets/data/jinx.json and night order in lib/assets/data/night_order.json files;

Update an ability

  • Find the character info in lib/assets/data/characters.json and update the info.

Add new script

Run the App locally

For web

run flutter build web

For android

run flutter build apk

For iOS

run flutter build ipa

Build App

For web

run flutter run -d chrome --release

For android

In VSCode, click Run -> Run Without Debugging, after starting the Android emulator you plan to use.

For iOS

In VSCode, click Run -> Run Without Debugging, after starting the iOS emulator you plan to use.