Giter VIP home page Giter VIP logo

jeeveswowdiscordbot's Introduction

Bot Commands

General

Command Description
!help, !commands Shows this list of commands.

World Quests

Command Description
!wqscan Runs a one-time scan for a list of items and returns results in channel.
!wqwatch Saves a list of items for the bot to watch for and return hits to user. If run by a user that already has a registered list of search terms, the new terms are added to the list.
!wqwatchlist Shows user their currently saved list of item search terms.
!wqremove Removes the provided comma-separated search term(s) from a user's watch list.
!wqclear Clears all currently saved items from user's watch list.

Use slot:[SLOTNAME] to search for items in a certain slot instead of by name.

Examples: !wqscan slot:trinket, !wqwatch slot:cloak.

Pronouns

Command Description
!pronouns add Adds a set of pronouns to the user as a Discord role.
!pronouns remove Removes a set of pronouns from the user.

Other Roles

Command Description
!addrole [role] Adds a Discord role to the user.
!removerole [role] Removes a Discord role from the user.

Available roles: Raider, Mythics

WQ Watchlist Interface

  • User will send '!wqwatch item1, item2, item3'.
  • These item strings will be saved in a JSON object along with the user's name (discord username, not display name)
  • On a certain interval, the WQ search daemon will scan active WQs for all registered keywords for each user.
  • When matches are found, the results are sent to the user in a PM and/or posted in the bot channel @ the user.
  • User will send '!wqclear' to clear the user's record

WQ Watchlist JSON Format

{
    {
        username: 'tragicmuffin',
        usermention: 'Tenxian',
        items: ['item1', 'item2', 'item3']
    }
}

Developer Guide

To run this project locally, you must first install the PostgreSQL binary for your environment and be able to run psql from the command line.

This project uses Pipenv (found here) to manage all python dependencies.

Getting started locally:

python3 -m pip install pipenv
pipenv install --dev .
pipenv run python TMADiscordBot.py

To test locally using the remote Heroku database, you must install the Heroku CLI tool:

pipenv run heroku local

To open Postgres command line on remote PSQL DB:

heroku pg psql

jeeveswowdiscordbot's People

Contributors

mcdong avatar xram64 avatar

Forkers

mcdong k1ck3r

jeeveswowdiscordbot's Issues

Notification cooldown period

Add a cooldown period to !wqwatch function so multiple notifications for the same WQ item don't occur within a certain timeframe (max length of a WQ?).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.