SETHOMEX DOCUMENTATION
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Complete setup and technical guide for server administrators
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
1. INSTALLATION
────────────────────────────────────────────────────
-
Download the latest SethomeX.jar file.
-
Place it into your server's /plugins/ folder.
-
(Optional) Ensure you have PlaceholderAPI for visual integration.
-
Restart your server to generate system configurations and initial databases.
-
Edit config.yml to link MySQL or fine-tune aesthetic parameters.
2. CONFIGURATION BREAKDOWN
────────────────────────────────────────────────────
Data Storage (Database Engine):
-
database.type: Choose between SQLITE (single server local file) or MYSQL (multi-proxy sync).
-
database.mysql.pool.maximum-size: Configures high-end HikariCP performance tuning (default 10).
-
use-ssl: Native SSL encryption for external database connections.
Teleport Logic & Cooldowns:
-
teleport.cooldown: Warmup timer duration in seconds. Set to 0 for instant movement.
-
teleport.cancel-on-move: Stops teleportation if the player changes coordinates.
-
teleport.cancel-on-damage: Interrupts active warmup sequence if incoming player damage occurs.
-
teleport.cancel-in-combat: Prevents triggering or finalizing warps while in engaged combat states.
Tiered Limit System:
-
limits.default: Maximum homes for basic tier players (e.g. 3).
-
limits.<rank_group>: Assign higher caps to specific permission nodes (sethomex.limit.vip). The engine automatically prioritizes the highest granted numeric cap.
VFX (Visual Effects Engine):
-
effects.countdown.particle: Select the primary visualization (FLAME, PORTAL, ENCHANT, CHERRY_LEAVES, WITCH, etc).
-
effects.countdown.style: Controls the procedural math shape: SPIRAL (upward helix), RING (dual planar circles), SHIELD (protective shell bubble).
-
effects.countdown.sound: Aural count sound triggered on every descending interval tick.
-
effects.success.particle: Landing burst effect upon arriving at destination coords.
GUI Configuration (Menu Personalizer):
-
gui.title: Inventory header text. Supports legacy & hex color codes.
-
gui.fill-empty-slots: Toggles aesthetic pane fillers for modern aesthetics.
-
gui.icon-selector.icons: Full customized pool of Material types visible in the in-game icon modifier utility.
Security Matrix:
-
safety.check-safe-destination: Blocks warping if targeted destination block transitions to harmful state (lava, void, block obstruction).
-
safety.prevent-unsafe-sethome: Strict rule ensuring players must stand on solid material foundations when generating saved coordinates.
3. PLACEHOLDERAPI INTEGRATION
────────────────────────────────────────────────────
Expose SethomeX stats to your UI, Scoreboards, or Chat formatting engines:
-
%sethomex_count% — Total current homes created by the player.
-
%sethomex_limit% — Current resolved maximum limit based on their rank.
-
%sethomex_remaining% — Amount of free home slots left to utilize.
-
%sethomex_limit_reached% — Returns true/false condition based on current capacity.
️ 4. COMMAND REFERENCE
────────────────────────────────────────────────────
| /sethome [nom] |
Save current standing location as designated home point. |
| /home |
Opens full visual interface GUI containing all home roster points. |
| /home [nom] |
Direct command to initiate 3D warmup and teleport to specific home. |
| /delhome [nom] |
Removes and unlinks specified home record forever. |
| /shx info |
Displays system information, Java stack, and active DB handler engine. |
| /shx reload |
Live-recycles configurations, limit nodes, and connection hooks. |
5. PERMISSIONS INFRASTRUCTURE
────────────────────────────────────────────────────
-
sethomex.command.sethome — Core node to generate home points (Default: true).
-
sethomex.command.home — Core node to access direct warp and the modern GUI (Default: true).
-
sethomex.command.delhome — Ability to prune records from list (Default: true).
-
sethomex.command.admin — Unlocks full administrator backend operations (/shx).
-
sethomex.limit.<key> — Extends maximal caps. Correlates directly with config.yml group entries.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Need real-time configuration support? Hop into Discord!
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━