Difference between revisions of "Discord Bot"

From Silver Sun Republic Codex
(No difference)

Latest revision as of 00:27, 21 July 2020

Discord Bots

The Republic utilizes bots on Discord to automate processes and systems enhancing the overall capability and features of the community. Each bot has a different set of commands, some of which are reserved for admins, but others that are accessible to all members.

Minstrel Bot Commands

The Minstrel Bot uses Spotify, YouTube, and Soundcloud to search for songs. The best way to get exactly what song you want is to search YouTube and find a specific video title. Using that title will match the bot up with that specific video to stream the audio through itself.

Basic Minstrel Bot Commands

All commands use the $ prefix to differentiate them from other command systems

$play (Title or description of song you want to play) - adds song to the playlist

$skip - adds a vote to skip to the next song in the queue

$queue - lists the songs currently in the queue

$np - lists information about the song currently playing

$save - saves the current song to the auto playlist

$shuffle - Shuffles the queue.

$clear - Clears the queue.

$pause - Pauses the current media.

$resume - Resumes the current media

$volume [number] - Sets the volume of the bot for everyone. Should be a number between 1 and 100. Can be relative (e.g +10 to add 10 to current volume). If no parameter is given, it will display the current volume.

Other Minstrel Bot Commands

$summon - moves the bot to your current voice channel

$search [service] [#] <query> - Searches a specific service (default: YT) for a query and returns the first few results (default: 3, limit: 10). The user can then select from the results if they want to add any to the queue.

$restart - restarts the bot

Full Minstrel Bot Command Reference

Check out https://just-some-bots.github.io/MusicBot/using/commands/ for the full list of commands and other reference documentation.

Prefect Bot Commands

Currently, the Prefect Bot serves up most of the commands, but in the future these commands will be split between a Commerciante Bot and a Herald Bot for the appropriate tasks.

Users can issue the !prefect-help command to retrieve the list below.

Registration Commands

!register - Provides the Registration URL and checks if your account is registered successfully.

Branch/Chapter Commands

!joinBranch branchname - Adds the corresponding branch to your roles.

  • atlas for ATLAS Branch
  • lif for Life is Feudal Branch

!leaveBranch branchname - Removes the corresponding branch from your roles.

  • atlas for ATLAS Branch
  • lif for Life is Feudal Branch

Banking Commands

  • only works in #bank-of-soacio channel

!transfer-funds amount type[gold, silver, bronze] @mention - transfers funds to @mention

!funds-balance - DMs you your current balances

!buy-currency amount type[gold, silver, bronze] - buys "up" meaning buys gold with silver, silver with bronze

!sell-currency amount type[gold, silver, bronze] - sells "down" meaning sells gold for silver, silver for bronze

!exchange-rate - lists current exchange rates of currency in effect

Banking Admin Commands

!deduct-funds amount type[gold, silver, bronze] @mention - deducts funds from @mention

!deposit-funds amount type[gold, silver, bronze] @mention - deposits funds for @mention

!set-rate type[gold, silver, bronze] rate - modifies the exchange rate by type

Redeeming Premium Currency Commands

!redeem-list - DMs the current list of redeemable items and their costs

!redeem-funds item - redeems items from the items list and deducts their cost in gold (will prompt in DM for confirmation)

Contracting Commands

  • only works in #bank-of-soacio channel

!contract-open item/service units price[per unit] currency - opens a contract with item/service, number of units, price per unit, and currency to pay out

!contract-award contractID @mention - awards contract to @mention target

!contract-payout contractID increment[50, 100] - pays out contract total as a percentage, 50 or 100 percent

!contract-close contractID - closes out the contract and pays out any remaining award funds

!contract-status contractID - returns basic info about contract by ID

!contracts - DMs list of current contracts open and awarded by ID

Market Commands

  • only works in #bank-of-soacio channel

!market-order orderType[buy, sell] item units price currency description - lists a market order by buy or sell type with a free text description

!market-close marketID @mention - closes out the market order and pays or withdraws funds from the @mention

!market-search orderType[buy, sell] searchTerm - looks up a market order by type and term

!market-status marketID - shares the details of a market order by ID

Award Commands

!nominate @mention - nominates the mentioned person for an award; asks a series of questions to fill out the nomination

!nominate-review awardID - allows a Minister or admin to review an award and approve or deny it; automatically adds award to court business

!list-nominations @mention - allows a Minister or admin to retrieve the list of nominations for an individual

!presented-award awardID - updates the award status for a recipient to presented

Court Commands

!add-to-court recipient freeText - adds business to the court herald list

!hold-court - iterates through pending business for a text held court

For any questions or assistance please contact Duke Bernardo