-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcurseforge-description.html
More file actions
259 lines (259 loc) · 18.5 KB
/
Copy pathcurseforge-description.html
File metadata and controls
259 lines (259 loc) · 18.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<h2><span style="color: rgb(91, 141, 239);">HyperEssentials</span> - Modular Server Essentials for Hytale</h2>
<p>Homes. Warps. Kits. Moderation. All in one plugin. <strong>HyperEssentials</strong> is a comprehensive, modular essentials suite built from the ground up for Hytale servers, with <span style="color: #5b8def;">10 independent modules</span>, <span style="color: #5b8def;">50+ commands</span>, and <span style="color: #5b8def;">deep integration</span> with the HyperSystems ecosystem.</p>
<p>Every module can be independently enabled or disabled. Every feature has an in-game GUI. Every string is localizable.</p>
<p> </p>
<h2><span style="color: #f0b232;">Why HyperEssentials?</span></h2>
<ul>
<li><strong><span style="color: #f0b232;">Fully Modular</span></strong> - 10 modules, each independently togglable. Only enable what your server needs.</li>
<li><strong><span style="color: #f0b232;">14 Interactive GUI Pages</span></strong> - 6 player pages + 8 admin pages. Browse homes, manage kits, moderate players, edit config — all from the GUI.</li>
<li><strong><span style="color: #f0b232;">10 Languages Built In</span></strong> - English, German, Spanish, French, Italian, Dutch, Polish, Portuguese, Russian, Filipino. Player language auto-detected.</li>
<li><strong><span style="color: #f0b232;">Faction-Aware</span></strong> - Territory restrictions on homes, warps, kits, and /back. Zone flag support via HyperFactions.</li>
<li><strong><span style="color: #f0b232;">Data Import</span></strong> - Migrating from EliteEssentials, EssentialsPlus, HyEssentialsX, or nhulston Essentials? One command imports your data.</li>
<li><strong><span style="color: #f0b232;">Active Development</span></strong> - Regular updates with community-driven features. Open source on GitHub.</li>
</ul>
<p> </p>
<h2><span style="color: #5b8def;">Modules</span></h2>
<table style="border-collapse: collapse; width: 88%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 15%; border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Module</th>
<th style="width: 55%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Features</th>
<th style="width: 10%; border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Homes</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Home CRUD, sharing, bed sync, faction territory restrictions, per-player limits</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Warps</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Warp CRUD, categories, custom permissions per warp, edit modal</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Spawns</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Per-world spawns, global spawn, auto-import from WorldConfig, respawn teleport</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Teleport</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">TPA requests, /back with source tracking, RTP with faction avoidance and cave detection</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Warmup</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Universal warmup/cooldown for all teleport actions, per-module timers, bypass permissions</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Kits</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Create from inventory (4 sections), cooldowns, one-time claims, preview, per-kit permissions</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Moderation</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Ban, mute, kick, warn, IP ban, freeze, vanish, punishment history</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Utility</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Heal, fly, god, AFK, stamina, repair, clear chat/inventory, near, playtime, and more</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Announcements</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Scheduled broadcasts, cron scheduling, event announcements (join/leave/first-join), CRUD</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Enabled</td>
</tr>
</tbody>
</table>
<p> </p>
<h2><span style="color: #5b8def;">Commands</span></h2>
<h3>Homes</h3>
<ul>
<li><code>/sethome [name]</code> — Set a home (faction territory restrictions apply)</li>
<li><code>/home [name]</code> — Teleport to a home with warmup</li>
<li><code>/delhome <name></code> — Delete a home</li>
<li><code>/homes</code> — List homes or open Homes GUI</li>
</ul>
<h3>Warps & Spawns</h3>
<ul>
<li><code>/warp <name></code>, <code>/setwarp</code>, <code>/delwarp</code>, <code>/warps</code>, <code>/warpinfo</code></li>
<li><code>/spawn [name]</code>, <code>/setspawn</code>, <code>/delspawn</code>, <code>/spawns</code>, <code>/spawninfo</code></li>
</ul>
<h3>Teleport</h3>
<ul>
<li><code>/tpa <player></code>, <code>/tpahere</code>, <code>/tpaccept</code>, <code>/tpdeny</code>, <code>/tpcancel</code>, <code>/tptoggle</code></li>
<li><code>/back</code> — Return to last location (with source tracking and territory checks)</li>
<li><code>/rtp</code> — Random teleport with faction avoidance and cave detection</li>
</ul>
<h3>Kits</h3>
<ul>
<li><code>/kit <name></code>, <code>/kits</code>, <code>/createkit</code>, <code>/deletekit</code>, <code>/previewkit</code></li>
</ul>
<h3>Moderation</h3>
<ul>
<li><code>/ban</code>, <code>/unban</code>, <code>/mute</code>, <code>/unmute</code>, <code>/kick</code>, <code>/warn</code> — Smart duration detection (e.g., <code>/ban player 7d griefing</code>)</li>
<li><code>/ipban</code>, <code>/ipunban</code> — IP-based bans with connect-time enforcement</li>
<li><code>/freeze</code>, <code>/vanish</code>, <code>/punishments</code></li>
</ul>
<h3>Utility</h3>
<ul>
<li><code>/heal</code>, <code>/fly</code>, <code>/god</code>, <code>/repair</code>, <code>/repairmax</code>, <code>/durability</code></li>
<li><code>/afk</code> — Manual toggle + auto-AFK with idle timeout</li>
<li><code>/stamina</code> — Infinite stamina toggle with periodic enforcement</li>
<li><code>/clearchat</code>, <code>/clearinventory</code>, <code>/near</code>, <code>/maxstack</code></li>
<li><code>/motd</code>, <code>/rules</code>, <code>/discord</code>, <code>/list</code>, <code>/playtime</code>, <code>/joindate</code></li>
<li><code>/sleeppercentage</code> — View/set sleep skip threshold</li>
</ul>
<h3>Announcements & Admin</h3>
<ul>
<li><code>/broadcast</code>, <code>/announce list|add|remove|reload</code></li>
<li><code>/he reload|version</code> — Admin commands</li>
<li><code>/he admin</code> — Open admin GUI</li>
<li><code>/essimport <plugin></code> — Import data from other essentials plugins</li>
</ul>
<p> </p>
<h2><span style="color: #c678dd;">GUI System</span></h2>
<h3>Player GUI (<code>/he</code>)</h3>
<ul>
<li><strong>Dashboard</strong> — Stat cards (homes, online players, TPA requests), quick actions, playtime</li>
<li><strong>Homes</strong> — Browse, teleport, delete with count/limit header</li>
<li><strong>Warps</strong> — Browse by category with headers, teleport with warmup</li>
<li><strong>Kits</strong> — Browse available kits, claim with cooldown display, preview items</li>
<li><strong>TPA</strong> — Incoming requests with per-entry accept/deny, toggle TPA on/off</li>
<li><strong>Stats</strong> — First joined, playtime, session time, status indicators (AFK, Fly, God)</li>
<li><strong>Settings</strong> — Language selector with auto-detect toggle</li>
</ul>
<h3>Admin GUI (<code>/he admin</code>)</h3>
<ul>
<li><strong>Dashboard</strong> — Online count, warp/spawn/kit stats, module status grid</li>
<li><strong>Warps</strong> — Full CRUD, sorted by category, create at current location</li>
<li><strong>Spawns</strong> — Full CRUD with default badge, create at current location</li>
<li><strong>Kits</strong> — Full CRUD with item count, cooldown, permissions, edit modal</li>
<li><strong>Players</strong> — Online player list with search, sort, and quick actions</li>
<li><strong>Moderation</strong> — Punishment list with active/all filter, revoke, type-colored badges</li>
<li><strong>Announcements</strong> — View messages, interval, sequential/random mode</li>
<li><strong>Config Editor</strong> — Edit all module configs in-game with validation and save/discard</li>
</ul>
<p> </p>
<h2><span style="color: #98c379;">Faction-Aware Features</span></h2>
<p>When <a href="https://www.curseforge.com/hytale/mods/hyperfactions" rel="nofollow">HyperFactions</a> is installed, HyperEssentials adds territory-aware restrictions:</p>
<ul>
<li><strong>Home placement</strong> — Per-relationship toggles: own territory, ally, enemy, neutral, wilderness</li>
<li><strong>Home teleport</strong> — Destination territory check before teleporting</li>
<li><strong>/back restrictions</strong> — Territory checks on back destinations with <code>ESSENTIALS_BACK</code> zone flag</li>
<li><strong>RTP avoidance</strong> — Random teleport avoids claimed chunks with configurable buffer radius</li>
<li><strong>Zone flags</strong> — HyperFactions zone flags for homes, warps, kits, and back</li>
<li><strong>Language sync</strong> — Bidirectional locale preference sync with HyperFactions</li>
</ul>
<p> </p>
<h2><span style="color: #61afef;">Localization</span></h2>
<ul>
<li><strong>10 languages</strong> built in: English, German, Spanish, French, Italian, Dutch, Polish, Portuguese, Russian, Filipino</li>
<li><strong>Player language auto-detection</strong> from client locale with per-player override via Settings GUI</li>
<li><strong>~500 translation keys</strong> covering all commands, GUI labels, admin messages, and error text</li>
</ul>
<p> </p>
<h2><span style="color: #56b6c2;">Admin Tools</span></h2>
<ul>
<li><strong>Full admin GUI</strong> with 8 dedicated pages and navigation</li>
<li><strong>In-game config editor</strong> — Edit all 13 module configs with toggles, steppers, and text inputs</li>
<li><strong>Admin bypass toggle</strong> — Enable/disable bypass permissions for staff members</li>
<li><strong>Data import</strong> — Migrate from 4 other essentials plugins with automatic backup</li>
<li><strong>Config hot-reload</strong> — <code>/he reload</code> reloads all configuration without restart</li>
<li><strong>Debug system</strong> — 12 debug categories individually togglable for targeted troubleshooting</li>
<li><strong>Sentry integration</strong> — Automated error tracking and reporting</li>
</ul>
<p> </p>
<h2><span style="color: #d19a66;">Data Import</span></h2>
<table style="border-collapse: collapse; width: 60%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Source Plugin</th>
<th style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">What’s Imported</th>
</tr>
</thead>
<tbody>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>EliteEssentials</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Homes, warps, spawns, kits</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>Essentials (nhulston)</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Homes, warps, spawns</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>EssentialsPlus</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Homes, warps, spawns, kits</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong>HyEssentialsX</strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Homes, warps, spawns, kits</td>
</tr>
</tbody>
</table>
<p> </p>
<h2><span style="color: #61afef;">Integrations</span></h2>
<p>All integrations use automatic detection and fail-open design. <span style="color: #b96ad9;">= Recommended</span></p>
<table style="border-collapse: collapse; width: 88%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Mod</th>
<th style="width: 12%; border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Category</th>
<th style="width: 71%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong><a href="https://www.curseforge.com/hytale/mods/hyperperms" rel="nofollow">HyperPerms</a></strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Permissions</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Permission resolution, quick-add warp/kit permissions to roles from admin GUI</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong><a href="https://www.curseforge.com/hytale/mods/hyperfactions" rel="nofollow">HyperFactions</a></strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Territory</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Home/warp/back territory restrictions, zone flags, faction home teleport, language sync</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong><a href="https://www.curseforge.com/hytale/mods/vaultunlocked" rel="nofollow">VaultUnlocked</a></strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Economy</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Economy integration via standard VaultUnlocked API</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong><a href="https://www.curseforge.com/hytale/mods/luckperms" rel="nofollow">LuckPerms</a></strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Permissions</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Permission provider fallback when HyperPerms is not installed</td>
</tr>
<tr>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;"><strong><a href="https://www.curseforge.com/hytale/mods/werchat" rel="nofollow">Werchat</a></strong></td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px; white-space: nowrap;">Chat</td>
<td style="border-color: rgb(52, 73, 94); padding: 6px 10px;">Chat delegation with priority-based handler detection</td>
</tr>
</tbody>
</table>
<p> </p>
<h2><span style="color: #56b6c2;">Configuration</span></h2>
<p>Split configuration with per-module config files — or edit everything in-game via the Config Editor GUI:</p>
<ul>
<li><code>config.json</code> — Core settings (prefix, colors, admin, storage)</li>
<li><code>config/homes.json</code> — Home limits, bed sync, faction restrictions</li>
<li><code>config/warps.json</code> — Warp categories and defaults</li>
<li><code>config/spawns.json</code> — Default spawn, join/respawn teleport</li>
<li><code>config/teleport.json</code> — TPA, /back, RTP settings</li>
<li><code>config/warmup.json</code> — Per-module warmup/cooldown timers</li>
<li><code>config/kits.json</code> — Default cooldown, one-time claims</li>
<li><code>config/moderation.json</code> — Default reasons, broadcasts, freeze, history</li>
<li><code>config/utility.json</code> — Per-command enable toggles, radius limits</li>
<li><code>config/announcements.json</code> — Interval, cron, event triggers, messages</li>
</ul>
<p> </p>
<h2><span style="color: #98c379;">Requirements</span></h2>
<ul>
<li>Hytale Server (latest release)</li>
<li>Java 25+</li>
</ul>
<p> </p>
<p><a href="https://discord.com/invite/aZaa5vcFYh" rel="nofollow">Join our Discord</a> | <a href="https://www.hypersystems.dev/plugins/hyperessentials/wiki" rel="nofollow">Documentation & Wiki</a> | <a href="https://github.com/HyperSystems-Development/HyperEssentials" rel="nofollow">GitHub</a></p>