56 lines
1.4 KiB
Markdown
Executable File
56 lines
1.4 KiB
Markdown
Executable File
# 조교가오리 JogyoGaori
|
|
|
|
A Discord bot that makes it easy for Republic of Korea soldiers to check their discharge date
|
|
|
|
## Features
|
|
|
|
- **Military Service Information:** Calculate discharge dates and provide other relevant information for service members.
|
|
- **General Commands:** A suite of commands for general server utility and entertainment.
|
|
- **Customizable Rich Presence:** Configure the bot's status message.
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js
|
|
- A Discord Bot Token
|
|
|
|
## Installation
|
|
|
|
1. **Clone the repository:**
|
|
```sh
|
|
git clone https://github.com/yeongaori/DiscordGaori.git
|
|
cd DiscordGaori
|
|
```
|
|
|
|
2. **Install dependencies:**
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
3. **Create a `.env` file** in the root directory and add your Discord bot token:
|
|
```
|
|
DISCORD_TOKEN=your_bot_token_here
|
|
```
|
|
|
|
## Usage
|
|
|
|
**Start the bot:**
|
|
```sh
|
|
npm start
|
|
```
|
|
|
|
## Rich Presence (RPC) Configuration
|
|
|
|
To configure the Rich Presence functionality, set the following environment variables in your `.env` file:
|
|
|
|
- `RPC_ENABLED`: Set to `true` to enable Rich Presence, or `false` to disable it.
|
|
- `RPC_ACTIVITY_NAME`: Specifies the activity name to be displayed.
|
|
- `RPC_ACTIVITY_TYPE`: Defines the type of activity. Valid options include `Playing`, `Listening`, `Watching`, `Streaming`, or `Competing`.
|
|
|
|
### Example `.env` Configuration
|
|
|
|
```
|
|
DISCORD_TOKEN=your_bot_token_here
|
|
RPC_ENABLED=true
|
|
RPC_ACTIVITY_NAME="Calculating discharge date"
|
|
RPC_ACTIVITY_TYPE=Playing
|
|
``` |