Join The Discord

Starforged Essentials is a lightweight utility mod that adds core quality‑of‑life commands and server tools to Hytale. Designed as a simple, dependable foundation for any world or server, it provides essential features players expect while keeping everything fast, clean, and unobtrusive.

With homes, teleportation, permissions, and more, Starforged Essentials gives players the convenience they need without changing the core gameplay experience.

Features:

/home & /sethome — Players can save and return to personal locations.
/tpa & /tpaccept — Player‑to‑player teleport requests for cooperative play.
Permissions support — Control who can use which commands.
Lightweight utilities — Additional small features to improve everyday gameplay.
Server‑friendly — Simple, stable, and designed to work smoothly in any modpack.

Perfect for survival servers, community worlds, or anyone who wants a clean essentials system without unnecessary extras.

================================================================================
1. HOME SYSTEM
================================================================================

COMMANDS:
/sethome - Sets current location as default home
/sethome <name> - Sets current location as named home
/home - Teleports to default home
/home <name> - Teleports to named home
/delhome <name> - Deletes the named home
/homes - Lists all your homes

PERMISSIONS:
starforge.sethome - Can set homes
starforge.home - Can teleport to homes
starforge.delhome - Can delete homes
starforge.listhomes - Can list homes

CONFIG OPTIONS:
- max-homes: Maximum homes allowed (-1 = infinite)
- teleport-cooldown: Cooldown between teleports
- movement-cancel: Whether moving cancels teleport warmup

================================================================================
2. WARP SYSTEM
================================================================================

COMMANDS:
/setwarp <name> - Creates a warp at current location
/warp <name> - Teleports to the named warp
/delwarp <name> - Deletes the named warp

PERMISSIONS:
starforge.setwarp - Can create warps
starforge.warp - Can use warps
starforge.delwarp - Can delete warps

CONFIG OPTIONS:
- max-warps: Maximum warps allowed (-1 = infinite)

================================================================================
3. MESSAGING SYSTEM
================================================================================

COMMANDS:
/msg <player> <message> - Sends private message
/m <player> <message> - Alias for /msg
/message <player> <msg> - Alias for /msg
/whisper <player> <msg> - Alias for /msg
/tell <player> <msg> - Alias for /msg
/pm <player> <msg> - Alias for /msg
/dm <player> <msg> - Alias for /msg
/r <message> - Reply to last message sender

PERMISSIONS:
starforge.message - Can send private messages
starforge.reply - Can reply to messages

CONFIG OPTIONS:
- prefix-color: Color for /msg prefix (default: &9 blue)

================================================================================
4. BACK SYSTEM
================================================================================

COMMANDS:
/back - Teleports to last death/teleport location

PERMISSIONS:
starforge.back - Can use /back command

CONFIG OPTIONS:
- max-back-locations: How many locations to track
- cooldown.enabled: Enable/disable cooldown
- cooldown.seconds: Cooldown time (-1 = no cooldown)

================================================================================
5. RANDOM TELEPORT (RTP)
================================================================================

COMMANDS:
/rtp - Teleports to random safe location

PERMISSIONS:
starforge.rtp - Can use random teleport

CONFIG OPTIONS:
- max-distance: Maximum distance from spawn
- min-distance: Minimum distance from spawn
- cooldown.seconds: Cooldown between uses (-1 = no cooldown)
- safety options: Ground check, lava check, fall damage check

SAFETY FEATURES:
- Ensures player is above ground
- Avoids lava
- Prevents fall damage from height

================================================================================
6. TPA SYSTEM
================================================================================

COMMANDS:
/tpa <player> - Request to teleport to player
/tpahere <player> - Request player to teleport to you
/tpaccept - Accept incoming TPA request
/tpdeny - Deny incoming TPA request
/tpaauto - Toggle auto-accept for TPA (not TPAHere)
/tpablock <player> - Block TPA requests from player
/tpaunblock <player> - Unblock TPA requests from player

PERMISSIONS:
starforge.tpa - Can send TPA requests
starforge.tpahere - Can send TPAHere requests
starforge.tpaccept - Can accept TPA requests
starforge.tpadeny - Can deny TPA requests
starforge.tpaauto - Can toggle auto-accept
starforge.tpablock - Can block players
starforge.tpaunblock - Can unblock players

CONFIG OPTIONS:
- request-timeout: Seconds before request expires
- cooldown.tpa-seconds: Cooldown for /tpa
- cooldown.tpahere-seconds: Cooldown for /tpahere

================================================================================
7. SPAWN SYSTEM
================================================================================

COMMANDS:
/spawn - Teleport to spawn
/setspawn - Set spawn location

PERMISSIONS:
starforge.spawn - Can teleport to spawn
starforge.setspawn - Can set spawn location

CONFIG OPTIONS:
- spawn-protection.enabled: Enable spawn protection
- spawn-protection.duration-seconds: Protection duration (default: 5)
- spawn-protection.cancel-on-attack: Ends if player attacks

================================================================================
ECONOMY COMMANDS
================================================================================

/bal or /money - Used to get your balance
/pay playername - Sends money amount to player
/baltop - Shows top 10 wealthiest players and how much they have

================================================================================
KITS COMMANDS
================================================================================

/kits - Shows all currently available kits
/kit name - Used to receive that kit

================================================================================
8. ADMIN COMMANDS
================================================================================

GOD MODE:
/god - Toggle god mode for self
/god <player> - Toggle god mode for player
Permission: starforge.admingod
Note: Disables on logout

HEAL:
/heal - Heal self (full health/stamina, remove debuffs)
/heal <player> - Heal target player
Permission: starforge.adminheal

FLY:
/fly - Toggle fly mode for self
/fly <player> - Toggle fly mode for player
/flyspeed <speed> - Set own fly speed
/flyspeed <player> <speed> - Set player's fly speed
Permission: starforge.adminfly
Note: Disables on logout

TOP:
/top - Teleport to highest block above
Permission: starforge.admintop

CLEAR INVENTORY:
/clearinventory - Clear own inventory
/clearinventory <player> - Clear player's inventory
Permission: starforge.adminclearinventory

BROADCAST:
/broadcast <message> - Send colored message to all players
Permission: starforge.adminbroadcast

SLEEP:
/sleep <percentage> - Set sleep skip percentage (e.g., /sleep 5 = 5%)
Permission: starforge.adminsleep

RELOAD:
/reload - Reload all config files, permissions, and player data
Permission: starforge.adminreload

ALIAS MANAGEMENT:
/alias add "<command>" <alias> - Add command alias (supports multi-word commands)
Examples:
/alias add "fly" f
/alias add "gamemode creative" gmc
/alias add "gamemode adventure" gma
/alias rem <alias> - Remove command alias (e.g., /alias rem f)
/alias list - List all aliases
Permission: starforge.adminalias
Note: Aliases are saved to alias.yml config file

MUTE:
/mute <player> [duration] [reason…] - Mute player (supports optional duration)
Duration formats: 5s, 10m, 2h, 1d, or plain seconds (30)
/unmute <player> - Unmute player
Permission: starforge.adminmute

BAN:
/ban <player> [duration] [reason…] - Ban player (supports optional duration)
Duration formats: 5s, 10m, 2h, 1d, or plain seconds (30)
Duration can be first or last token:
/ban Novaelix 5s griefing
/ban Novaelix griefing 5s
/unban <player> - Unban player
Permission: starforge.adminban

KICK:
/kick <player> <reason> - Kick player with reason
Permission: starforge.adminkick

FREEZE:
/freeze <player> - Freeze/unfreeze a player (prevents movement and teleports)
Permission: starforge.freeze

REPAIR:
/repair - Repair all items in your inventory
/repair <player> - Repair another player's inventory
Permission: starforge.repair
Extra permission: starforge.repair.others (required to repair other players)

GAMEMODE:
/gamemode <adventure|creative> [player] - Set gamemode
Permission: starforge.admingamemode

TIME:
/time set <day|night> - Set time
Permission: starforge.admintime

WEATHER:
/weather set <clear|rain|snow> - Set weather
Permission: starforge.adminweather

TPALLHERE:
/tpallhere - Teleport all players to you
Permission: starforge.admintpallhere

KILL:
/kill <player> - Kill a player
Permission: starforge.adminkill

RANK MANAGEMENT:
/promote <player> - Promote a player's rank by +1 (cannot promote to >= your rank)
/demote <player> - Demote a player's rank by -1 (cannot demote above your rank / below lowest rank)
Permissions: starforge.adminpromote, starforge.admindemote

TELEPORT (ADMIN):
/tp <player> - Teleport to player

Whitelist Maintenance Mode:
/maintenance on - Whitelist is enabled
/maintenance off - Whitelist is disabled

ECONOMY MANAGEMENT:
/bal set playername amount - sets player to that amount of money
/bal add playername amount - adds amount to player
/bal rem playername amount - removes amount from player

================================================================================
10. CONFIGURATION FILES
================================================================================

FOUR CONFIGURATION FILES:
1. config.yml - Main plugin configuration
2. permissions.yml - Rank and permission definitions
3. alias.yml - Command aliases (auto-generated)
4. players.yml - Player data (auto-generated)

CONFIG.YML SECTIONS:
- motd: Message of the Day (color codes & URLs supported)
- rules: Server rules (multi-line, color codes)
- join-message: Join/first-join messages
- spawn-protection: Invulnerability settings
- homes: Home limits and cooldowns
- warps: Warp limits
- messaging: Private message formatting
- back: Back command settings
- rtp: Random teleport settings
- tpa: TPA request settings
- enabled-commands: List of enabled commands
- disabled-commands: List of disabled commands (OP only)
- permission-system.use-builtin: true/false
- Whitelist options for rank and whitelist kick message and enabled: true/false

PERMISSIONS.YML STRUCTURE:
default-rank: "member"
ranks:
member:
prefix: "&7[Member] "
permissions:
- starforge.home
- starforge.sethome
- starforge.rtp
- starforge.tpahere
- starforge.admins
- (etc…)
vip:
prefix: "&a[VIP] "
inherit: member # Inherits all member permissions
permissions: [] # Empty for now - add future VIP perks here
admin:
prefix: "&c[Admin] "
inherit: vip # Inherits all VIP permissions
permissions:
- starforge.admingod
- (etc…)

PLAYERS.YML STRUCTURE:
players:
"uuid-here":
username: "PlayerName"
rank: "member"
nickname: "" # Color codes supported: "&6Cool&eNick"
first-join: "2025-01-19T12:00:00"
last-seen: "2025-01-19T15:30:00"

ALIAS.YML STRUCTURE:
aliases:
f: "fly"
h: "heal"
# Format: alias: "command"

LOG FILES (auto-created):
- mute-log.txt - All mutes/unmutes with timestamps
- ban-log.txt - All bans/unbans with timestamps and IPs
- kick-log.txt - All kicks with timestamps

================================================================================
11. PERMISSION LIST
================================================================================

PLAYER PERMISSIONS:
starforge.sethome - Set home locations
starforge.home - Teleport to homes
starforge.delhome - Delete homes
starforge.listhomes - List all homes
starforge.warp - Use warps
starforge.message - Send private messages
starforge.reply - Reply to messages
starforge.back - Return to last location
starforge.rtp - Random teleport
starforge.tpa - Request teleport to player
starforge.tpaccept - Accept TPA requests
starforge.tpadeny - Deny TPA requests
starforge.tpaauto - Toggle auto-accept
starforge.tpablock - Block TPA from player
starforge.tpaunblock - Unblock TPA from player
starforge.tpahere - Request player teleport to you
starforge.spawn - Teleport to spawn
starforge.help - View help
starforge.list - View online players
starforge.nickname - Set/remove nickname
starforge.admins - View online admins (informational)
starforge.balance - for balance/money command
starforge.balancetop - for /baltop command
starforge.pay - for /pay command
starforge.kit - for /kit and /kits command

ADMIN PERMISSIONS:
starforge.setwarp - Create warps
starforge.delwarp - Delete warps
starforge.setspawn - Set spawn location
starforge.admingod - God mode
starforge.adminheal - Heal command
starforge.adminfly - Fly mode & speed
starforge.admintop - Teleport to top
starforge.adminclearinventory - Clear inventory
starforge.adminbroadcast - Broadcast messages
starforge.adminsleep - Set sleep percentage
starforge.adminreload - Reload config
starforge.adminmute - Mute/unmute players
starforge.adminban - Ban/unban players
starforge.adminkick - Kick players
starforge.admintp - Admin teleport
starforge.freeze - Freeze/unfreeze players
starforge.adminkill - Kill players
starforge.admintime - Set time
starforge.adminweather - Set weather
starforge.admingamemode - Change gamemode
starforge.repair - Repair items
starforge.repair.others - Repair other players' items
starforge.adminpromote - Promote player rank
starforge.admindemote - Demote player rank
starforge.adminalias - Manage command aliases
starforge.adminmaintenance - Enable/disable whitelist mode
starforge.adminbal - For set add and rem player balance

================================================================================
12. COLOR CODES
================================================================================

COLORS:
&0 - Black &8 - Dark Gray
&1 - Dark Blue &9 - Blue
&2 - Dark Green &a - Green
&3 - Dark Aqua &b - Aqua
&4 - Dark Red &c - Red
&5 - Dark Purple &d - Light Purple
&6 - Gold &e - Yellow
&7 - Gray &f - White

FORMATTING:
&l - Bold
&o - Italic
&n - Underline
&m - Strikethrough
&k - Obfuscated
&r - Reset

EXAMPLES:
"&6Welcome &eto the server!" = Gold "Welcome " + Yellow "to the server!"
"&c&lWARNING" = Red Bold "WARNING"
"&a[VIP] &fPlayerName" = Green "[VIP] " + White "PlayerName"