Forge Essentials Mod — Guide
World Protection & Areas
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.
- Select two points using
//wandor//pos1///pos2. - Use
/area define <name>to save the region. - Use
/area flag <name> <flag> <value>to set rules.
Common Protection Flags
| Flag | Description | Default |
|---|---|---|
build |
Toggles block breaking and placing. | deny |
interact |
Toggles interaction with doors, buttons, and levers. | deny |
pvp |
Enables or disables player-vs-player combat. | allow |
mob-spawn |
Controls whether mobs can spawn in the area. | allow |
explosion |
Prevents TNT and Creeper damage to blocks. | deny |
chest-access |
Restricts opening of containers. | deny |
entry |
Toggles whether players can enter the area. | allow |
Economy & Shops
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).
Teleportation & Navigation
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/tpacceptto confirm. - Back: Return to the previous location (or death point) using
/back.
Multi-World & Portals
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>.
Afterlife & Deathchests
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.
Scripting & Automation
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.