Using Docker (recommended)#

Docker run#

Prerequisites:#

Docker (install guide)
Redis (Docker Hub)
Discord application with bot (create one here)

docker run -d --name continent-bot \
    -e DISCORD_TOKEN= \
    -e API_KEY= \
    -e LOG_LEVEL=INFO \
    -e REDIS_HOST= \
    -e REDIS_PORT=
    -e REDIS_DB=0
    -e REDIS_PASS=
    ghcr.io/wupasscat/continentbot:latest

Environment Variables:#

DISCORD_TOKEN found in the “Bot” section of your Discord application
API_KEY Daybreak Games Census API service ID

Warning

Do not use s:example! This service ID is heavily rate-limited and will not work. It is recommended that you apply for a service ID here
REDIS_HOST IP or hostname of your Redis instance
REDIS_PORT the port that Redis listens on
REDIS_DB the ID of your redis database
REDIS_PASS the password to your Redis instance

Docker compose#

Prerequisites:#

Docker (install guide)
Docker compose (install guide)
Redis (Docker Hub)
Discord application with bot (create one here)

From docker-compose.yml:

version: '3.4'
services:
    continentbot:
        container_name: continent-bot
        environment:
            - DISCORD_TOKEN=your discord bot token
            - API_KEY=
            - LOG_LEVEL=INFO
            - REDIS_HOST=
            - REDIS_PORT=
            - REDIS_DB=
            - REDIS_PASS=
        image: 'ghcr.io/wupasscat/continentbot:latest'

Environment Variables:#

DISCORD_TOKEN found in the “Bot” section of your Discord application
API_KEY Daybreak Games Census API service ID

Warning

Do not use s:example! This service ID is heavily rate-limited and will not work. It is recommended that you apply for a service ID here
REDIS_HOST IP or hostname of your Redis instance
REDIS_PORT the port that Redis listens on
REDIS_DB the ID of your redis database
REDIS_PASS the password to your Redis instance

Unraid#

Template support thread

Prerequisites:#

Unraid Community Apps (CA) plugin (install guide)
Redis (Docker Hub)

Setup:#

Search for ps2-continent-bot in the “Apps” tab of your Unraid dashboard

Environment Variables:#

DISCORD_TOKEN found in the “Bot” section of your Discord application
API_KEY Daybreak Games Census API service ID

Warning

Do not use s:example! This service ID is heavily rate-limited and will not work. It is recommended that you apply for a service ID here
REDIS_HOST IP or hostname of your Redis instance
REDIS_PORT the port that Redis listens on
REDIS_DB the ID of your redis database
REDIS_PASS the password to your Redis instance

Python script#

Contents
Linux

Linux#

Prerequisites:#

git
python3
python3-pip
Redis
Discord application with bot (create one here)

Setup:#

Clone the repository

git clone https://github.com/wupasscat/continent-bot.git
cd continent-bot

Install dependencies
```
pip install -r requirements.txt
```
Create .env file
```
nano .env
```
Your file should look like this:
```
# .env
DISCORD_TOKEN=your discord bot token
API_KEY=
LOG_LEVEL=INFO
REDIS_HOST=
REDIS_PORT=
REDIS_DB=
REDIS_PASS=
```
- DISCORD_TOKEN found in the “Bot” section of your Discord application
- API_KEY Daybreak Games Census API service ID
  
  Warning
  
  Do not use s:example! This service ID is heavily rate-limited and will not work. It is recommended that you apply for a service ID here
- REDIS_HOST IP or hostname of your Redis instance
- REDIS_PORT the port that Redis listens on
- REDIS_DB the ID of your redis database
- REDIS_PASS the password to your Redis instance
Run script
```
python3 -m bot.py
```