generated from Baipyrus/DiscordJS-Template
Compare commits
No commits in common. "fe139004bf1a9b3dddaf7acf1125dcaaeec6f99d" and "8d2f647ffd015699dbd7aae3bd03fbf4340ea69f" have entirely different histories.
fe139004bf
...
8d2f647ffd
39
README.md
39
README.md
@ -1,34 +1,4 @@
|
|||||||
# Setup
|
# Getting started
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
- NodeJS (LTS; including NPM): https://nodejs.org/en/download/
|
|
||||||
- Git: https://git-scm.com/downloads
|
|
||||||
|
|
||||||
## Download
|
|
||||||
|
|
||||||
Download the current source code [here](https://git.baipyr.us/Baipyrus/DiscordJS-Example/archive/main.zip).
|
|
||||||
|
|
||||||
Or clone the repository manually:
|
|
||||||
```bash
|
|
||||||
git clone https://git.baipyr.us/Baipyrus/DiscordJS-Example.git
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Install the required dependencies:
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
## Running
|
|
||||||
|
|
||||||
Start the bot with:
|
|
||||||
```bash
|
|
||||||
npm run start
|
|
||||||
```
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
Discord utilizes different types of commands to interface with bots. The following explanations aim to explain these types.
|
Discord utilizes different types of commands to interface with bots. The following explanations aim to explain these types.
|
||||||
|
|
||||||
@ -147,7 +117,6 @@ Full names:
|
|||||||
- `/custom_vc create`
|
- `/custom_vc create`
|
||||||
|
|
||||||
Description:
|
Description:
|
||||||
|
|
||||||
The bot creates a new voice channel with the given name and registers said channel for custom VC creation
|
The bot creates a new voice channel with the given name and registers said channel for custom VC creation
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
@ -161,12 +130,11 @@ Full names:
|
|||||||
- `/custom_vc register`
|
- `/custom_vc register`
|
||||||
|
|
||||||
Description:
|
Description:
|
||||||
|
|
||||||
Fetches any existing voice channel and registers it for custom VC creation directly
|
Fetches any existing voice channel and registers it for custom VC creation directly
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
||||||
- \_channel: Discord Channel
|
- \_id: Discord Channel ID
|
||||||
|
|
||||||
### remove
|
### remove
|
||||||
|
|
||||||
@ -175,12 +143,11 @@ Full names:
|
|||||||
- `/custom_vc remove`
|
- `/custom_vc remove`
|
||||||
|
|
||||||
Description:
|
Description:
|
||||||
|
|
||||||
Fetches any voice channel, looks if it is registered for custom VC creation and then unregisters it
|
Fetches any voice channel, looks if it is registered for custom VC creation and then unregisters it
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
||||||
- \_channel: Discord Channel
|
- \_id: Discord Channel ID
|
||||||
|
|
||||||
## Automated tasks
|
## Automated tasks
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import { ChatInputCommandInteraction, ContextMenuCommandInteraction, Role } from 'discord.js';
|
import { ChatInputCommandInteraction, ContextMenuCommandInteraction, Role } from 'discord.js';
|
||||||
import { Message, RoleEmojiPair, Guild } from './database.js';
|
import { Message, RoleEmojiPair } from './database.js';
|
||||||
import { readdir } from 'fs/promises';
|
import { readdir } from 'fs/promises';
|
||||||
import { config } from 'dotenv';
|
import { config } from 'dotenv';
|
||||||
import { Op } from 'sequelize';
|
import { Op } from 'sequelize';
|
||||||
|
Loading…
Reference in New Issue
Block a user