There's several prerequisites to this application that are documented below
This application interacts with the CFTools Data API (opens in a new tab) and therefor requires you to create a Developer Application. If you already have a CFTools Developer Application, feel free to re-use your credentials and skip to the next part of this guide.
Next up is the Discord bot user/account. This will be used to log our bot in to Discord, allowing you to communicate with it through commands & other components. If you already have a Discord Developer Application, feel free to re-use your credentials and skip to the next part of this guide.
The easiest method to install and use this application is by running it in a Docker container. We personally recommend Docker Desktop (opens in a new tab) for Windows users, and
docker-compose (opens in a new tab) for other operating systems. A simple
docker run command will work fine as well.
docker-compose file is provided in the source directory of this application, along with raw docker command examples to get you started using Docker in the
/package.json > scripts
# Build using the default Dockerfile
# Always restart, recovers the process from errors
# Bind mount, read-only app
# Anonymous volume
# Include our environmental config file
Head on over to the download page (opens in a new tab)
Download the latest LTS build available for your OS
Be sure to check the box that says "Automatically install the necessary tools" when you're running the installation wizard
/statistics hit-zone heat-maps - can be ommitted through the configuration file
- Comes with most Windows installations, if not - download (opens in a new tab) the application
sudo apt-get install chromium-browserfor most Linux distributions, or use your distro's apt-alternative (package manager) - if this doesn't work you might have to point
puppeteerto your browser executable.
brew install chromium && which chromiumon Mac OS