Noi/BirthdayBot
1
0
Fork 0
mirror of https://github.com/NoiTheCat/BirthdayBot.git synced 2024-11-22 05:54:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Readme; Add DBots Description HTML

Browse source
This commit is contained in:
Noikoio 2018-09-17 14:03:00 -07:00
parent fbb1c5511a
commit 574b5be085
2 changed files with 44 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
Discord Bots descrption.html Normal file
View file

@ -0,0 +1,28 @@
<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>
<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>

20
Readme.md
View file

@ -1,7 +1,19 @@
# BirthdayBot
# Birthday Bot
Discord birthday reminder bot.
Recognize birthdays in your Discord community!
Currently a major work in progress. Code may be restructured and features added, modified, or deleted.
Invite: https://discordapp.com/oauth2/authorize?client_id=470673087671566366&scope=bot
It is usable, however. A public instance exists. Contact me if you want it in your server.
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.
## Setup
1. Create a dedicated birthday role for use by the bot.
2. Invite the bot to your server. Ensure that the bot is able to manipulate this role.
3. Instruct the bot to use the role: `bb.config role (role name)`
4. (Optional) Set a birthday announcement channel: `bb.config channel (channel)`
5. (Optional) Set a server default time zone: `bb.config zone (time zone)`
## Other details
* 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.
* This is in case one wishes to share their birthday only in certain communities.
* 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.