Forge Essentials Mod Wiki

Forge Essentials (FE) is a powerful, modular server-side utility mod designed to provide administrators with total control over their Minecraft servers. Unlike many other mods, FE is primarily server-side, meaning clients do not need to install it to join, though an optional client-side component exists to enable enhanced visual features like WorldEdit overlays.

The mod is built on a modular architecture, allowing server owners to enable or disable specific features such as the economy, multi-world support, or the advanced permissions engine. It is widely considered the 'WorldGuard and Essentials' equivalent for the Forge ecosystem.

The core of Forge Essentials is its robust permission manager, which is arguably the most advanced for modded Minecraft. It handles groups, users, and zones with support for inheritance and wildcards.

Permission Nodes

Permissions are structured in a hierarchical dot-notation (e.g., fe.command.teleport.tp).

• Wildcards: Using an asterisk (*) allows granting all sub-nodes (e.g., fe.command.* grants all FE commands).
• Negation: Permissions can be explicitly denied to override inherited 'allow' states.

Groups and Users

Administrators can create custom ranks and assign permissions to them. New players are typically placed in the _GUESTS_ or _DEFAULT_ group.

Forge Essentials includes a sophisticated area protection system that allows admins to define regions and restrict player actions within them using 'flags'.

Defining Areas

Areas are defined using a selection tool (compatible with WorldEdit). Once a selection is made, it can be saved as a named area.

1. Select two points using //wand or //pos1///pos2.
2. Use /area define <name> to save the region.
3. Use /area flag <name> <flag> <value> to set rules.

Common Protection Flags

The Economy module introduces a virtual currency system that integrates with other FE features like command costs and teleportation fees.

Currency Management

Players can check their balance, pay others, and view the wealthiest players on the server.

• /money - View your current balance.
• /pay <player> <amount> - Transfer funds to another player.
• /baltop - View the server's economic leaderboard.

Sign Shops

Using the Sign Tools module, players and admins can create physical shops. By placing a sign with specific syntax, players can buy or sell items automatically.

Admin Shop Example: Line 1: [Buy] Line 2: Quantity Line 3: ItemID Line 4: Price

Command Costs

Administrators can charge players for using specific commands by setting permission properties: /p group all value fe.economy.cmdprice.teleport 50 (Charges 50 currency for every teleport).

FE provides a suite of commands for moving across the world and managing player locations.

• Spawn: Set a global or group-specific spawn point with /p global spawn here.
• Homes: Players can set multiple private waypoints using /sethome <name> and return with /home <name>.
• Warps: Public locations created by admins using /setwarp <name>. Players access them via /warp <name>.
• TPA: Request to teleport to another player with /tpa <player>. The recipient must /tpaccept to confirm.
• Back: Return to the previous location (or death point) using /back.

The Multi-World module allows for the creation and management of multiple dimensions on a single server instance.

Dimension Management

• /mw create <name> <generator> - Creates a new world (e.g., flat, normal, or modded types).
• /mw load <name> - Loads an existing world folder.
• /mw list - Displays all currently active and inactive worlds.

Portals

Portals can be created to link different worlds or distant locations in the same world. Portals are defined as areas and then assigned a destination using /portal link <source_area> <destination_coords_or_area>.

The Afterlife module manages what happens when a player dies. It is designed to mitigate the frustration of losing items while maintaining a survival challenge.

• Deathchests: Upon death, a chest (or 'Totem') is spawned at the player's death location containing their inventory. This prevents items from despawning.
• Retention: Configurable options allow players to keep a percentage of their XP or hunger levels after respawning.
• Protection: Deathchests can be locked so only the owner can retrieve the items, or they can be set to unlock after a specific duration.

For advanced users, Forge Essentials includes a JavaScript (JS) Scripting Engine. This allows for the creation of custom logic, automated tasks, and complex interactions without writing a full Java mod.

• Event Handling: Scripts can trigger based on player join, block break, or custom commands.
• Sign Scripting: Signs can be programmed to execute JS code when clicked, enabling custom GUI menus or complex redstone-like logic.
• Ticket System: A built-in support ticket system (/ticket) allows players to report issues to admins, which are logged and tracked through a dedicated interface.

FE includes several background utilities to ensure server stability and security.

• Automated Backups: Periodically saves the world and compresses it into a zip file. Configurable retention policies ensure the disk doesn't fill up.
• Player Logger: Records every action (block placement, command usage, chat) to a database, making it easy to investigate griefing incidents.
• World Border: Sets a hard limit on how far players can travel in each dimension to prevent runaway world generation and lag.
• Authentication: An optional login system for servers running in 'offline' mode to prevent username spoofing.