Skip to content

Commit 45ce1e3

Browse files
committed
docs: add and update enums
1 parent 40e5c7a commit 45ce1e3

1 file changed

Lines changed: 33 additions & 25 deletions

File tree

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,55 @@ Plugins for the Hexuscraft server on Minecraft Java Edition
66
77
## Enums
88

9-
> Enums are subject to change. Refer to the linked src file to confirm the list is up-to-date.
9+
### CheatSeverity
1010

11-
### PermissionGroup
11+
> - LOW
12+
> - MEDIUM
13+
> - HIGH
1214
13-
https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-core/src/net/hexuscraft/core/permission/PermissionGroup.java
15+
### CurrencyType
16+
17+
> - COIN
18+
> - XP
19+
20+
### GameType
21+
22+
> - SURVIVAL_GAMES
23+
> - MICRO_BATTLES
24+
> - SKYWARS
25+
26+
### PermissionGroup
1427

15-
> - QUALITY_ASSURANCE
16-
> - EVENT_MOD
17-
> - EVENT_LEAD
1828
> - MEMBER
1929
> - VIP
2030
> - MVP
2131
> - MEDIA
22-
> - BUILDER
23-
> - SENIOR_BUILDER
32+
> - BUILD_TEAM
33+
> - BUILD_LEAD
34+
> - DEV_TEAM
35+
> - DEV_LEAD
36+
> - EVENT_TEAM
37+
> - EVENT_LEAD
38+
> - MEDIA_TEAM
39+
> - MEDIA_LEAD
40+
> - QA_TEAM
41+
> - QA_LEAD
2442
> - TRAINEE
2543
> - MODERATOR
2644
> - SENIOR_MODERATOR
2745
> - ADMINISTRATOR
2846
2947
### PunishType
3048

31-
https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-core/src/net/hexuscraft/core/punish/PunishType.java
32-
33-
> - BAN
34-
> - MUTE
3549
> - WARNING
50+
> - KICK
51+
> - MUTE
52+
> - BAN
3653
3754
## Redis Keys
3855

39-
> Redis entries are subject to change. Refer to the linked src file to confirm the fields are up-to-date.
40-
4156
### Server Groups
4257

43-
https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-database/src/net/hexuscraft/database/serverdata/ServerGroupData.java
44-
4558
> **HASH** `servergroup:(String)`
4659
>
4760
> | Field | Type |
@@ -58,12 +71,10 @@ https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-database/src/
5871
> | worldEdit | **Boolean** |
5972
> | timeoutMillis | **Integer** |
6073
> | games | **String** (Game Enums split by commas) |
61-
> | hostUUID | **String** (UUID |
74+
> | hostUUID | **String** (Player UUID) |
6275
6376
### Servers
6477

65-
https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-database/src/net/hexuscraft/database/serverdata/ServerData.java
66-
6778
> **HASH** `server:(String)`
6879
>
6980
> | Field | Type |
@@ -84,8 +95,8 @@ https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-database/src/
8495
> If you have successfully set up the network and are looking to change your own rank, you can also execute the `/rank`
8596
> command from the console to make things a bit easier.
8697
>
87-
> Note that you must run this command from a notchian server running a Hexuscraft plugin. You cannot run this command on
88-
> the proxy or via servermonitor as of right now.
98+
> Note that you must run this command from a Notchian server running a HexusPlugin, such as Hub, Arcade, WebTranslator,
99+
> etc. You cannot run this command on Proxy or ServerMonitor.
89100
>
90101
> Refer to the PermissionGroup enum for a list of ranks.
91102
>
@@ -101,8 +112,6 @@ https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-database/src/
101112
102113
### Punishments
103114

104-
https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-core/src/net/hexuscraft/core/punish/PunishData.java
105-
106115
> **HASH** `punishment:(UUID)`
107116
>
108117
> *\* = required*
@@ -131,6 +140,5 @@ https://github.com/hexuscraft/hexuscraft-java/blob/main/hexuscraft-core/src/net/
131140
> **STRING** `motd`
132141
> - Changes the proxy's MOTD. Example:
133142
> ```
134-
> §r §r§9§m §r§8§m[ §r §r§6§lHexuscraft§r §6§lNetwork§r §8§m ]§r§9§m §r
135-
> §r §eMINI-GAMES, PRIVATE SERVERS, TOURNAMENTS§r
143+
> §eMINI-GAMES, PRIVATE SERVERS, TOURNAMENTS
136144
> ```

0 commit comments

Comments
 (0)