Skip to content

Commit 5aa1164

Browse files
committed
Added documentation for the role management system.
1 parent dbfd42b commit 5aa1164

6 files changed

+51
-1
lines changed

Writerside/dhub.tree

+1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
<toc-element topic="Carry-Type.md"/>
4545
<toc-element topic="Carry-Tier.md"/>
4646
<toc-element topic="Carry-Difficulty.md"/>
47+
<toc-element topic="Role-Action.md"/>
4748
<toc-element topic="Role-Group.md"/>
4849
<toc-element topic="Score-Type.md"/>
4950
<toc-element topic="Warning-Action.md"/>
44.3 KB
Loading
49.6 KB
Loading

Writerside/images/role-groups.png

46.1 KB
Loading

Writerside/topics/Role-Action.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Role Action ✏️
2+
3+
`Coming soon`
4+
5+
## Possible values
6+
7+
- None
8+
- Apply And Remove When Verified
9+
- Apply And Remove When Unverified
10+
- Apply When Verified
11+
- Apply When Unverified
12+
- Remove When Verified
13+
- Remove When Unverified
14+
- Apply Always

Writerside/topics/Role-Management.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
11
# Role Management ✏️
22

3-
`Coming soon`
3+
The Dungeon Hub Bot has multiple systems in place to aid with the assignment and management of roles. This guide will
4+
cover the various commands and features available to you as a server administrator.
5+
6+
## Role Actions
7+
8+
It is possible to set roles to automatically be applied to users based on a certain criteria.
9+
A list of all possible actions can be found [here](Role-Action.md#possible-values). \
10+
The role actions for all roles are checked on a user's roles are synced.
11+
12+
## Role Requirements
13+
14+
`This feature is currently under active development and will be released soon.`
15+
16+
## Role Groups
17+
18+
Role groups are a way to group roles together and apply them all at once. If the user has a specific role that has role
19+
groups, those are given to the user as well. \
20+
Role groups are applied after the role actions have been processed. \
21+
You can think of role groups similar to a tree structure:
22+
23+
### Structure
24+
25+
![](role-groups.png) { border-effect="rounded" }
26+
27+
You can also take a look at these two example use-cases:
28+
29+
### Examples { collapsible="true" }
30+
31+
![](role-groups-dh-carriers.png) { border-effect="rounded" }
32+
33+
This example ensures that all service team members have the general role `Service Team` and the carry-type specific roles, such as `Dungeon Carrier`. \
34+
This ensures that permissions can be set up for all service team members, while also allowing for specific permissions for each carry type. It also allows to easily ping all service team members at once, as well as it gives an easier overview over
35+
all service team members.
36+
37+
![](role-groups-dh-staff.png) { border-effect="rounded" }
38+

0 commit comments

Comments
 (0)