yeongaori/JogyoGaori
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add LICENSE & Update README.md

Browse Source
This commit is contained in:
yeongaori
2025-08-07 01:56:20 +09:00
parent dbe661df03
commit 95c795d66e
2 changed files with 461 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -2,11 +2,31 @@
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
- **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.
- **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
@@ -36,21 +56,4 @@ A Discord bot that makes it easy for Republic of Korea soldiers to check their d
**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
```
```