Skip to content
This repository has been archived by the owner on Aug 23, 2022. It is now read-only.
/ typicalbot Public archive
forked from typicalbot/typicalbot

TypicalBot is open-source Discord bot written in TypeScript, using the Discord.js library.

License

Notifications You must be signed in to change notification settings

dligence/typicalbot

 
 

TypicalBot

Discord Crowdin StackShare

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.

About

TypicalBot is open-source Discord bot written in TypeScript, using the Discord.js library.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.3%
  • Other 0.7%