Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

Command Documentation

Jump to bottom
Bion edited this page Jun 25, 2019 · 11 revisions

Who can execute commands?

  1. The as BotAdmin defined user can perform any command even without any permission in the database
  2. Any User that has the permission ExecuteCommands. Every User added to Database gets assigned to the Role "Default-User" by default, which contains the ExecuteCommands permission per default.

Any command requires at least the ExecuteCommands permission. You can exclude any users, except BotAdmin, from executing commands by revoking their ExecuteCommands permission.

If no Alias is mentioned the command doesn't have any aliases. If no Parameters is mentioned the command doesn't take any parameters.
If no Acceptance is mentioned the command is accepted in both private and public channels.
If no Requirements is mentioned the ExecuteCommands permission is the minimum requirement to execute it.

Definitions

Words defined here will be highlighted with bold and italic.
currentUser: The user who interacted with the bot using some of the bot commands below.
BotAdmin: The user who is defined to be the owner or administrator of the bot. Already used above.

Distinction

Role: A role that was assigned to a user or a group which gives them specific permissions for executing commands using the bot. Unrelated to discord roles.
Permission: A permission required for executing some command using the bot. Unrelated to discord permissions

Stats Commands

/nation

Status: supported since v2.3
Description: Returns an Embed with nation stats
Data: Category, Demonym2Plural, Flag, Fullname, Population, Region, Founded, LastActivity, Influence, WA-Status, Civil Rights, Economy, Political Freedom, EndorsementCount, Residency

/region

Status: supported since v2.4
Description: Returns an Embed with region stats
Data: Name, NumNations, Delegate, DelegateInfluence, DelegateEndorsementCount, Founder, Founded, Flag, Power, Tags

Management Commands

/status

Status: supported since v2.2
Description: Returns an Embed with current status information

/ping

Status: supported since v2.2
Description: Returns an Embed with current status information

/sleep

Status: supported since v2.1
Description: Sets the bot to nonreactive mode, for using production and development bots in parallel Parameters: none Requirements: BotAdmin only

/wakeup

Status: supported since v2.1
Description: Sets the bot into reactive mode, for using production and development bots in parallel Requirements: BotAdmin only

/shutdown

Status: supported since v2.0
Description: Shuts the bot down, stops recruitment, logs it out of discord and exits the application Requirements: BotAdmin only

Permission Commands

/checkUser

Status: supported since v2.0
Description: Returns permissions of a specified User
Parameters: string discordUserId
Requirements: ManagePermissions permission
Remarks: Response is only sent in private channel. If no private channel with currentUser exists one will be created. Planned:

  • Support of mentions
  • Returning roles currently assigned to that user
  • Showing the source of that permission

/checkPerm

Status: supported since v2.0
Description: Returns all users who have been explicitly granted a specified permission Parameters: int permissionId
Requirements: ManagePermissions permission
Remarks: Response is only sent in private channel. If no private channel with currentUser exists one will be created. Planned:

  • Support of permission names
  • Support of role permissions
  • Showing the source of that permission

/grantPermission

Status: supported since v2.0
Description: Explicitly grants a specified permission to a user.
Parameters: string discordUserId, int permissionId
Acceptance: in private channels only -> sending in public channels will cause the bot to delete the message and contact currentUser via a private channel.
Requirements: ManagePermissions permission
Remarks: Response is only sent in private channel. If no private channel with currentUser exists one will be created. Planned:

  • Support of mentions
  • Support of permission names
  • Grant of permissions to roles

Recruitment Commands

/refresh

Status: supported since v2.0 (changed in v2.5 to no paramters)
Description: Refresh the nation database for recruitment. Replies with the result of the action.
Parameters: (no parameters since v2.5) string type, can be 'all','rejected' or 'new' Requirements: AccessPending permission

/startRecruitment

Status: supported since v2.0
Description: Starts the recruitment process Requirements: ManagePermissions permission

/stopRecruitment

Status: supported since v2.0
Description: Stops the recruitment process Requirements: ManagePermissions permission

Clone this wiki locally