Project Genesis

A Discord.js bot for tracking Warframe alerts, invasions and more.

Contribute

Live Public Bot info

JetBrains

Thank you to JetBrains for providing us with free licenses to their great tools.

• WebStorm

Feel free to submit a pull request. We are working on build checks and tests, and we use aribnb's codestyle and eslint configuration. Plugins for auto-linting on save are available for many popular editors.

Thanks, Discord... Legalese things

Due to the New Discord T.O.S , if you continue to use, participate, be in, or not leave Cephalon Sanctuary, you agree to allowing me, any person, user, or member, any bot, service, app, and anything to collect, use, transmit, or any data related to your user account, any data made available by Discord in the API or SDK, any metadata from your user account, any messages and or content you send, and anything else you do or give by staying in Cephalon Sanctuary, or by using my bot.

If you do not agree to letting Genesis, Oratoris, or any other bot there do so, please kick Genesis from your servers.

tl;dr Bots need data. While I don't record any of your personal data or save it off for long-term use, I still need to tell you that bots can access your messages and user ID. If you don't want that, get rid of all of them, cause they all need that data.

Installation

1. Clone this repo

   # For SSH
   git clone [email protected]/genesis.git
   
   # For HTTPS
   git clone https://github.com/WFCD/genesis.git
   

2. Install mysql server and configure a database to store settings and data

3. Run npm i

4. Start bot with pm2 using a copy of the provided pm2.json file. The scripts assume it's named genesis.json

5. See below for available config / commands

Configuration

Genesis requires a MySQL server. It uses the MYSQL_* environment variables for determining where to connect to

Base

Stats tracking

Flair configuration

Feature Flags

• CORE does not need to be specified ever, it will always load

Setting up Twitch

In order to setup Twitch you need to specify your Twitch API Client ID. See the following link on how to get one:

• Twitch API Client ID: https://dev.twitch.tv/docs/v5/ (See Getting a client ID)

Other Features

Commands

Honestly too many to put here

License

Private Docker Build!

Want to build your own image? All you (should) need to do is:

• clone this repo
• install docker
• install nodejs (and npm)
• run npm run build (builds the docker image and punishes locally)
• Copy docker-compose.example.yaml and update the environment variables to your needing
• Run docker-compose up -d
• If you'd like to check logs, use docker logs genesis --follow