DOG's avatar

DOG

A simple bot designed to help servers with roleplaying.

Overview

Prefix
.dog

Creator

Username

Username

DOG is my take on a multipurpose bot for Discord.
My goal is to eventually make modules that can help all kinds different servers, but right now I am focusing on helping roleplay servers.

Modules

Character Toolkit
Character Toolkit allows users on your server to create proxies that they can send messages as without using their actual account.

Steady State
Steady State keeps track of assigned roles, and reassigns them should a member leave and rejoin your server at a later date.

Turn Flow
Setup a turn order in a channel to ping people when it is their turn to speak.

Features
DOG Help and Support Center
Get help with DOG right in your own server. Let me know how I can make DOG better for you, or about problems you are having.

DOG Update
Get notifications in your server when updates are released for DOG. Learn about new features and about bug fixes.

Commands
Commands are invoked by beginning a message with a period.
  • .dog help - displays a list of commands from every module and feature.
Character Toolkit:
  • .c - displays a list of commands and additional information.
  • .c enable - enables the Character Toolkit module.
  • .c disable - disables the Character Toolkit module.
  • .c create [name] [one word prefix] - creates a new proxy with the specified name and prefix.
  • .c avatar [prefix] - changes the avatar of a proxy with the specified prefix.
  • .c name [prefix] - changes the name of a proxy.
  • .c delete [prefix] - delete a proxy.
  • .c list - shows all your proxies.
Steady State:
  • .ss - displays the status of the module.
  • .ss enable - enables the Steady State module.
  • .ss disable - disables the Steady State module.
Turn Flow:
  • .tf - displays a list of commands and additional information.
  • .tf enable - enables the Turn Flow module.
  • .tf disable - disables the Turn Flow module.
  • .tf subscribe - user command to subscribe to Turn Flow notifications in a server.
  • .tf unsbsucribe - user command to unsubscribe from Turn Flow notifications.
  • .tf single @all @users @participating @as @a @mention - setup a channel to where every time a message is sent Turn Flow will notify only the next participant on the turn list.
  • .tf all @all @users @participating @as @a @mention - setup a channel to where every time a message is sent Turn Flow will notify all users participating except the person who posted the last message.
  • .tf off - disable Turn Flow in a channel.
DOG Help and Support Center:
  • .dsupport - displays the status of this feature.
  • .dsupport enable - enable the Help and Support Center.
  • .dsupport disable - disable the Help and Support Center.
DOG Update:
  • .dupdate - displays the status of this feature.
  • .dupdate subscribe - subscribe to notifications in a channel.
  • .dupdate unsubscribe - unsubscribe from notifications.

User Guide
Character Toolkit
Character Toolkit has been designed to be as easy a possible to use, you can make a character in less than a minute.

Creating a new character
To create a new character, you will need a name and a one word prefix. In this example, my character's name was "Gray Wolf" and the prefix was "GW". After you have a name and a prefix, run the creation command:
.c create [name] [one word prefix].
For this example, I typed .c create Gray Wolf GW

That command creates the character, but you will probably also want to assign your character an avatar. You can do this by sending a image with the caption:
.c avatar [prefix]
For this example, I sent a image with the caption .c avatar GW

After your character is ready you can send a message as it by typing "[prefix] [message]" without the quotes.
To send the message I sent in the example, I typed GW Test
The Avatar Editor
Discord has limits on how big a avatar image can be. If DOG detects that your image is too big, it will send you a link to it's web-based avatar editor to help you resize your avatar to a size Discord will accept.

Setup Guide
Permissions
The invite link will automatically create a role for DOG with all of the permissions every module needs, but if you would like to have more control over the permissions DOG has, read this section. When you give DOG permissions, they have to be through a role on your server. When enabling modules, DOG does a permission check to tell you what permissions it will need to successfully enable a module, it does not check channel overrides. The permissions DOG will need will vary depending on what modules you have enabled. There are a number of permissions that Discord gives every user by default that are required for the bot to function properly regardless of what modules are installed. These permissions are the ability to "View Channels", "Send Messages", "Embed Links", "Add Reactions", and "Read Message History". If you took these permissions away from everyone by default, DOG's role will need access to all of the aforementioned permissions.
Additionally...
  • For the Character Toolkit module, DOG will need the ability to "Manage Webhooks" and "Manage Messages".
  • For the Steady State module, DOG will need the ability to "Manage Roles". In addition, keep in mind that DOG will not be able to give people roles if the role is higher than the role DOG has. For every role you want DOG to have the ability to give, make it it is below whatever role you give DOG.
  • For the DOG Help and Support Center feature, DOG will need the ability to "Manage Channels" and "Manage Webhooks".
  • For the DOG Update feature, DOG will need the ability to "Manage Webhooks".
Enabling a module
Each module has an enabling command that you can use to enable a module. Please note that whoever runs the enable command will need the "Manage Server" permission. DOG Update does not have a enabling command, as it is a notification system. For this feature, use the subscribe command to subscribe to update notifications.

Disabling a module
Each module has a disabling command that you can use to disable a module. Please note that whoever runs the disabling command will need the "Manage Server" permission. DOG Update does not have a disabling command, as it is a notification system. For this feature, use the unsubscribe command to subscribe to update notifications.

Ratings & Reviews

0/5

Based on 0 reviews


No reviews here yet!