Werewolves Bot

A Discord bot designed to automate the heavy-lifting of game server Werewolves

Getting Started

Run the main file with node index.js or opening run.bat (windows only). Note that you should first edit config.json and token.json with the correct settings. See Configuration for options.

Installing

Download the project to your local machine using git (or by downloading the zip).

git clone https://github.com/McTrees/werewolves.git

Install dependencies

npm install

Edit config.json and token.json with required settings. See Configuration for options.

Run with node index.js or by opening run.bat (windows only)

Configuration

This project offers several configuration options via both config.json and token.json:

• config.json
  • bot_prefix: the prefix the bot should respond to (defaults to !). THIS MUST BE A SINGLE CHARACTER!
  • season: likely to be removed soon in favour of game_state managing seasons.
  • messageTimeout: how long the bot should wait before deleting some of it's own error messages.
  • messages: categorised messages which the bot sends upon several actions being completed. Will soon be moved to a new file.
  • channel_ids: IDs of channels the bot should send several types of message in. Might soon be moved to a new file.
  • role_ids: IDs of roles which the bot should use to establish permissions, etc.
  • developerOptions: Whether or not the bot should do things like show messages to users or create logs.
    • saveLogFiles: Whether the bot should create files and save to ./logs, this shouldn't be neccessary if remoteErrorReporting is on.
    • remoteErrorReporting: Whether to send errors to the devs so we can fix them.
• token.json
  • token: The token of the account which the bot should run under. Will throw an error if set to default value.

For more info see the docs

Attribution

This code has been developed by Ben Griffiths, Calvin Edwards, Robbie Bradshaw, Oliver Hynds and Lord of Galaxy. It is licensed under the MIT license, a copy of which can be found in this repository, in the LICENSE file.