59 lines
2.0 KiB
Markdown
Executable File
59 lines
2.0 KiB
Markdown
Executable File
# 조교가오리 JogyoGaori
|
|
|
|
A Discord bot that makes it easy for Republic of Korea soldiers to check their discharge date
|
|
|
|
Invite [here](https://discord.com/oauth2/authorize?client_id=1282653874976722944&permissions=2147731456&integration_type=0&scope=bot)
|
|
|
|
## Features
|
|
|
|
- **Discharge Date Calculation:** Calculates the discharge date and shows the progress based on the user's enlistment date and service type.
|
|
- **Supports Various Service Types:** Supports various service types such as Army, Navy, Air Force, Marine Corps, and Social Service Agent.
|
|
- **Detailed Information:** Provides detailed information such as total service days, current service days, remaining days, and current rank.
|
|
- **Slash and Text Command Support:** Supports both slash commands and legacy text commands for user convenience.
|
|
|
|
## Commands
|
|
|
|
### Slash Commands
|
|
|
|
- `/입대일 [enlistment_date] [service_type]`: Saves your enlistment date and service type.
|
|
- `enlistment_date`: Enter in `YYYY-MM-DD` format.
|
|
- `service_type`: Choose from `Army`, `Navy`, `Air Force`, `Marine Corps`, or `Social Service Agent`.
|
|
- `/전역일 [user] [decimal_points] [details]`: Checks the discharge date information.
|
|
- `user` (optional): Checks the discharge date information of a specific user.
|
|
- `decimal_points` (optional): Sets the number of decimal points for the progress percentage.
|
|
- `details` (optional): Sets whether to display detailed information.
|
|
|
|
### Legacy Commands
|
|
|
|
- `!입대일 [enlistment_date] [service_type]`: Saves your enlistment date and service type.
|
|
- `!전역일 [user]`: Checks the discharge date information.
|
|
|
|
## 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
|
|
``` |