Skip to content

Latest commit

 

History

History
162 lines (114 loc) · 5.97 KB

README.md

File metadata and controls

162 lines (114 loc) · 5.97 KB
Raw

Latest version

Build state Repo size Stars count

What is TSCord

TSCord is a fully-featured discord bot template written in Typescript, intended to provide a framework that's easy to use, extend and modify.

It uses discordx and discord.js v14 under the hood to simplify the development of discord bots.

This template was created to give developers a starting point for new Discord bots, so that much of the initial setup can be avoided and developers can instead focus on meaningful bot features. Developers can simply follow the installation and the configuration instructions, and have a working bot with many boilerplate features already included!

Getting started is as easy as one command

npx tscord init bot my-bot

To know how to use TSCord and all its components, check the documentation here ㅤ

But TSCord is not only a Discord bot template...

Dashboard

A ready-to-use fancy dashboard for your TSCord bot

Website

Customizable static homepage for your TSCord-based bot

tscord-website.preview.mp4

CLI

Really useful CLI meant to initialize a new TSCord project, generate files by type or even manage plugins

tscord-cli.preview.mp4

Plugins

Fully extensible thanks to the plugin eco-system

📜 Features

Talking about features, here are some of the core features of the template:

  • Advanced handlers for:
    • Interactions (slash, context menu, button, modal, select menu, etc)
    • Simple message commands
    • Discord events listeners
  • Guards functions, acting like middlewares on handlers with some built-ins:
    • Rate limiter
    • Maintenance mode
    • Disabling command
    • Guild only command (no DMs)
    • NSFW only command
    • Message's content match using regex
  • Internal API to interact with the bot from external services, with built-in useful endpoints
  • Multiple databases support out-of-the-box using Mikro-ORM
  • Migrations system to keep a safe database
  • Custom events handlers
  • Advanced error handler
  • Fully-typed localization (i18n)
  • Local store to manage global state through the app
  • Advanced logger with log files and discord channels support
  • Scheduler for cron jobs
  • Built-in rich statistics system
  • Automatic static assets upload to imgur

This template is also developer friendly and follow strict design patterns to ease its maintenance:

  • Written in Typescript
  • Built around the Dependency Injection and Singleton patterns
  • HMR on events and commands for a faster development
  • Use of battle-tested libraries under the hood (discordx and discord.js)
  • Linting and formatting thanks to a top-notch ESLint config
  • Typesafe and validated environment variables
  • Built-in debugging setup for VSCode
  • Support for running with the PM2 process manger
  • Support for running with Docker
  • CI/CD integration with Github Actions

and many more!

📚 Documentation

Check the official documentation to get started and understand how to use this template.

You can also find useful documentations at:

📢 Support

If you need support on the template or just want to exchange with us, don't hesitate to join the official Discord support server!

Roadmap

We use Github milestones for

Click here to access the milestone roadmap

📑 License

MIT License

Copyright (c) barthofu