https://github.com/tfagaming/discordts-modmail-bot
A simple Discord ModMail bot built with TypeScript.
https://github.com/tfagaming/discordts-modmail-bot
discord-bot discord-ts discord-ts-bot modmail modmail-bot modmail-js modmailbot modmailjs
Last synced: about 2 months ago
JSON representation
A simple Discord ModMail bot built with TypeScript.
- Host: GitHub
- URL: https://github.com/tfagaming/discordts-modmail-bot
- Owner: TFAGaming
- License: gpl-3.0
- Created: 2023-03-24T19:25:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-18T15:14:03.000Z (almost 3 years ago)
- Last Synced: 2025-03-20T12:39:42.007Z (about 1 year ago)
- Topics: discord-bot, discord-ts, discord-ts-bot, modmail, modmail-bot, modmail-js, modmailbot, modmailjs
- Language: TypeScript
- Homepage:
- Size: 49.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DiscordTS-ModMail-Bot
A simple Discord ModMail bot built with TypeScript.
## Installation
Install `typescript` globally:
```sh
npm i -g typescript
```
Install all the required dependencies:
```sh
npm i discord.js@14 dotenv @tfagaming/jsondb
```
Rename the file **example.config.ts** (in **src/**) to **config.ts** and fill all the required properties.
To compile the TypeScript files to JavaScript files & run the compiled files, use the command below:
```sh
npm run build
```
> **Warning**
> The JSON files **bans.json** and **main.json** (in **JSON/**) are required, do not delete them so you will not get any error from the project.
## ModMail's moderation:
The ban and unban commands exists for the ModMail. Whenever you want to ban a user from using the ModMail system, use the slash command `/ban`, else use `/unban`. These both slash commands uses the JSON file called **bans.json**.