Status Role

Get started with status roles.

Feature: Customization & Control

Permissions

---

Introduction

You are able to specify time requirements (hours/minutes) for time-based roles, choose whether roles persist after status changes, and configure multiple roles per status string. The system also supports archiving configurations to temporarily disable them without deletion.

Parameters Table

Name	Description	Data Type
status-string	The status text to allow the app to check for.	string
type	The type of assignment for roles whether instant (instant addition of roles) or time-based (users are required to have the status for a set amount of time to receive roles).	options (instant, time-based)
type (2)	Opt for 'Inactive configurations' to remove setups that haven't been used for a specified period, keeping your active rules streamlined. Select 'Archived configurations only' to permanently delete settings you've previously marked for archived. For a complete reset, choose 'All configurations', which will wipe every custom status role setup from your server.	options (inactive, archived, all)
roles	The roles to assign (can be more than 1).	roles (mentions/roleIDs)
match-type	Whether to check for an exact match of the status string or to look for the status string in a user's status.	options (exact/contains)
hours	The amount of hours required for time-based roles.	integer
minutes	The amount of minutes required for time-based roles.	integer
keep-roles	Whether to keep the roles when a user receives it after they have removed a custom status.	boolean
remove-roles	Whether to remove the roles of users who have the currently configured status string when a status role configuration is being removed.	boolean
inactive-days	Days the status string has been inactive for.	integer

---

Status Role Setup

You may use /status setup for a quick and easy configuration.

Create a new status role configuration.

/status create (status-string) (type) (roles) [match-type] [hours] [minutes] [keep-roles]

Example Usage

Creation of a new status configuration

App assigning roles for status string

---

Checking Status Role Configurations

View all the status role configurations for the server

/settings

Example Usage

App showing all configurations for a status role

---

View a simple list of all the configured custom status roles

/status list

Example Usage

App showing a list of all configured status roles

---

Editing Status Role Configurations

Update existing status role configurations without recreating.

/status edit (status-string) [type] [roles] [match-type] [hours] [minutes] [keep-roles]

Example Usage

App editing configurations for a status string

---

Synchronizing Status Roles

Sync roles for users with matching statuses but missing status roles. Perfect for switching over to Status App or restoring roles when the app had downtime.

Confirmation is required for this action.

/status sync-roles [status-string]

Example Usage

App prompting the user to confirm role synchronization.

App declaring that the synchronization is complete

---

Removal of Status Role Configurations

Permanently remove a status role configuration

Confirmation is required for this action.

/status remove-status (status-string) (remove-roles)

Example Usage

App prompting the user to confirm their decision on removing status role configuration

App declaring that the deletion was approved and carried out successfully

---

Status Role Configurations Cleanup

This feature lets you identify and remove outdated settings for custom statuses that are no longer active, relevant, or simply aren't needed anymore. Maybe members stopped using a specific status string, or perhaps the roles linked to those configurations were deleted from your server.

Confirmation is required for this action.

/status cleanup (type2) [inactive-days] [remove-roles]

Example Usage

App prompting the user to confirm that they want to delete all their status configurations.

App showing that the user confirmed to deleting all the status configurations.

---

Advanced Configurations

You can temporarily disable your configurations without deleting them, using the archiving feature. This works hand-in-hand with robust permission management, allowing you to precisely control who can access status-based features.

With whitelist and blacklist management, you can easily define specific users or roles permitted to access these functionalities.

ArchivePermission Modes