You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Nicholas Sylke a57cb510b3
Revert "refactor: remove console log outputs"
2 months ago
.github chore: update codeowners (#296) 2 months ago
bin refactor: remove donor-related checks/functionality 2 months ago
etc chore: update translations (#299) 2 months ago
src Revert "refactor: remove console log outputs" 2 months ago
.editorconfig chore: change indent size to 2 spaces for yml files 6 months ago
.eslintrc refactor: update to es2020 (#267) 3 months ago
.gitignore refactor: use custom api for canvas instead of bot process (#233) 4 months ago
LICENSE chore: rename Sylke LLC to TypicalBot LLC (#261) 3 months ago
README.md chore: rename Sylke LLC to TypicalBot LLC (#261) 3 months ago
package.json 3.7.5-canary.5 2 months ago
tsconfig.json build: overwrite issues when excluding node_modules 3 months ago
yarn.lock chore(package): update all dependencies (2020-07-20) (#290) 2 months ago

README.md

TypicalBot

Discord Crowdin

About TypicalBot

TypicalBot is far from typical. It's stable, lightning fast, and easy to use— TypicalBot will seamlessly help you moderate your server and provide entertainment for its members, no problem at all!

Table of Contents

Ecosystem

Project Description
typicalbot-cluster-manager Inter-process communication manager

Getting Started

This section provides a quick-start guide.

Prerequisites

  • Node.js: Node.js 12.x or newer is required.
  • RethinkDB: RethinkDB is required.
  • PM2: PM2 is required.

Windows Only

  • Windows Build Tools: Python 2.7 and VisualStudio is required to compile dependencies.
  • GTK+: GTK 2 is required for canvas, use version 2.X.X (Do not use version 3.X.X)

Installation

  1. Make sure all prerequisites above are installed.
  2. Clone the repository, ie. git clone https://github.com/typicalbot/typicalbot.git
  3. Install the dependencies with npm install
  4. Start RethinkDB database with rethinkdb
  5. Run npm run build:database to build the database structure.
  6. While the above is running create your config.json file using the example file provided in the repo.
  7. Run npm run build:instance
  8. Profit!

Show Your Support

If you like what we do, consider supporting us on Patreon.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

TypicalBot is an open source software licensed under the Apache 2.0 license.