aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPinapelz <donaldshan1@outlook.com>2023-04-13 14:11:49 -0700
committerYukai Shan <yukais6@uci.edu>2023-04-13 14:11:49 -0700
commit5a8b780f3846a708bbf5cfffaf5ba457755bb5d7 (patch)
treedc5e5115deb8e09fbe9b8785049375425e51cd3b
parent50818a8c019eca008f61f32d4e523c424f124ff1 (diff)
Update README with new /configure
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index e572a0f..5bf8ac0 100644
--- a/README.md
+++ b/README.md
@@ -5,13 +5,17 @@ A Java JDA Bot for Tracking VTuber Livestreams and Schedules.
- [JDA](https://github.com/DV8FromTheWorld/JDA)
- [JHolodex](https://github.com/pinapelz/JHolodex)
-## Usage
+## Usage
- Clone and build the project using Maven
- Create a file called `config.json` in the settings folder of the root directory (if it doesn't already exist)
- Fill in necessary credentials and settings in the config file
- Create a file called 'upcomingChannels.txt' in the settings folder of the root directory (if it doesn't already exist)
### Configuring Custom Feeds
+/configure command is used to configure a custom feed related to a particular channel or organizaton.
+The command will use the channel the message is sent in as the channel to send the upcoming/live feed to
+
+This can also be manually configured through the upcomingChannels.txt file:
```
[TYPE]:[INFORMATION]:[DISCORD_CHANNEL_ID]
TYPE: org (organization name) or channel (individual channel)
@@ -28,3 +32,4 @@ channel:UC4WvIIAo89_AzGUh1AZ6Dkg:1094112349163638804
# ![image](https://user-images.githubusercontent.com/21994085/230703769-7c88c760-b81f-4798-883f-475c42d97fe1.png)
# ![image](https://user-images.githubusercontent.com/21994085/230703785-7cb3eb80-a1de-4b46-af81-0b9a7820ab5d.png)
+# ![image](https://user-images.githubusercontent.com/21994085/231882006-23f86f82-ad05-4842-9057-4e66fac8a3b1.png)
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage