Skip to content

Commit

Permalink
notifications: copy current notif docs (#26)
Browse files Browse the repository at this point in the history
* notifications: copy current notif docs

Copy the currently notifications docs; internal discussion concluded
that this is the current milestone, such that we have a faster migration
to the statically built site.

Some modifications such as notice shortcodes were necessary for it to
work at all. I also took the liberty and removed links to dead /
redundant / not yet existing links.

Signed-off-by: Luca Zeuch <[email protected]>

* notifications: actually write intro text

Signed-off-by: Luca Zeuch <[email protected]>

---------

Signed-off-by: Luca Zeuch <[email protected]>
  • Loading branch information
l-zeuch authored Jun 7, 2024
1 parent f4953d2 commit 0ab0c09
Show file tree
Hide file tree
Showing 9 changed files with 168 additions and 0 deletions.
11 changes: 11 additions & 0 deletions content/notifications/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
archetype = "chapter"
title = 'Notifications and Feeds'
weight = 6
+++

YAGPDB offers you a variety of ways to keep up with what's happening, such as users joining, leaving, new Reddit posts,
new YouTube videos, and more. You can set up notifications for these events in your server, and you can also set up
feeds to automatically post new content from your favorite sources.

{{%children containerstyle="div" style="h2" description="true" %}}
38 changes: 38 additions & 0 deletions content/notifications/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
+++
title = 'General'
weight = 1
+++

General notifications such as a welcoming direct message, a message in the server when users join or leave, as well as a
simple message announcing when a channel's topic has changed.

<!--more-->

![Overview of general feeds](./general_overview.png)

### Join Message

**Channel:** Choose what channel you want the bot to announce the message in.

**Message:** Write the message that you want the bot to say when someone joins.

### Leave Message

**Channel:** Choose what channel you want the bot to announce the message in.

**Message:** Write the message that you want the bot to say when someone leaves.

### Join Message in Direct Message

Write a message that you want the bot to send to the user via DM whenever someone joins your server.

### Topic Change Message

Choose what channel you want the bot to announce the topic change from a specific channel or the channel that the topic
was changed in.

{{% notice tip %}}

Custom command templates are supported for usage in all the notification feeds provided.

{{% /notice %}}
Binary file added content/notifications/general_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions content/notifications/reddit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
+++
title = 'Reddit'
weight = 2
+++

Get notifications from your favorite subreddits directly in your Discord server.

<!--more-->

{{% notice warning %}}
Fast Reddit feeds to the **top 10 subreddits** are disabled, due to being too spammy for YAGPDB's current system.
{{% /notice %}}

## Reddit Feed

![Small showcase of the Reddit feeds interface.](./reddit.png)

To get notifications from a subreddit, simply enter the name of the subreddit in the subreddit field without the `r/` in
front (for example, to add a feed for the `r/jonas747`, you would put "jonas747" as the subreddit name). Then, specify
which channel you would like the bot to post the feed in.

You can toggle whether to post using embeds or without using them. With embeds, the feed will look nicer but videos and
such will not be attached but just linked.
Binary file added content/notifications/reddit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions content/notifications/streaming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
+++
title = 'Streaming'
weight = 4
+++

Let everyone know that someone is currently streaming.

<!--more-->

### Streaming Feed

{{% notice note %}}
There are currently some issues with the streaming announcement, and it may not always give the announcement. It will
however, always assign the streamer role.
{{% /notice %}}

{{% notice warning %}}
The streaming role will be **automatically removed** from a member that is not streaming if it is given manually, so be
careful! If YAGPDB is removing member's roles without apparent reason, this may well be the cause.
{{% /notice %}}

![Showcase of the streaming feed interface.](./streaming.png)

Steaming notification is triggered based on your Discord streaming status (When you go purple, AKA streaming). You can
either have announcements, be assigned the streaming role or both.

### **Announce Channel**

Choose the Channel that you want to bot to post the announcement in.

### Announcement Message

Write the message that you want the announcement to say. The streaming announcements accept most templates, but have
some additional special ones:

* `{{ .URL }}` outputs the URL of the stream.
* `{{ .Game }}` outputs the current game.
* `{{ .StreamTitle }}` outputs the stream title.
* `{{ .User.Username }}` outputs the Discord username of the person who is streaming.

### Game Regex

Use regex to filter out games to post announcements and assign roles for specific games.

### Currently Streaming Role

Assign this role to the people streaming.

### Whitelist role

Only assign a role and make announcement for the people with this role.

### Ignore role

Do not assign a role and make an announcement for people with this role.

### Stream Title Regex

Use regex to filter out streams based on the title of their stream.
Binary file added content/notifications/streaming.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions content/notifications/youtube.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
+++
title = 'YouTube'
weight = 3
+++

Get notifications from your favorite YouTubers directly in your Discord server.

<!--more-->

## YouTube Feed

{{% notice warning %}}

Do **NOT** fill in both the Channel ID and the Channel URL.

* There may be up to 5-15 minutes of delay for the bot to announce the video after it gets posted.
* The bot will only announce the video if it's public.

{{% /notice %}}

![Showcase of the YouTube feed interface.](./youtube.png)

To get notifications from a YouTube channel, simply go to the YouTuber's channel and input either the ID or the Username in their respective field of the followings:

* YouTube Channel ID

* YouTube Channel Username

If your channel looks like this `youtube.com/user/h3h3Productions` then you would go into the username line and type
in h3h3Productions.

If your channel looks like this `youtube.com/channel/UCt-ERbX-2yA6cAqfdKOlUwQ` then you would go into the ID line and
type in UCt-ERbX-2yA6cAqfdKOlUwQ.

You can change the channel that the notifications are posted to via the dropdown menu.

You can also mention everyone by clicking the checkbox under the dropdown menu that says Mention everyone.
Binary file added content/notifications/youtube.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0ab0c09

Please sign in to comment.