5
Dispatch → Meta → Reference
UPC-3PO User Guide
Admin
Addrole: Assign a role to a user
Required Permissions: Manage Roles
Usage: /addrole {user} {role}Ban: Ban a user
Required Permissions: Ban Members
Usage: /ban {user} {optional: reason}Kick: Kick a user
Required Permissions: Kick Members
Usage: /kick {user} {optional: reason}Remrole: Remove a role from a user
Required Permissions: Manage Roles
Usage: /remrole {user} {role}Timeout: Mute a user
Required Permissions: Moderate Members
Usage: /timeout {user} {optional: reason} {optional: days} {optional: hours} {optional: minutes}Unban: Unban a user
Required Permissions: Ban Members
Usage: /unban {user ID}Untimeout: Unmute a user
Required Permissions: Moderate Members
Usage: /untimeout {user} {optional: reason}
Config
Channel: Set, view, or delete the server's welcome or log channel
Required Permissions: Manage Server
Usage: /channel {set/view/delete} {welcome/log} {optional: channel}Cog: Load or unload a set of commands in your server
Required Permissions: Manage Server
Usage: /cog {load/unload} {Admin/NS Info/Verification}Config: Open the UPC-3PO configuration menu.
Required Permissions: Manage Server
Usage: /configPing: Ping UPC-3PO
Usage: /ping
Prefix: Set or view UPC-3PO's command prefix
Required Permissions: Manage Server
Usage: /prefix {set/view} {optional: prefix}Role: Set, view, or delete the server's automatic verification roles
Required Permissions: Manage Server
Usage: /role {set/view/delete} {WA Resident/Resident/Visitor/Verified} {optional: role}Server_region: Set, view, or delete the server's associated NS region
Required Permissions: Manage Server
Usage: /server_region {set/view/delete} {optional: region}Welcome_message: Set, view, or delete the server's welcome message
Required Permissions: Manage Server
Usage: /welcome_message {set/view/delete} {optional: message}
NS Info
Activity: Displays a graph showing login activity for nations in a region
Usage: /activity {region}
Deck: Displays a graph showing the composition of a nation's Trading Card deck
Usage: /deck {nation}
Endotart: Displays a list of World Assembly members in a region that a nation is not endorsing
Usage: /endotart {nation}
GA: Displays information about current and historical General Assembly resolutions
Usage: /ga {optional: resolution ID}
Market: Displays information about current Trading Card auctions
Usage: /market
Nation: Displays information about a non-CTE nation
Usage: /nation {nation}
NNE: Displays a list of World Assembly members in a region that are not endorsing a nation
Usage: /nne {nation}
Region: Displays information about a region
Usage: /region {region}
S1: Displays information about a nation's Season 1 Trading Card
Usage: /s1 {nation}
S2: Displays information about a nation's Season 2 Trading Card
Usage: /s2 {nation}
SC: Displays information about current and historical Security Council resolutions
Usage: /sc {optional: resolution ID}
Verification
ID: Displays a list of a user's verified nations in this server
Usage: /id {user}
Unverify: Removes a nation from a user's list of verified nations
Required Permissions: Moderate Members
Usage: /unverify {nation}Verify: Verify ownership of a nation. For more information, see Role Assignment
Usage: /verify
Role Assignment
UPC-3PO can automatically assign roles to users via the nation verification process. Roles that can be applied are as follows:
World Assembly Resident
Resident
Visitor
Verified User
The applied roles are determined by the residency and World Assembly status of the nation that the user verifies. If a Verified User role has been configured, it will be applied to the user regardless of which other roles are given. In order to fully utilize this feature, a server administrator will need to configure the above four roles and a server region, though some parts will work independently.
Welcome Message Configuration
The system for setting a welcome message is a bit rough at the moment. In order to set your message without errors, you will need to do the following:
Add <user> where you would like the bot to ping the new user
Replace newlines with a newline character (\n) (You don't need to do this if you're setting the message through the config menu)
Change role mentions to <@&{role id}> (does not apply to @here or @everyone)
Change user mentions to <@!{user id}>
Example:
Input:
Welcome to Arrakis, <user>!\nYou can start your journey here by typing "/verify" and following the on screen instructions.\nIf you have any questions, the <@&1022869075547922493> would be happy to help!!
Output:
Welcome to Arrakis, @upc!
You can start your journey here by typing "/verify" and following the on screen instructions.
If you have any questions, the @Welcome Squad would be happy to help!!