Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jasonw4331/vrc-group-sync
A bot which automatically places a VRChat group member into a role based on preconfigured rules
https://github.com/jasonw4331/vrc-group-sync
Last synced: 5 days ago
JSON representation
A bot which automatically places a VRChat group member into a role based on preconfigured rules
- Host: GitHub
- URL: https://github.com/jasonw4331/vrc-group-sync
- Owner: jasonw4331
- License: mit
- Created: 2023-06-23T09:47:06.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-22T11:34:29.000Z (8 months ago)
- Last Synced: 2024-04-22T12:51:42.129Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.31 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Discord Bot TypeScript Template
[](https://discord.js.org/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/KevinNovak/Discord-Bot-TypeScript-Template/stargazers)
[](https://github.com/KevinNovak/Discord-Bot-TypeScript-Template/pulls)
**Discord bot** - A discord.js bot template written with TypeScript.
## Introduction
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 copy this repo, follow the [setup instructions](#setup) below, and have a working bot with many [boilerplate features](#features) already included!
For help using this template, feel free to [join our support server](https://discord.gg/Vyf6fEWbVr)!
[](https://discord.gg/Vyf6fEWbVr)
## Features
### Built-In Bot Features:
- Basic command structure.
- Rate limits and command cooldowns.
- Welcome message when joining a server.
- Shows server count in bot status.
- Posts server count to popular bot list websites.
- Support for multiple languages.
### Developer Friendly:
- Written with TypeScript.
- Uses the [discord.js](https://discord.js.org/) framework.
- Built-in debugging setup for VSCode.
- Written with [ESM](https://nodejs.org/api/esm.html#introduction) for future compatibility with packages.
- Support for running with the [PM2](https://pm2.keymetrics.io/) process manger.
- Support for running with [Docker](https://www.docker.com/).
### Scales as Your Bot Grows:
- Supports [sharding](https://discordjs.guide/sharding/) which is required when your bot is in 2500+ servers.
- Supports [clustering](https://github.com/KevinNovak/Discord-Bot-TypeScript-Template-Master-Api) which allows you to run your bot on multiple machines.
## Commands
This bot has a few example commands which can be modified as needed.
### Help Command
A `/help` command to get help on different areas of the bot or to contact support:
### Info Command
A `/info` command to get information about the bot, links to different resources, or developer information.
### Test Command
A generic command, `/test`, which can be copied to create additional commands.
### Welcome Message
A welcome message is sent to the server and owner when the bot is added.
## Setup
1. Copy example config files.
- Navigate to the `config` folder of this project.
- Copy all files ending in `.example.json` and remove the `.example` from the copied file names.
- Ex: `config.example.json` should be copied and renamed as `config.json`.
2. Obtain a bot token.
- You'll need to create a new bot in your [Discord Developer Portal](https://discord.com/developers/applications/).
- See [here](https://www.writebots.com/discord-bot-token/) for detailed instructions.
- At the end you should have a **bot token**.
3. Modify the config file.
- Open the `config/config.json` file.
- You'll need to edit the following values:
- `client.id` - Your discord bot's [user ID](https://techswift.org/2020/04/22/how-to-find-your-user-id-on-discord/).
- `client.token` - Your discord bot's token.
4. Install packages.
- Navigate into the downloaded source files and type `npm install`.
5. Register commands.
- In order to use slash commands, they first [have to be registered](https://discordjs.guide/creating-your-bot/command-deployment.html).
- Type `npm run commands:register` to register the bot's commands.
- Run this script any time you change a command name, structure, or add/remove commands.
- This is so Discord knows what your commands look like.
- It may take up to an hour for command changes to appear.
## Start Scripts
You can run the bot in multiple modes:
1. Normal Mode
- Type `npm start`.
- Starts a single instance of the bot.
2. Manager Mode
- Type `npm run start:manager`.
- Starts a shard manager which will spawn multiple bot shards.
3. PM2 Mode
- Type `npm run start:pm2`.
- Similar to Manager Mode but uses [PM2](https://pm2.keymetrics.io/) to manage processes.
## Bots Using This Template
A list of Discord bots using this template.
| Bot | Servers |
| ---------------------------------------------------------------------- | ------------------------------------------------------------- |
| [Birthday Bot](https://top.gg/bot/656621136808902656) |  |
| [QOTD Bot](https://top.gg/bot/713586207119900693) |  |
| [Friend Time](https://top.gg/bot/471091072546766849) |  |
| [Bento](https://top.gg/bot/787041583580184609) |  |
| [NFT-Info](https://top.gg/bot/902249456072818708) |  |
| [Skylink-IF](https://top.gg/bot/929527099922993162) |  |
| [Topcoder TC-101](https://github.com/topcoder-platform/tc-discord-bot) | |
Don't see your bot listed? [Contact us](https://discord.gg/Vyf6fEWbVr) to have your bot added!