Skip to content

Latest commit

 

History

History
71 lines (58 loc) · 4.65 KB

README.md

File metadata and controls

71 lines (58 loc) · 4.65 KB
Raw

CaseManager

A discord bot for creating/managing cases

Installation

  1. Download the repository (git clone https://github.com/TrevorBagels/CaseManager.git)
  2. Navigate to the directory (cd CaseManager)
  3. Install dependencies (pip3 install -r requirements.txt)
  4. Create a bot
    1. Go to the discord developer portal
    2. Click "Create a New Application"
    3. Go to the bot tab, click "Add Bot"
    4. Go to the "OAuth2" tab, click the "bot" checkbox
    5. Give the bot administrator permissions (might not be necessary, but some channel permission stuff doesn't seem to work very well without it.
    6. Copy the link that shows up above "BOT PERMISSIONS" and go to it. Use this to add it to your server.
    7. Copy the bot's token (Bot tab -> "TOKEN" area -> click "Copy"
  5. Configure
    1. In ./dev/, create a new file called "config.json". Make the content of that file look like this:
    {
    "token": "ODE5Mjk2OTI0Nzk5NzI5NzQ1.YEkjuA.VyZaIT9TkTlv2xids-XpnMrHU7A",
    "gdrive": true,
    "parent_folder_id": "id_goes_here"
}
    1. Replace the long string with the token you copied.
  6. Set up google drive
    1. Go to the google developer console
    2. Create a project, call it whatever you want
    3. Click enable APIs and services after you wait a long time for stuff to load
    4. Search for "google drive api", click "google drive api"
    5. Click enable, wait forever for more stuff to load
    6. Click "credentials" (on the left sidebar), if it tries to take you to a credentials wizard, click it again
    7. Click "CREATE CREDENTIALS" (near the top left), select the OAuth one, then click "configure consent screen" when it asks you to do that.
    8. Select external, go to the next page
    9. Fill out all the required fields, go to the next page
    10. Skip the scopes page
    11. Add your email as a test user, hit "save and continue"
    12. Go back to the credentials tab
    13. Click create credentials, OAuth client ID
    14. Set application type to desktop app
    15. Save and continue
    16. Click the download button when you're taken back to the credentials tab. Save the file as client_secrets.json in ./dev/
  7. Create a folder in google drive. Call it something like "Cases". Navigate to that folder, and copy it's ID. You can get the ID from the link to the folder, it usually looks like this: https://drive.google.com/drive/u/7/folders/reallyLongFileID. Go back to config.json and set the parent_folder_id property to the ID you just copied.

Usage

Great, now run the bot cd ./dev & python3 -m program

When running, go to the link that is prompted, and sign into the google account you're using with the Google Drive API. It'll tell you to copy a code and paste it into the console. Do that, press enter, and the bot should work now.

When the bot first starts up, you won't have any permissions to do anything with it. Give yourself the "case manager role" that is automatically generated when initializing the bot for the first time. This will give you full access to the bot. You can add permissions to other roles using ?perm @role [permission]. Valid permissions are: none, use, create, and manage. use gives access to the basic usage of the bot. create lets people with the role create cases with ?create [case name]. manage is the highest permission, it lets people manage everything related to the bot.

The bot will also create three categories, one for active cases, one for archived cases, and one for division channels.

Setting your email for google drive

Use ?setemail [email_address] to set your email address. Cases that you are a part of will automatically share their folders with you.

Creating a case

Use ?create [case name] to create a case. You must have the create permission or higher to be able to do this. A new case will be generated, along with a google drive folder and a discord channel.

Adding people to a case

In the channel for the case, use ?add [@member] to add a member to the case.

To allow members to join the case voluntarily, set the security of the case to open using ?security open. To set it back to invite-only, set the security to strict. Members must have the use permission or higher to add themselves to a case. Members can add themselves via ?join [case_ID]

Closing cases

In the channel for the case, use ?close to close and archive the case. Use ?reopen to open it again.

Transfering case ownership

Use ?transfer [@new_owner] to transfer ownership. The new owner will have management access to the case.