Update README.md
This commit is contained in:
54
README.md
54
README.md
@@ -1,22 +1,56 @@
|
||||
# DiscordGaori
|
||||
Rewritten [DiscordGaori](https://github.com/yeongaori/DiscordGaori-StarLight) with Node.js
|
||||
# 조교가오리 JogyoGaori
|
||||
|
||||
A Discord bot that makes it easy for Republic of Korea soldiers to check their discharge date
|
||||
|
||||
## Features
|
||||
|
||||
### Rich Presence (RPC)
|
||||
- **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.
|
||||
|
||||
This bot supports Discord's Rich Presence feature, which allows you to customize the bot's status.
|
||||
## Prerequisites
|
||||
|
||||
To configure the RPC, you need to set the following variables in your `.env` file:
|
||||
- Node.js
|
||||
- A Discord Bot Token
|
||||
|
||||
- `RPC_ENABLED`: Set to `true` to enable RPC, or `false` to disable it.
|
||||
- `RPC_ACTIVITY_NAME`: The name of the activity you want the bot to display (e.g., "with Gaori").
|
||||
- `RPC_ACTIVITY_TYPE`: The type of activity. Can be one of `Playing`, `Listening`, `Watching`, `Streaming`, or `Competing`.
|
||||
## Installation
|
||||
|
||||
Example `.env` configuration:
|
||||
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="전역일 계산"
|
||||
RPC_ACTIVITY_NAME="Calculating discharge date"
|
||||
RPC_ACTIVITY_TYPE=Playing
|
||||
```
|
@@ -5,7 +5,7 @@
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"start": "node index.js",
|
||||
"deploy": "node deploy-commands.js",
|
||||
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
"repository": {
|
||||
|
Reference in New Issue
Block a user