aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 5bf8ac03273d06f70956622b4ab043c5fd18cdc2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# VStreamTrack
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
/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)
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)
```

# ![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