Skip to content

README.md

Latest commit

 

History

History
148 lines (141 loc) · 5.82 KB

README.md

File metadata and controls

148 lines (141 loc) · 5.82 KB
Raw

Turn a secondary Discord into a ban appeal server

[p]appealsfor

Get all appeal submissions for a specific user

  • Usage: [p]appealsfor <user>
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]viewappeal

View an appeal submission by ID

  • Usage: [p]viewappeal <submission_id>
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]appeal

Configure appeal server settings

  • Usage: [p]appeal
  • Restricted to: ADMIN
  • Aliases: appeals and appealset
  • Checks: server_only

[p]appeal view

View the current appeal server settings

  • Usage: [p]appeal view
  • Checks: ensure_db_connection

[p]appeal nukedb

Nuke the entire appeal database

  • Usage: [p]appeal nukedb <confirm>
  • Restricted to: BOT_OWNER
  • Checks: ensure_db_connection

[p]appeal addquestion

Add a question to the appeal form

  • Usage: [p]appeal addquestion <question>
  • Checks: ensure_db_connection

[p]appeal server

Set the server ID where users will be unbanned from

NOTES

  • This is the first step to setting up the appeal system
  • This server will be the appeal server
  • You must be the owner of the target server
  • Usage: [p]appeal server <server_id>
  • Restricted to: GUILD_OWNER
  • Checks: ensure_db_connection

[p]appeal editquestion

Edit a question in the appeal form

  • Usage: [p]appeal editquestion <question_id> <question>
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]appeal wipeappeals

Wipe all appeal submissions

  • Usage: [p]appeal wipeappeals <confirm>
  • Checks: ensure_db_connection

[p]appeal removequestion

Remove a question from the appeal form

  • Usage: [p]appeal removequestion <question_id>
  • Checks: ensure_db_connection

[p]appeal refresh

Refresh the appeal message with the current appeal form

  • Usage: [p]appeal refresh
  • Checks: ensure_db_connection

[p]appeal channel

Set the channel where submitted appeals will go

channel_type must be one of: pending, approved, denied

NOTE: All 3 channel types must be set for the appeal system to work properly.

  • Usage: [p]appeal channel <channel_type> <channel>
  • Checks: ensure_db_connection

[p]appeal sortorder

Set the sort order for a question in the appeal form

  • Usage: [p]appeal sortorder <question_id> <sort_order>
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]appeal approve

Approve an appeal submission by ID

  • Usage: [p]appeal approve <submission_id>
  • Checks: ensure_db_connection

[p]appeal questions

Menu to view questions in the appeal form

  • Usage: [p]appeal questions
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]appeal buttonstyle

Set the style of the appeal button

  • Usage: [p]appeal buttonstyle <style>
  • Checks: ensure_db_connection

[p]appeal createappealmessage

Quickly create and set a pre-baked appeal message in the specified channel

  • Usage: [p]appeal createappealmessage <channel>
  • Checks: ensure_db_connection

[p]appeal alertchannel

Set the channel ID where alerts for new appeals will be sent

This can be in either the appeal server or the target server.
Alert roles will not be pinged in this message.

  • Usage: [p]appeal alertchannel [channel]
  • Checks: ensure_db_connection

[p]appeal help

How to set up the appeal system

  • Usage: [p]appeal help
  • Aliases: info and setup
  • Checks: ensure_db_connection

[p]appeal deny

Deny an appeal submission by ID

  • Usage: [p]appeal deny <submission_id>
  • Checks: ensure_db_connection

[p]appeal questiondetails

Set specific data for a question in the appeal form

Arguments

  • required: Whether the question is required or not
  • modal_style: The style of the modal for the question
    • long: The modal will be a long text input
    • short: The modal will be a short text input
  • button_style: The color of the button for the question
    • primary🔵, secondary⚫, success🟢, danger🔴
  • placeholder: The placeholder text for the input
  • default: The default value for the input
  • max_length: The maximum length for the input
  • min_length: The minimum length for the input
  • Usage: [p]appeal questiondetails <question_id> <required> [modal_style=None] [button_style=None] [placeholder=None] [default=None] [max_length=None] [min_length=None]
  • Aliases: questiondata, setquestiondata, qd, and details
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]appeal listquestions

List all questions in the appeal form

Questions will be sorted by their sort order and then by creation date.

  • Usage: [p]appeal listquestions
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]appeal buttonlabel

Set the label of the appeal button

  • Usage: [p]appeal buttonlabel <label>
  • Checks: ensure_db_connection

[p]appeal appealmessage

Set the message where users will appeal from
Message format: channelID-messageID

  • Usage: [p]appeal appealmessage <message>
  • Checks: ensure_db_connection

[p]appeal alertrole

Add/Remove roles to be pinged when a new appeal is submitted
These roles will be pinged in the appeal server, NOT the target server.

  • Usage: [p]appeal alertrole <role>
  • Checks: ensure_db_connection

[p]appeal delete

Delete an appeal submission by ID

  • Usage: [p]appeal delete <submission_id>
  • Checks: ensure_db_connection

[p]appeal viewquestion

View a question in the appeal form

  • Usage: [p]appeal viewquestion <question_id>
  • Checks: ensure_appeal_system_ready and ensure_db_connection

[p]appeal buttonemoji

Set the emoji of the appeal button

  • Usage: [p]appeal buttonemoji [emoji=None]
  • Checks: ensure_db_connection