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.
Akshin Vemana 8c4158d99a
fix: permission outputting Object instead of permission title
3 days ago
.github chore(github): update funding to add github sponsors (#114) 4 days ago
i18n chore: remove music localizations 4 days ago
scripts fix: shard count using incorrect number 1 week ago
src fix: permission outputting Object instead of permission title 3 days ago
.editorconfig Add .editorconfig 6 months ago
.gitattributes Update gitattributes to ensure LF line endings 5 months ago
.gitignore ci: unignore package-lock.json 5 days ago
.prettierrc feat: rewrite to typescript 3 months ago
CHANGELOG.md chore: 3.0.1 release 5 days ago
LICENSE Remove license file extension 6 months ago
README.md fix: permission outputting Object instead of permission title 3 days ago
config.example.json feat: remove music functionality 4 days ago
index.ts fix: switch to managers instead of datastores 1 week ago
package-lock.json feat: remove music functionality 4 days ago
package.json feat: remove music functionality 4 days ago
tsconfig.json feat: remove lerna; add fr-fr localization 1 month ago

README.md

TypicalBot

A stable, lightning fast, easy to use, Discord bot built using Discord.js and Node.js.
Try out TypicalBot using our hosted version at typicalbot.com/invite.

Discord

TypicalBot is an ironically named multipurpose Discord bot that is far from typical, developed in discord.js.

Introduction

TypicalBot is an ironically named multipurpose Discord bot that is far from typical, developed in discord.js.

Table of Contents

Ecosystem

Project Description
typicalbot-cluster-manager Inter-process communication manager
typicalbot-api Internal API

Getting Started

This section provides a quick-start guide.

Prerequisites

  • Node.js: Node.js 10.0.0 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.
  • OpenSSL: OpenSSL is required for bignum, use version 1.0.X (Do not use version 1.1.X or the Light version).
  • 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. Start RethinkDB database rethinkdb
  4. Install all necessary packages to setup the environment: npm run setup
  5. While the above is running create your config.json file using the example file provided in the repo.
  6. Run npm run start
  7. Profit!

Team

Name Role
Bryan Pikaard Maintainer, Core Contributor
Nicholas Sylke Maintainer, Core Contributor
Braxton Mahr Core Contributor
Tyler Richards Core Contributor
Tobias Feld Web Contributor
Akshin Vemana Docs Contributor

Show Your Support

If you like what we do, consider supporting us on Patreon or donate to us via PayPal.

License

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