Noi/BirthdayBot
1
0
Fork 0
mirror of https://github.com/NoiTheCat/BirthdayBot.git synced 2024-11-24 17:34:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update documentation, version, author name

Browse source
This commit is contained in:
Noikoio 2019-05-27 23:03:34 -07:00
parent 7623fd5e0b
commit a53c73ab59
4 changed files with 16 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
BirthdayBot/BirthdayBot.vbproj
View file

@ -4,9 +4,9 @@
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<RootNamespace>BirthdayBot</RootNamespace> <RootNamespace>BirthdayBot</RootNamespace>
<TargetFramework>netcoreapp2.0</TargetFramework> <TargetFramework>netcoreapp2.0</TargetFramework>
<Version>0.8.0</Version> <Version>0.9.0</Version>
<AssemblyVersion>0.8.0.0</AssemblyVersion> <AssemblyVersion>0.9.0.0</AssemblyVersion>
<Authors>Noikoio</Authors> <Authors>Noiiko</Authors>
<Company /> <Company />
<Description>Discord bot for birthday reminders.</Description> <Description>Discord bot for birthday reminders.</Description>
<StartupObject>Sub Main</StartupObject> <StartupObject>Sub Main</StartupObject>

16
DiscordBots.md
View file

@ -1,12 +1,18 @@
## Recognize birthdays in your Discord community! ## 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. Birthday Bot is a simple, single-purpose bot. It will set a role on your users for the duration of their birthdays and, if desired, can announce a message in a channel of your choosing. Server owners can further specify a default time zone, with individual users also setting their own to ensure everyone's birthdays are recognized precisely on time.
#### Getting started #### Getting started
* Invite the bot. Be mindful that it requires role setting permissions. * 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. * Create a dedicated birthday role to be used only by the bot. Ensure the new role is placed beneath the bot's own role.
* **Do not use an existing role!** This bot assumes exclusive control over it. Any users without birthdays will have the role automatically removed. * **Do not use an existing role!** This bot assumes exclusive control over it. Users that have the role but are not having a birthday *will* be removed from it!
* Instruct the bot to use the role: `bb.config role (role name)` * 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)` #### Other tips
* Set the birthday announcement channel: `bb.config channel (channel)`
* Set a default time zone: `bb.config zone (time zone)`
* Use the command `bb.help-tzdata` for information on how to specify time zones. * Use the command `bb.help-tzdata` for information on how to specify time zones.
* Customize the announcement message: See `bb.help-message` for more information.
#### Note
Birthday information is not shared between servers. This is *by design*, as some people prefer to share their birthdays with select groups of people but keep it obscured from other communities.

2
License.txt
View file

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2018 Noi, a.k.a. Noikoio <noikoio1@gmail.com> Copyright (c) 2018-2019 Noi, a.k.a. Noiiko <noikoio1@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

12
Readme.md
View file

@ -7,14 +7,4 @@ Recognize birthdays in your Discord community!
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. 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 For more information, see the `DiscordBots.md` file.
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.