From a53c73ab59beeb5204e3044d76e8359c8847878a Mon Sep 17 00:00:00 2001 From: Noikoio Date: Mon, 27 May 2019 23:03:34 -0700 Subject: [PATCH] Update documentation, version, author name --- BirthdayBot/BirthdayBot.vbproj | 6 +++--- DiscordBots.md | 16 +++++++++++----- License.txt | 2 +- Readme.md | 12 +----------- 4 files changed, 16 insertions(+), 20 deletions(-) diff --git a/BirthdayBot/BirthdayBot.vbproj b/BirthdayBot/BirthdayBot.vbproj index 55ba629..a75ff94 100644 --- a/BirthdayBot/BirthdayBot.vbproj +++ b/BirthdayBot/BirthdayBot.vbproj @@ -4,9 +4,9 @@ Exe BirthdayBot netcoreapp2.0 - 0.8.0 - 0.8.0.0 - Noikoio + 0.9.0 + 0.9.0.0 + Noiiko Discord bot for birthday reminders. Sub Main diff --git a/DiscordBots.md b/DiscordBots.md index f7ab01d..0699323 100644 --- a/DiscordBots.md +++ b/DiscordBots.md @@ -1,12 +1,18 @@ ## 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 * 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. +* 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. 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)` -* 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. +* 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. \ No newline at end of file diff --git a/License.txt b/License.txt index 43afc78..84d0671 100644 --- a/License.txt +++ b/License.txt @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 Noi, a.k.a. Noikoio +Copyright (c) 2018-2019 Noi, a.k.a. Noiiko Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/Readme.md b/Readme.md index 936e13e..25a6f21 100644 --- a/Readme.md +++ b/Readme.md @@ -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. -## 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. +For more information, see the `DiscordBots.md` file. \ No newline at end of file