UPC-3PO User Guide

[box]
[b]Admin[/b]
[list]
[*][b]Addrole[/b]: Assign a role to a user

Required Permissions: Manage Roles
Usage: /addrole {user} {role}

[*][b]Ban[/b]: Ban a user

Required Permissions: Ban Members
Usage: /ban {user} {optional: reason}

[*][b]Kick[/b]: Kick a user

Required Permissions: Kick Members
Usage: /kick {user} {optional: reason}

[*][b]Remrole[/b]: Remove a role from a user

Required Permissions: Manage Roles
Usage: /remrole {user} {role}

[*][b]Timeout[/b]: Mute a user

Required Permissions: Moderate Members
Usage: /timeout {user} {optional: reason} {optional: days} {optional: hours} {optional: minutes}

[*][b]Unban[/b]: Unban a user

Required Permissions: Ban Members
Usage: /unban {user ID}

[*][b]Untimeout[/b]: Unmute a user

Required Permissions: Moderate Members
Usage: /untimeout {user} {optional: reason}

[/list]
[/box]

[box]
[b]Config[/b]
[list]

[*][b]Channel[/b]: Set, view, or delete the server's welcome or log channel

Required Permissions: Manage Server
Usage: /channel {set/view/delete} {welcome/log} {optional: channel}

[*][b]Cog[/b]: Load or unload a set of commands in your server

Required Permissions: Manage Server
Usage: /cog {load/unload} {Admin/NS Info/Verification}

[*][b]Config[/b]: Open the UPC-3PO configuration menu. 

Required Permissions: Manage Server
Usage: /config

[*][b]Ping[/b]: Ping UPC-3PO 

Usage: /ping

[*][b]Prefix[/b]: Set or view UPC-3PO's command prefix

Required Permissions: Manage Server
Usage: /prefix {set/view} {optional: prefix}

[*][b]Role[/b]:  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}

[*][b]Server_region[/b]: Set, view, or delete the server's associated NS region

Required Permissions: Manage Server
Usage: /server_region {set/view/delete} {optional: region}

[*][b]Welcome_message[/b]: Set, view, or delete the server's welcome message

Required Permissions: Manage Server
Usage: /welcome_message {set/view/delete} {optional: message}

[/list]
[/box]

[box]
[b]NS Info[/b]
[list]
[*][b]Activity[/b]: Displays a graph showing login activity for nations in a region

Usage: /activity {region}

[*][b]Deck[/b]: Displays a graph showing the composition of a nation's Trading Card deck

Usage: /deck {nation}

[*][b]Endotart[/b]: Displays a list of World Assembly members in a region that a nation is not endorsing 

Usage: /endotart {nation}

[*][b]GA[/b]: Displays information about current and historical General Assembly resolutions

Usage: /ga {optional: resolution ID}

[*][b]Market[/b]: Displays information about current Trading Card auctions

Usage: /market

[*][b]Nation[/b]: Displays information about a non-CTE nation

Usage: /nation {nation}

[*][b]NNE[/b]: Displays a list of World Assembly members in a region that are not endorsing a nation

Usage: /nne {nation}

[*][b]Region[/b]: Displays information about a region

Usage: /region {region}

[*][b]S1[/b]: Displays information about a nation's Season 1 Trading Card

Usage: /s1 {nation}

[*][b]S2[/b]: Displays information about a nation's Season 2 Trading Card

Usage: /s2 {nation}

[*][b]SC[/b]: Displays information about current and historical Security Council resolutions

Usage: /sc {optional: resolution ID}

[/list]
[/box]

[box]
[b]Verification[/b]
[list]
[*][b]ID[/b]: Displays a list of a user's verified nations in this server

Usage: /id {user}

[*][b]Unverify[/b]: Removes a nation from a user's list of verified nations

Required Permissions: Moderate Members
Usage: /unverify {nation}

[*][b]Verify[/b]: Verify ownership of a nation. For more information, see Role Assignment

Usage: /verify

[/list]
[/box]

[box]
[b]Role Assignment[/b]

UPC-3PO can automatically assign roles to users via the nation verification process. Roles that can be applied are as follows:
[list]
[*]World Assembly Resident
[*]Resident
[*]Visitor
[*]Verified User
[/list]
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. 
[/box]
[box]
[b]Welcome Message Configuration[/b]

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:
[list]
[*]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}>
[/list]

Example:

[b]Input[/b]:

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!!

[b]Output[/b]:

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!!
[/box]