diff options
| author | Pinapelz <donaldshan1@outlook.com> | 2023-04-12 21:16:52 -0700 |
|---|---|---|
| committer | Pinapelz <donaldshan1@outlook.com> | 2023-04-12 21:16:52 -0700 |
| commit | eeac17f653624607c70600e41a140796b89ed5d5 (patch) | |
| tree | 7bce2c305d1ed18ff5f9282ed33579e0962f4e15 /README.md | |
| parent | 819cc274a1cd5badf1f05313e23df3b27e67cf54 (diff) | |
Update README with instructions on steps for configuration
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 26 insertions, 1 deletions
@@ -1,5 +1,30 @@ # VStreamTrack -A Java JDA Bot for Tracking VTuber Livestreams and Schedules +A Java JDA Bot for Tracking VTuber Livestreams and Schedules. + +## Dependencies +- [JDA](https://github.com/DV8FromTheWorld/JDA) +- [JHolodex](https://github.com/pinapelz/JHolodex) + +## 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 +``` +[TYPE]:[INFORMATION]:[DISCORD_CHANNEL_ID] +TYPE: org (organization name) or channel (individual channel) +INFORMATION: If TYPE is channel: insert channel ID. If TYPE is org: insert organization name. +DISCORD_CHANNEL_ID: The ID of the Discord channel you want the feed to be sent to. + +EXAMPLE: +org:Nijisanji:1055710959919976479 +(All upcoming and live streams for members of the Nijisanji organization will be sent to the Discord channel with ID 1055710959919976479) + +channel:UC4WvIIAo89_AzGUh1AZ6Dkg:1094112349163638804 +(All upcoming and live streams for the channel with ID UC4WvIIAo89_AzGUh1AZ6Dkg will be sent to the Discord channel with ID 1094112349163638804) +``` #  #  |