Skip to content

Commit d614c2c

Browse files
authored
Update README.md
1 parent d15f22a commit d614c2c

1 file changed

Lines changed: 54 additions & 3 deletions

File tree

README.md

Lines changed: 54 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,55 @@
1-
# DiscordYoutubeBot
2-
Sends a notification of a new video to discord
1+
[![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.svg?v=103)](https://github.com/otherwiseDE/DiscordTwitterBot/blob/main/LICENSE)
2+
3+
# otherwiseDE's Youtube Bot!
4+
5+
Hey.
6+
Welcome and Thanks for your interest in my Discord Youtube Bot Project.
7+
Please read this File completly to not miss out on Information.
8+
9+
To receive Support from me, Join my [Discord](https://discord.gg/PrGCCWpDbP) and head to `#support` and monitor `#github-feeds` for any updates!
10+
11+
12+
# Preview
13+
14+
![image](https://i.imgur.com/k02Sr1O.png)
15+
16+
17+
# Dependencies
18+
You will need:
19+
20+
- NodeJS v16
21+
- NPM v6 (or higher)
22+
23+
# Dependencies Installation
24+
Open the terminal / Windows PowerShell in the folder the code is (where index.js and config.json are)
25+
Please then enter the following commands:
26+
27+
28+
- `npm i discord.js`
29+
- `npm i quick.db`
30+
- `npm i rss-parser`
31+
32+
Please do each line at one time, this shouldn’t take more than a minute.
33+
34+
## Configuration (config.json)
35+
36+
The file says: `“discordBotToken”:””, “discord_channel”:””,` (continuous)
37+
38+
So when talking about for example the `discordBotToken`, please change it so it looks like: `“discordBotToken”:””,` `“discord_channel”:””,`
39+
40+
- To find the discordBotToken, go to [https://discord.com/developers/applications](https://discord.com/developers/applications) , create an application by pressing “New Application” or go for a pre-existing application, then in the section “Bot”, create one. Beneath the username it should say “Token”. Hit “Copy” and enter it in
41+
42+
## Bot Configuration
43+
44+
45+
- To find the `discord_channel`, Enable Discord Developer Mode and Right-Click on the Channel where you want the Bot to post the Updates in.
46+
- `messageText` is the Text, the Bot posts along with the URL. The Bot can Ping `everyone`, `here` and Roles. `{author}` and `{url}` are for the Channel Name and the Video Link. Please at all time keep both of them within this Text.
47+
- `channel_id` describes the Youtube Channel ID. To find this, please head to the Youtube Channel you want to monitor, copy the Link and paste it on this [Website ](https://commentpicker.com/youtube-channel-id.php "Website "). Afterwards, copy the `Channel ID` and paste it into the config.json. Usally Channel ID's look like this `UC-lHJZR3Gqxm24_Vd_AJ5Yw`
48+
- `refreshInterval` is the amount of Time in Milliseconds between each Video Upload Refresh. 30000 Milliseconds is 30 Seconds.
49+
50+
## Credits
51+
52+
A huge Thanks goes out to [DevAndromeda](https://github.com/DevAndromeda "DevAndromeda") who published his [Youtube Notification](https://github.com/DevAndromeda/youtube-notification-bot "Youtube Notification") a few Years ago which has been starting ground for this bot.
53+
54+
If you, DevAndromeda, have any issues regarding this or want this Bot taken down - Don't hesitate to E-Mail me at `bthiele@otherwisede.net`.
355

4-
## Work In Progress

0 commit comments

Comments
 (0)