Noi/BirthdayBot
1
0
Fork 0
mirror of https://github.com/NoiTheCat/BirthdayBot.git synced 2024-10-16 15:59:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add Discord Bots page markdown

Browse source
This commit is contained in:
Noikoio 2018-12-07 22:12:11 -08:00
parent f184748356
commit 2bd9916ec0
2 changed files with 12 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
Discord Bots descrption.html
View file

@ -1,31 +0,0 @@
<div style="width: 80%; margin-left: auto; margin-right: auto;">
<p>Help command: <i>bb.help</i>.</p>
<hr style="width: 20%" />
<p><b>Recognize birthdays in your Discord community!</b></p>
<br />
<p>This bot will automatically add a role to users during their birthdays. If desired, it will also announce birthdays in a channel of your choosing. Time zones are supported per-server and per-user to ensure that birthdays and events are recognized at appropriate times.</p>
<br />
<p>
<b>Setup</b>
<ol style="margin-left: 3em;">
<li>Create a dedicated birthday role for use by the bot.</li>
<li>Invite the bot to your server. Ensure that the bot is able to manipulate this role.</li>
<ul style="margin-left: 2em;list-style-type: circle;">
<li><b>Do not use an existing role!</b> This bot assumes exclusive control over it. Any users not having birthdays will have the role automatically removed.</li>
</ul>
<li>Instruct the bot to use the role: `bb.config role (role name)`</li>
<li>(Optional) Set a birthday announcement channel: `bb.config channel (channel)`</li>
<li>(Optional) Set a server default time zone: `bb.config zone (time zone)`</li>
</ol>
</p>
<br />
<p>
<b>Other details</b>
<ul style="margin-left: 3em;list-style-type: circle;">
<li>Birthday information is not shared between servers. If you are in multiple servers that this bot is in, you must register your birthday (including time zone) within each server.</li>
<ul style="margin-left: 2em;list-style-type: circle;">
<li>This is in case one wishes to share their birthday only in certain communities.</li>
</ul>
<li>Problematic users? This bot supports blocking certain or all users from using commands. Server moderators are able to issue commands on a user's behalf.</li>
</ul>
</div>

12
DiscordBots.md Normal file
View file

@ -0,0 +1,12 @@
## Recognize birthdays in your Discord community!
This bot will automatically set a role to users during their birthdays. If desired, birthdays will also be announced in a channel of your choosing. Time zones are supported per-user as well as per-server, and it is possible to limit usage of the bot if users are being abusive.
#### Getting started
* Invite the bot. Be mindful that it requires role setting permissions.
* Create a dedicated birthday role to be used only by the bot. Ensure the new role is under the bot's role.
* **Do not use an existing role!** This bot assumes exclusive control over it. Any users without birthdays will have the role automatically removed.
* Instruct the bot to use the role: `bb.config role (role name)`
* Optional: Set a birthday announcement channel: `bb.config channel (channel)
* Optional: Set a server default time zone: `bb.config zone (time zone)`
* See the command `bb.help-tzdata` for more information on specifying a time zone.