Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tobycm/typescript-discord-bot-template

Template for a typescript discord bot
https://github.com/tobycm/typescript-discord-bot-template

Last synced: 3 months ago
JSON representation

Template for a typescript discord bot

Awesome Lists containing this project

README

        

# A robust and comprehensive TypeScript template for your next Discord Bot.

![Commands demo](https://cloud-2ahhw7s5v-hack-club-bot.vercel.app/0image.png)

## 🎉 Features

- **Customizable Prefixes**: Tailor the bot's command prefix for each server.
- **Hybrid Commands**: Support for various command types with built-in permission handling.
- **Easy Slash Command Deployment**: Quickly deploy slash commands with minimal setup.

## 🛠️ Built-in Tools

- **Database** powered by [AceBase](https://github.com/appy-one/acebase).
- **Simple cache** mechanism using key-value storage with lifespan to keep memory low.
- **Simple slash command deploy method**.

## 🚀 Getting Started

1. **Install dependencies**

```sh {"id":"01J6KF2SNARAPZS0DW9AVGR6SS"}
bun i
```

or

```sh {"id":"01J6KF2SNARAPZS0DW9C4206KX"}
npm i
```

(replace bun with npm from now on if you don't have bun)

2. **Init environment**

```sh {"id":"01J6KF2SNARAPZS0DW9EHDN42T"}
bun run init
code .env
```

Replace variables with appropriate values. `ADMINS` is a comma-seperated list.

3. **Run the bot**

```sh {"id":"01J6KF2SNARAPZS0DW9JAS41M0"}
bun run start
```