Giter Club home page Giter Club logo

queen-spy's Introduction

Queen Spy Documentation

In short, Queen Spy manages the links between brawlhalla and discord accounts. This helps to see if there are currently people in the discord with the clan role that shouldn't have the clan role.

Table of Contents

Prefix

Both qs and Qs work.

How to use

First run qstatus, this gives you the current status of the clan and discord accounts. So what you should be doing is adding links between brawlhalla accounts and discord accounts. By adding links, they get removed from qstatus. Your goal is to make qstatus output nothing. I'll bring you through an example.

Examples

Force is a new member to our clan and joined our discord. qstatus / qsstatus shows us that his brawlhalla account isn't linked yet, also does it show his discord account isn't linked yet.

image

To solve this we add a link between his accounts using the qsadli command.

image

If we run qstatus now, you'll see it doesn't point out anyone to us. You can also run qslsli to see the link is added to the list of links.

image

This means everyone their brawlhalla account and discord account are linked. Now when a linked person leaves the clan and we run qstatus, Queen Spy will point out who left.

a player named Emma left the clan, when we run qstatus, Queen Spy points out an account that is linked but not in the clan anymore.

image

This means we can remove him from the discord and remove the link.

image

if we run qstatus now, it doesn't point out anything, meaning everything is solved.

image

If it ever shows a discord_id but not a brawlhalla_id this means someone is in the discord has the @Clan Member role who shouldn't have it.

image

To solve this we simply remove @Clan Member role from Queen Spy, if we run qstatus now its blank again.

List of commands

Command Logic

A command consists of 2 letters after each other multiple times.

Example 1

qsadli stands for

  • qs -> queen spy

  • ad -> add

  • li -> link

Example 2

qslsdc stands for

  • qs -> queen spy

  • ls -> list

  • dc -> discord

Multiple commands more than 1 command names. For example qsali / qsadli / qsaddli all do the same thing.

Get Status

qsstatus / qstatus gives you the current status of the brawlhalla accounts, discord accounts and links.

Add Link

qsadli / qsaddli / qsali creates a new link. Keep in mind that you have to provide parameters.

Example

qsadli brawlhalla_id discord_id

qsadli 7364605 413070742591373314

Bot will respond with

Are you sure you want to add the following link?

brawlhalla_id: 7364605
brawlhalla_name: CrossyChainsaw
discord_id: 413070742591373314
discord_name: CrossyChainsaw

Send y to confirm or n to cancel.

type y to confirm and n to cancel.

now type qslsli to get the list with links. You'll see the new link is added.

Pro tip: you can type the first 3 numbers instead of the whole ID. So instead of qsadli 7364605563 413070742591373314 you can also type qsadli 736 413

Remove Link

qsrmli brawlhalla_id with this command you can remove an existing link, just like adding a link, it will ask for confirmation. To see all brawlhalla ids of the links use the command qslsli.

Pro tip: you can type the first 4 numbers instead of the whole ID. So instead of qsrmli 7364605563 you can also type qsrmli 7364

Update Links

qsupli manually updates all links in the link list. Also does this command point out people who changed their name, see example below.

image

This command runs automatically when running qslsli

Update Clan

qsupcl manually updates clan data. This command automatically runs when running qslscl

Get Link List

qslsli shows a list of all current links between discord and brawlhalla. (This command automatically runs qsupli)

Get Name Changes

As if right now the command qslsli also shows all name changes. Here is an example.

image

Get Clan List

qslscl return a list of all clan members in game.

Get Discord List

qslsdc / qslsdi returns a list of everyone in the discord with the @Clan Member role.

Get Waiting List

qslsw / qslswa returns a list of everyone in the discord server with the @Waiting List role.

queen-spy's People

Contributors

crossychainsaw avatar

Watchers

Kostas Georgiou avatar  avatar

queen-spy's Issues

Make qstatus command more understandable

right now if you hit qstatus it gives this

image

it shows nothing cuz its empty, instead of showing empty lists it might be better to tell the user the list is empty in a different way.

Everyone can respond to command

When you have to type y or n anyone can type it, that shouldnt be possible. It should only check the response of the one who started the command.

Don't remove all user command messages

sometimes its usefull to see what the user input was for example
qsadli 10459663 239759577577553920

Rule of thumb: commands you will use in a bot trash channel shouldnt get removed. Commands you will use in public channels do remove command message.

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.