tillicev2

This is the Tillice Bot for FlairWars, rewritten from the ground up

Notes for V2.5 (2023)

TODO

• Need to remove hardcoded fw server values to allow testing
• Update packages used (do after testing env has been set up) (when possible)
• fix the reddit stuff

Testing checklist

• it actually still runs (for the most part)
• commands (missing has been fixed already):
  • auth
  • count
  • listtotems (needs totems to be testable probably)
  • redditinfo (something is still broken for some reason?)
  • serverstats (idk what exactly is wrong but it still keeps dying)
  • topic (almost done but crashes when called with trueaskreddit ?????????????????????)
  • whois (redo reddit part after auth is fixed)

Setup

Dependencies

Angular CLI https://angular.io/guide/setup-local

NodeJS/NPM https://nodejs.org/en/download/ - At minimum version 12

Setup

Running npm install in both the root directory and in the /Frontend directory should get you going.

To start the app, run npm start in the root directory

To build the frontend to /public, run ng build in the /Frontend directory. Please note you should have the Angular CLI installed if you are doing this.

Environment Variables

DISCORD_TOKEN

This is the discord bot token, used to log in the bot

REDDIT_OAUTH_CLIENTID

The bot needs to a script app most of the time in order to be able to authenticate using saved credentials. But script apps aren't allowed to use OAuth2, so we also need a webapp ID for the auth command to work

REDDIT_OAUTH_CLIENTSECRET

Same as above, a reddit web app clientsecret

REDDIT_CLIENTID

This is the Client ID for the Reddit App

REDDIT_CLIENTSECRET

This is the Client Secret for the Reddit App

REDDIT_USERNAME

This is the Username for the account holding the Reddit App

REDDIT_PASSWORD

This is the Password for the account holding the Reddit App

FWAPI_URL

The url of the FlairWars API

FWAPI_SECRET

The secret used for making requests to the FlairWars API

HOSTNAME

The host name

Project Structure

/db

This directory contains schema and operational logic for database interactions

/discord

This directory contains the logic for the discord bot

/commands

This is where command files are put.

/Frontend

This folder contains the development-environment Angular files. Using ng build in this directory builds the webpanel to /public automatically.

/src/app/components

This is where all the Angular Components should be placed. Automatically generate them here using the Angular CLI in the /Frontend folder using ng g c components/COMPONENT_NAME

/src/app/services

This is where all the Angular Services should be placed. Automatically generate them here using the Angular CLI in the /Frontend folder using ng g s services/SERVICE_NAME

/public

This directory contains the static files served for the frontend

/reddit

This directory contains the logic for the reddit bot

/routes

This directory contains all Express Routers, which are the endpoints used for internal functionality

/botRoutes

This directory contains express routes that interact with the Discord and Reddit bots