-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcurseforge-description.html
More file actions
552 lines (551 loc) · 42.5 KB
/
Copy pathcurseforge-description.html
File metadata and controls
552 lines (551 loc) · 42.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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
<h2>⚔️<span style="color: rgb(91, 141, 239);">HyperFactions</span> - The Complete Faction System for Hytale</h2>
<p>Build empires. Claim territory. Forge alliances. Wage war. <strong>HyperFactions</strong> is a full-featured faction management system built from the ground up for Hytale servers, with an emphasis on <span style="color: #5b8def;">polished GUIs</span>, <span style="color: #5b8def;">deep configurability</span>, and <span style="color: #5b8def;">seamless integration</span> with the HyperSystems ecosystem.</p>
<p>Everything is accessible through an intuitive in-game GUI (<code>/f</code>) or commands. No wiki required to get started.</p>
<p>💬 <a href="https://discord.com/invite/aZaa5vcFYh" rel="nofollow">Join our Discord</a> | 📖 <a href="https://www.hypersystems.dev/plugins/hyperfactions/wiki" rel="nofollow">Documentation & Wiki</a> | 🔗 <a href="https://github.com/HyperSystems-Development/HyperFactions" rel="nofollow">GitHub</a></p>
<p> </p>
<h2>✨ Why HyperFactions?</h2>
<ul>
<li><strong><span style="color: #f0b232;">70+ Interactive GUI Pages</span></strong> - Every feature has a polished, interactive GUI. No command memorization needed.</li>
<li><strong><span style="color: #f0b232;">Real-Time GUI Updates</span></strong> - When a member joins, a chunk is claimed, or a relation changes, every open GUI refreshes automatically.</li>
<li><strong><span style="color: #f0b232;">51 Zone Flags</span></strong> - The most granular territory protection available, from PvP and granular friendly fire to mob spawning, transport control, and F-key pickup.</li>
<li><strong><span style="color: #f0b232;">Data Import</span></strong> - Migrating from ElbaphFactions, HyFactions, SimpleClaims, or FactionsX? One command imports your factions, claims, and relations.</li>
<li><strong><span style="color: #f0b232;">Deep Configurability</span></strong> - 11 modular config files covering every aspect of gameplay. Tune it to your server's style.</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: #f0b232;">🆕 What's New in v0.12.0</span></h2>
<ul>
<li><strong><span style="color: #61afef;">Built-in Localization (i18n)</span></strong> - 10 languages out of the box: English, German, Spanish, French, Italian, Dutch, Polish, Portuguese, Russian, Filipino. Player language auto-detection with configurable default.</li>
<li><strong><span style="color: #61afef;">Admin GUI: Config Editor</span></strong> - Edit all HyperFactions settings in-game with 11 tabs, size-adaptive layouts, boolean toggles, steppers, color pickers, dropdowns, and input validation</li>
<li><strong><span style="color: #61afef;">Admin GUI: Backup Manager</span></strong> - Paginated backup list with create, restore, and delete operations, plus type filtering</li>
<li><strong><span style="color: #61afef;">Admin GUI: Updates Page</span></strong> - Check for HyperFactions and HyperProtect-Mixin updates, download, and rollback — all from the GUI</li>
<li><strong><span style="color: #61afef;">SimpleClaims & FactionsX Importers</span></strong> - Two new data importers: migrate from SimpleClaims (SQLite or JSON) or FactionsX with full claim, member, and relation import</li>
<li><strong><span style="color: #61afef;">BetterMap Compatibility</span></strong> - Per-world WorldMap enable/disable config, claims and zones render correctly on BetterMap-managed worlds</li>
<li><strong><span style="color: #61afef;">Ocean Claim Visibility Fix</span></strong> - Faction claims in water/ocean are now clearly visible on the world map</li>
</ul>
<p> </p>
<h2><span style="color: #5b8def;">🏰 Core Features</span></h2>
<h3>👥 Faction Management</h3>
<ul>
<li><strong>Create factions</strong> with custom names, tags, colors, and descriptions</li>
<li><strong>Three-tier role hierarchy</strong> - Leader, Officer, Member with granular permissions per role</li>
<li><strong>Territory permissions</strong> - Configure break, place, and interact access for outsiders, allies, and members independently. Server owners can <span style="color: #e06c75;">lock specific permissions</span> in <code>faction-permissions.json</code> to enforce server-wide rules that factions cannot override.</li>
<li><strong>Invite system</strong> with expiring invitations and join requests for closed factions</li>
<li><strong>Leadership transfer</strong> with automatic succession when leaders leave</li>
<li><strong>Disband confirmation</strong> to prevent accidental faction deletion</li>
<li><strong>Faction browser</strong> - Search and sort all factions, view details, and request to join</li>
<li><strong>Activity logs</strong> - Track all faction events with timestamps</li>
</ul>
<h3>🗺️ Territory & Claiming</h3>
<ul>
<li><strong>Chunk-based claiming</strong> with interactive GUI map (click to claim/unclaim)</li>
<li><strong>Terrain map mode</strong> - See actual terrain imagery behind claim overlays for easy orientation</li>
<li><strong>World map integration</strong> - See all claims colored by faction on Hytale's world map (press M)</li>
<li><strong>Power-based claim limits</strong> - More members means more territory</li>
<li><strong>Overclaiming</strong> - Capture enemy territory when their power hits zero</li>
<li><strong>Claim decay</strong> - Inactive factions automatically lose claims after a configurable period</li>
<li><strong>5 world map refresh modes</strong> - From proximity-based to manual, pick what works for your server</li>
<li><strong>Configurable map display</strong> - Toggle faction tags, player markers, and non-faction player visibility</li>
</ul>
<h3>⚡ Dynamic Power System</h3>
<ul>
<li><strong>Personal power</strong> per player (configurable cap, default 20)</li>
<li><strong>Automatic regeneration</strong> at configurable intervals</li>
<li><strong>Power loss on death</strong> detected via Hytale's ECS system, with separate toggles for PvP, mob, and environmental deaths</li>
<li><strong>Configurable power cost per claim</strong> (default: 2 power per chunk)</li>
<li><strong>No power loss in WarZones</strong> - Fight freely in designated PvP arenas</li>
<li><strong>Neutral kill penalty</strong> - Configurable power loss for attacking neutral players</li>
<li><strong>Combat logout penalty</strong> - Separate configurable power loss for logging out during combat</li>
</ul>
<h3>🤝 Diplomatic Relations</h3>
<ul>
<li>💚 <strong><span style="color: #98c379;">Alliances</span></strong> - Mutual protection, shared land access, no friendly fire</li>
<li>❤️ <strong><span style="color: #e06c75;">Enemies</span></strong> - Full PvP enabled, overclaiming unlocked</li>
<li>🤍 <strong><span style="color: #abb2bf;">Neutrals</span></strong> - PvP enabled with power penalties for aggression</li>
<li><strong>GUI-based diplomacy</strong> - Browse factions, send ally/enemy/neutral requests from the GUI</li>
<li><strong>Relation-based chat colors</strong> - <span style="color: #98c379;">Green</span> (same faction), <span style="color: #c678dd;">pink</span> (ally), <span style="color: #e06c75;">red</span> (enemy), <span style="color: #abb2bf;">gray</span> (neutral) in public chat</li>
</ul>
<h3>⚔️ Combat System</h3>
<ul>
<li><strong>Combat tagging</strong> - Prevents logout exploitation (configurable duration, default 15s)</li>
<li><strong>Spawn protection</strong> - Configurable invulnerability after respawn</li>
<li><strong>Relationship-based PvP</strong> - Allies protected, enemies open, configurable per zone</li>
<li><strong>Overclaim defender alerts</strong> - Faction members get real-time alerts when territory is being taken</li>
</ul>
<h3>💰 Faction Economy</h3>
<ul>
<li><strong>Faction treasury</strong> with deposits, withdrawals, inter-faction transfers, and transaction history</li>
<li><strong>Upkeep system</strong> - Automated territory maintenance costs with flat or progressive tiered pricing, grace periods, and auto-pay</li>
<li><strong>VaultUnlocked integration</strong> - Works with any economy plugin via the standard economy API</li>
</ul>
<h3>🌍 Localization</h3>
<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> with configurable default and per-player override</li>
<li><strong>~467 translation entries</strong> per locale covering all commands, GUI labels, and help content</li>
</ul>
<p> </p>
<h2><span style="color: #e06c75;">🛡️ Protection System</span></h2>
<p>HyperFactions provides comprehensive territory protection with <strong><span style="color: #f0b232;">51 configurable zone flags</span></strong> organized into 10 categories:</p>
<ul>
<li>⚔️ <strong><span style="color: #e06c75;">Combat (7)</span></strong> - PvP, friendly fire (per-faction/per-ally), projectile damage, PvE damage, mob damage</li>
<li>🧱 <strong><span style="color: #d19a66;">Building (4)</span></strong> - Build allowed, block place <em>(mixin)</em>, hammer use <em>(mixin)</em>, builder tools <em>(mixin)</em></li>
<li>🚪 <strong><span style="color: #61afef;">Interaction (13)</span></strong> - Block interaction, doors, containers, crafting, processing, seats, light use, NPC use/tame/interact, mount use, crate pickup/place</li>
<li>🎒 <strong><span style="color: #c678dd;">Items (4)</span></strong> - Item drop, auto pickup, F-key pickup <em>(mixin)</em>, invincible items <em>(mixin)</em></li>
<li>🐾 <strong><span style="color: #98c379;">Spawning (5)</span></strong> - Mob spawning (master), hostile/passive/neutral mobs, NPC spawning</li>
<li>🧹 <strong><span style="color: #56b6c2;">Mob Clearing (4)</span></strong> - Mob clear (master), hostile/passive/neutral mob clearing</li>
<li>💀 <strong><span style="color: #abb2bf;">Death (2)</span></strong> - Keep inventory <em>(mixin)</em>, power loss</li>
<li>💥 <strong><span style="color: #e5c07b;">Damage (4)</span></strong> - Fall damage, environmental damage, explosion damage <em>(mixin)</em>, fire spread <em>(mixin)</em></li>
<li>🚀 <strong><span style="color: #56b6c2;">Transport (3)</span></strong> - Teleporter use <em>(mixin)</em>, portal use <em>(mixin)</em>, mount entry</li>
<li>🔗 <strong><span style="color: #d19a66;">Integration (5)</span></strong> - Gravestone access, show on map, essentials homes, essentials warps, essentials kits</li>
</ul>
<p> </p>
<h2><span style="color: #98c379;">🏟️ SafeZones</span> & <span style="color: #e06c75;">WarZones</span></h2>
<p>Admins can designate special zones with independent flag configurations:</p>
<ul>
<li>🟢 <strong><span style="color: #98c379;">SafeZones</span></strong> - No PvP, no mob spawning, keep inventory on death. Perfect for spawn areas and markets.</li>
<li>🔴 <strong><span style="color: #e06c75;">WarZones</span></strong> - Full PvP with no power loss on death. Ideal for arenas and events.</li>
<li><strong>Visual map indicators</strong> - SafeZones appear <span style="color: #56b6c2;">teal</span>, WarZones appear <span style="color: #c678dd;">purple</span> on all maps</li>
<li><strong>Per-flag customization</strong> - Override any default on a per-zone basis</li>
<li><strong>Mob spawn control</strong> - Integrated with Hytale's native spawn suppression system for reliable mob blocking</li>
<li><strong>Zone creation wizard</strong> - Create zones by claiming single chunks, circular radius, square radius, or using the visual map</li>
</ul>
<p> </p>
<h2><span style="color: #61afef;">💬 Faction & Alliance Chat</span></h2>
<ul>
<li><strong>Toggle mode</strong> - <code>/f c</code> cycles between Public, Faction, and Ally chat</li>
<li><strong>Direct set</strong> - <code>/f c f</code> for faction, <code>/f c a</code> for ally, <code>/f c off</code> for public</li>
<li><strong>Chat history GUI</strong> - Browse past faction and ally messages in a dedicated GUI page with tabs</li>
<li><strong>Custom formatting</strong> - Configurable colors and prefixes for each channel</li>
<li><strong>Secure messaging</strong> - Only faction/allied members can see private messages</li>
<li><strong>Persistent history</strong> - Chat messages saved to disk, viewable even after restart</li>
</ul>
<p> </p>
<h2><span style="color: #d19a66;">📢 Server-Wide Announcements</span></h2>
<p>Major faction events are broadcast to all online players with configurable toggles:</p>
<ul>
<li>Faction created / disbanded</li>
<li>Leadership transferred</li>
<li>Territory overclaimed</li>
<li>War declared</li>
<li>Alliance formed / broken</li>
</ul>
<p>Each event type can be individually enabled or disabled in <code>announcements.json</code>.</p>
<p> </p>
<h2><span style="color: #c678dd;">🖥️ Full GUI System</span></h2>
<p>HyperFactions features <strong><span style="color: #f0b232;">70+ interactive GUI pages</span></strong> covering every aspect of gameplay:</p>
<h3>🎮 Player GUI (<code>/f</code>)</h3>
<ul>
<li><strong>Dashboard</strong> - Power, claims, members, relations, status, and invites at a glance</li>
<li><strong>Territory Map</strong> - Interactive chunk map with click-to-claim and visual legend</li>
<li><strong>Members</strong> - Expandable member list with promote, demote, kick, and transfer actions</li>
<li><strong>Relations</strong> - Browse factions and manage diplomacy with ally/enemy/neutral buttons</li>
<li><strong>Settings</strong> - Two-column settings page with faction details, territory permissions, mob spawning controls, and appearance editing</li>
<li><strong>Chat History</strong> - Faction and ally chat logs with tab switching</li>
<li><strong>Invites</strong> - Manage sent invitations and incoming join requests</li>
<li><strong>Logs</strong> - View faction activity history</li>
<li><strong>Treasury</strong> - Manage faction funds with deposits, withdrawals, transfers, and transaction history</li>
<li><strong>Player Info</strong> - View any player's faction membership, power stats, combat record, and history</li>
<li><strong>Help</strong> - Guide-first Help Center with 7 categories, sidebar navigation, and verified command reference</li>
</ul>
<h3>🆕 New Player GUI</h3>
<ul>
<li><strong>Faction Browser</strong> - Search, sort, and view all server factions</li>
<li><strong>Create Faction Wizard</strong> - Single-page creation with preview, color picker, and permission defaults</li>
<li><strong>World Map</strong> - See claimed territory before joining a faction</li>
</ul>
<h3>🔐 Admin GUI (<code>/f admin</code>)</h3>
<ul>
<li><strong>Dashboard</strong> - Server statistics overview</li>
<li><strong>Faction Management</strong> - Browse, edit, and delete any faction</li>
<li><strong>Zone Management</strong> - Create, configure, and map SafeZones and WarZones</li>
<li><strong>Configuration</strong> - Runtime settings adjustment</li>
<li><strong>Players</strong> - Browse all players with search, sort, power stats, and quick actions</li>
<li><strong>Economy</strong> - Server economy overview, per-faction treasury adjustment, sortable faction balance list</li>
<li><strong>Power Management</strong> - Set, adjust, reset player power with bypass toggles and bulk operations</li>
<li><strong>Activity Log</strong> - Server-wide faction activity browser with type, player, and time filters</li>
<li><strong>Version Info</strong> - Mod version, server version, and integration status for all 12 supported mods</li>
<li><strong>Actions</strong> - Global quick actions (K/D reset, bulk operations)</li>
<li><strong>Zone Properties</strong> - Consolidated zone name, type, and notification editing</li>
<li><strong>Backups</strong> - Backup management and restore</li>
<li><strong>Updates</strong> - Check and install updates from within the game</li>
</ul>
<h3>🧠 Smart GUI Behavior</h3>
<ul>
<li><strong>Permission-based filtering</strong> - Buttons and nav tabs automatically hide when the player lacks permission</li>
<li><strong>Real-time updates</strong> - All open GUIs refresh instantly when data changes</li>
<li><strong>Role-based visibility</strong> - Officers and leaders see management options; members see read-only views</li>
</ul>
<p> </p>
<h2><span style="color: #56b6c2;">🔧 Admin Tools</span></h2>
<ul>
<li><strong>Full admin GUI</strong> with dedicated navigation and management pages</li>
<li><strong>Bypass mode</strong> - Toggle admin bypass to modify any territory</li>
<li><strong>Automatic backups</strong> - Configurable backup schedule with retention rotation</li>
<li><strong>Pre-update backups</strong> - Data automatically backed up before installing updates</li>
<li><strong>Rollback support</strong> - <code>/f admin rollback</code> reverts to the previous version before restart</li>
<li><strong>Debug system</strong> - Toggle 7+ debug categories individually for targeted troubleshooting</li>
<li><strong>Claim decay management</strong> - Monitor and manually trigger inactive faction cleanup</li>
<li><strong>Data import</strong> - Migrate from ElbaphFactions, HyFactions, SimpleClaims, or FactionsX with validation reports</li>
<li><strong>Power management</strong> - Per-player power set, adjust, reset, bypass toggles, and bulk faction operations</li>
<li><strong>Economy management</strong> - Server-wide treasury overview, per-faction balance adjustment</li>
<li><strong>Player browser</strong> - Search and manage all server players with sort and quick actions</li>
<li><strong>Config hot-reload</strong> - <code>/f admin reload</code> reloads all configuration without restart</li>
<li><strong>Persistent admin bypass</strong> - Admin bypass state survives server restarts</li>
<li><strong>Version info</strong> - <code>/f admin version</code> to check mod version and integration status</li>
</ul>
<p> </p>
<h2><span style="color: #98c379;">📊 PlaceholderAPI Support</span></h2>
<p>HyperFactions provides <strong><span style="color: #f0b232;">49 placeholders</span></strong> for both PlaceholderAPI (PAPI) and WiFlow PlaceholderAPI, covering:</p>
<ul>
<li>Faction info (name, tag, description, color, member count)</li>
<li>Player role and status (rank, is_owner, is_officer, has_faction)</li>
<li>Power data (player power, max power, faction power, percentage)</li>
<li>Territory data (claims, max claims, territory owner, territory type)</li>
<li>Home coordinates and status</li>
<li>Relation counts and config values</li>
</ul>
<p>Use with any scoreboard, hologram, or menu plugin that supports PAPI or WiFlow.</p>
<p> </p>
<h2><span style="color: #61afef;">🔌 Integrations</span></h2>
<p>All integrations use automatic detection and fail-open design. <span style="color: #61afef;">⭐ <span style="color: #b96ad9;">= Recommended</span></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;">Mod</th>
<th style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Category</th>
<th style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;">⭐ <strong><a href="https://www.curseforge.com/hytale/mods/hyperperms" rel="nofollow">HyperPerms</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Permissions</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Faction chat prefixes, rank display, and contextual permissions</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/luckperms" rel="nofollow">LuckPerms</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Permissions</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Granular permission control</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;">⭐ <strong><a href="https://www.curseforge.com/hytale/mods/vaultunlocked" rel="nofollow">VaultUnlocked</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Economy</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Chat, economy, and permission compatibility layer</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;">⭐ <strong><a href="https://www.curseforge.com/hytale/bootstrap/hyperprotect-mixin" rel="nofollow">HyperProtect-Mixin</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Protection</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">28 mixin hooks — F-key pickup, keep inventory, explosions, fire, fluid, transport, mount, barter, projectile, map markers, and more</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/orbisguard-mixins" rel="nofollow">OrbisGuard-Mixins</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Protection</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">11 mixin hooks (alternative). Both can run simultaneously — auto-detected</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/orbisguard" rel="nofollow">OrbisGuard</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Regions</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Blocks claims in OG regions, renders OG regions on world map and territory GUI</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;">⭐ <strong><a href="https://www.curseforge.com/hytale/mods/placeholder-api" rel="nofollow">PlaceholderAPI</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Placeholders</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">49 placeholders for scoreboards, chat, and menus</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/wiflows-placeholderapi" rel="nofollow">WiFlow PlaceholderAPI</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Placeholders</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">47 placeholders in WiFlow format</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;">⭐ <strong><a href="https://www.curseforge.com/hytale/mods/hybounty" rel="nofollow">HyBounty</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Gameplay</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Player bounties with faction-aware protections against abuse</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/gravestones" rel="nofollow">Gravestones</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Gameplay</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Faction-aware gravestone protection, per-zone access, death location announcements</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/ecotale" rel="nofollow">Ecotale</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Economy</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Faction treasury via VaultUnlocked — deposits, withdrawals, transfers, admin tools</td>
</tr>
<tr>
<td style="width: 17%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/kyuubisoft-core" rel="nofollow">KyuubiSoft Core</a></strong></td>
<td style="width: 9%; border-color: rgb(52, 73, 94); padding: 6px 10px;">NPC</td>
<td style="width: 74%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Citizen NPC zone protection with auto-detection</td>
</tr>
</tbody>
</table>
<h3> </h3>
<h3>📦 Data Import</h3>
<table style="border-collapse: collapse; width: 44%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 25%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Source</th>
<th style="width: 75%; border-color: rgb(52, 73, 94); padding: 6px 10px;">What’s Imported</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width: 25%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong>ElbaphFactions</strong></td>
<td style="width: 75%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Factions, members, claims, relations, and zones</td>
</tr>
<tr>
<td style="width: 25%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong>HyFactions</strong></td>
<td style="width: 75%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Factions, members, claims, relations, zones, and power</td>
</tr>
<tr>
<td style="width: 25%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong>SimpleClaims</strong></td>
<td style="width: 75%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Parties, claims (SQLite or JSON), and mutual alliances</td>
</tr>
<tr>
<td style="width: 25%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong>FactionsX</strong></td>
<td style="width: 75%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Factions, claims, zones, player power, and per-role permissions</td>
</tr>
</tbody>
</table>
<h3> </h3>
<h3>🔮 Upcoming Integrations</h3>
<table style="border-collapse: collapse; width: 44%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Mod</th>
<th style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Status</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/rpg-leveling-and-stats" rel="nofollow">RPG Leveling</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><span style="color: #e5c07b;">Planned</span> — Faction bonuses and level-based perks</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/npc-dialog" rel="nofollow">NPC Dialog</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><span style="color: #e5c07b;">Planned</span> — Faction NPCs and dialog in claimed territory</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/npc-dialog-npc-quests-maker" rel="nofollow">NPC Quests Maker</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><span style="color: #e5c07b;">Planned</span> — Faction quests and mission systems</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><strong><a href="https://www.curseforge.com/hytale/mods/better-scoreboard" rel="nofollow">BetterScoreBoard</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><span style="color: #abb2bf;">Waiting</span> — Needs PlaceholderAPI or WiFlow support</td>
</tr>
</tbody>
</table>
<p>💡 <strong>Want HyperFactions to integrate with your plugin?</strong> Reach out to <strong>DMehaffy</strong> on <a href="https://discord.com/invite/aZaa5vcFYh" rel="nofollow">Discord</a> to discuss integration opportunities.</p>
<p> </p>
<h2><span style="color: #5b8def;">📥 Installation</span></h2>
<h3>Basic Install</h3>
<ol>
<li>Drop <code>HyperFactions.jar</code> into your <code>mods/</code> folder</li>
<li>Start your server</li>
<li>Type <code>/f</code> to open the GUI</li>
</ol>
<h3> </h3>
<h3>For Full Protection (Recommended)</h3>
<ol>
<li>Create an <code>earlyplugins/</code> folder in your server directory</li>
<li>Place <a href="https://www.curseforge.com/hytale/mods/hyxin" rel="nofollow">Hyxin</a> and <a href="https://www.curseforge.com/hytale/bootstrap/hyperprotect-mixin" rel="nofollow">HyperProtect-Mixin</a> JARs in <code>earlyplugins/</code> (NOT mods/)</li>
<li>Add the <code>--accept-early-plugins</code> flag to your server start script:</li>
</ol>
<p> </p>
<p><strong>Linux:</strong></p>
<pre>DEFAULT_ARGS="--accept-early-plugins --assets ../Assets.zip --backup --backup-dir backups --backup-frequency 30"</pre>
<p><strong>Windows:</strong></p>
<pre>set DEFAULT_ARGS=--accept-early-plugins --assets ../Assets.zip --backup --backup-dir backups --backup-frequency 30</pre>
<p><span style="color: #e03e2d;"><strong><em>HyperFactions works without a mixin system, but 11 zone flags (explosion, fire, block placement, transport, keep inventory, etc.) require <a style="color: #e03e2d;" href="https://www.curseforge.com/hytale/bootstrap/hyperprotect-mixin" rel="nofollow">HyperProtect-Mixin</a> or <a style="color: #e03e2d;" href="https://www.curseforge.com/hytale/mods/orbisguard-mixins" rel="nofollow">OrbisGuard-Mixins</a>.</em></strong></span></p>
<p><span style="color: #98c379;"><strong>💡 Tip:</strong> HyperFactions can auto-download HyperProtect-Mixin for you! Enable <code>autoDownload</code> in config or run <code>/f admin update mixin</code> in-game.</span></p>
<h3>🚀 Quick Start</h3>
<p><strong>1. Grant permissions</strong> (with <a href="https://www.curseforge.com/hytale/mods/hyperperms" rel="nofollow">HyperPerms</a>):</p>
<pre>/hp group setperm default hyperfactions.use
/hp group setperm default hyperfactions.faction.*
/hp group setperm default hyperfactions.member.*
/hp group setperm default hyperfactions.territory.*
/hp group setperm default hyperfactions.teleport.*
/hp group setperm default hyperfactions.relation.*
/hp group setperm default hyperfactions.chat.*
/hp group setperm default hyperfactions.info.*</pre>
<p><strong>2. Start playing:</strong></p>
<ul>
<li>🎮 Players: <code>/f</code> to open the GUI, or <code>/f create MyFaction</code></li>
<li>🔐 Admins: <code>/f admin</code> to open the admin panel</li>
</ul>
<p>💡 <strong>No permission mod?</strong> Set <code>"allowWithoutPermissionMod": true</code> in config.json to allow all non-admin features by default.</p>
<p> </p>
<h2><span style="color: #d19a66;">📋 Essential Commands</span></h2>
<table style="border-collapse: collapse; width: 39%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Command</th>
<th style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f</code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Open the faction GUI</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f create <name></code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Create a new faction</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f invite <player></code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Invite a player to your faction</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f home</code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Teleport to your faction home</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f c</code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Toggle faction/ally/public chat</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f ally <faction></code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Send an alliance request</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f enemy <faction></code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Declare a faction as your enemy</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f overclaim</code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Capture enemy territory (requires 0 or less power)</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f stuck</code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Teleport to safety when trapped in enemy territory</td>
</tr>
<tr>
<td style="width: 35%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>/f admin</code></td>
<td style="width: 65%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Open the admin panel</td>
</tr>
</tbody>
</table>
<p> </p>
<p>HyperFactions includes <strong><span style="color: #f0b232;">46 commands</span></strong> across 10 categories. See the full list in the <a href="https://www.hypersystems.dev/plugins/hyperfactions/wiki" rel="nofollow">documentation</a> or use <code>/f help</code> in-game.</p>
<p> </p>
<h2><span style="color: #56b6c2;">⚙️ Configuration</span></h2>
<p>HyperFactions uses a modular configuration system with <strong><span style="color: #f0b232;">11 modular config files</span></strong>:</p>
<table style="border-collapse: collapse; width: 62%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Config File</th>
<th style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/factions.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Faction gameplay — power, claims, combat, relations, invites, stuck, roles</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/server.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Server behavior — teleport, autoSave, messages, GUI, permissions, updates</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/chat.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Chat formatting, prefixes, and channel settings</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/announcements.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Server-wide announcement and notification toggles</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/worldmap.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">World map display, refresh modes, and performance tuning</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/backup.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Backup scheduling, retention, and rotation</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/debug.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Debug categories for targeted troubleshooting</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/economy.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Economy and faction treasury settings</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/faction-permissions.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Default territory permissions with server locks</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/worlds.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Per-world claiming, power loss, and friendly fire overrides</td>
</tr>
<tr>
<td style="width: 37%; border-color: rgb(52, 73, 94); padding: 6px 10px;"><code>config/gravestones.json</code></td>
<td style="width: 63%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Gravestone integration settings</td>
</tr>
</tbody>
</table>
<p> </p>
<p>All settings include sensible defaults. Missing keys are automatically added on startup without overwriting existing values.</p>
<p> </p>
<h2><span style="color: #c678dd;">🧑‍💻 For Developers</span></h2>
<p>Want to build integrations with HyperFactions? We publish to <strong>JitPack</strong> so you can add HyperFactions as a Maven dependency with no authentication required:</p>
<pre>repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compileOnly 'com.github.HyperSystems-Development:HyperFactions:v0.12.0'
}</pre>
<p>See the full <a href="https://github.com/HyperSystems-Development/HyperFactions/blob/main/docs/api.md" rel="nofollow">Developer API Reference</a> on GitHub for API usage, event listeners, economy integration, and more.</p>
<p> </p>
<h2><span style="color: #5b8def;">🧩 The HyperSystems Suite</span></h2>
<table style="border-collapse: collapse; width: 62%; border-color: #34495E; border-style: solid;" border="1">
<thead>
<tr>
<th style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Mod</th>
<th style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">⭐ <strong><a href="https://www.curseforge.com/hytale/mods/hyperperms">HyperPerms</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Advanced permissions management with groups, inheritance, and web editor</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">⚔️ <strong><a href="https://www.curseforge.com/hytale/mods/hyperfactions">HyperFactions</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Complete faction system with territory, diplomacy, economy, and 70+ GUI pages</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">🛡️ <strong><a href="https://www.curseforge.com/hytale/bootstrap/hyperprotect-mixin">HyperProtect-Mixin</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Mixin-based protection hooks for HyperFactions zone flags</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">💰 <strong><a href="https://www.curseforge.com/hytale/mods/ecotale">Ecotale</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Economy system with balance HUD, admin GUI, and VaultUnlocked integration</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">💬 <strong><a href="https://www.curseforge.com/hytale/mods/werchat">Werchat</a></strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Channel-based chat with private messaging, nicknames, and moderation</td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">🌐 <strong>HyperBorder</strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">World border management <span style="color: #e5c07b;">(Coming Soon)</span></td>
</tr>
<tr>
<td style="width: 30%; border-color: rgb(52, 73, 94); padding: 6px 10px;">🔧 <strong>HyperEssentials</strong></td>
<td style="width: 70%; border-color: rgb(52, 73, 94); padding: 6px 10px;">Essential server tools — homes, warps, TPA, spawns, and more <span style="color: #e5c07b;">(Coming Soon)</span></td>
</tr>
</tbody>
</table>
<p> </p>
<h2>🔗 Links</h2>
<ul>
<li><a href="https://www.hypersystems.dev/" rel="nofollow">HyperSystems Website</a></li>
<li><a href="https://www.hypersystems.dev/plugins/hyperfactions/wiki" rel="nofollow">Documentation & Wiki</a></li>
<li><a href="https://github.com/HyperSystems-Development/HyperFactions" rel="nofollow">GitHub Repository</a></li>
<li><a href="https://github.com/HyperSystems-Development/HyperFactions/issues" rel="nofollow">Issue Tracker</a></li>
<li><a href="https://discord.com/invite/aZaa5vcFYh" rel="nofollow">Discord</a></li>
</ul>
<p> </p>
<p><em>Part of the <a href="https://www.hypersystems.dev/" rel="nofollow">HyperSystems</a> suite — built for Hytale, open source, and actively maintained.</em></p>