ServerUtilities

ServerUtilities (SU) is a GTNH forked mod combining FTBUtilities, FTBLibrary, and Aurora webAPI. Like its predecessors, SU focuses on extended multiplayer functions such as player ranks, chunk loading/claiming, teams, world backups, teleports and extended commands. While aimed at the needs of servers, its still commonly used in single-player as the chunkloading mod of choice. Previous users of FTBU/Lib can switch over to SU while retaining their home, warp and chunk settings, which will be automatically imported into ServerUtilites on first launch. SU does not use /local/ for its file storage, but a similar top-level instance folder /serverutilities/.

Installation

Download the latest version from Github. Pick the version that does not have any -source or -dev suffixes, just a plain ServerUtilities {version number}.jar file. Add the .jar to the /mods/ folder in the instance. For servers, it must be added to both server and client-side. For Single Player, it only needs to be in the client. When properly installed, there should be new buttons to the left of the inventory GUI.

Icons

SU buttons

• Map - Claimed Chunks / Chunkloading
• People - My Team Settings
• Trash Can - Item deletion GUI
• Silver Gear - Client Settings
• Wooden Sign - Leaderboards
• Pink Gear - Admin Settings (only Admins/single players)

Permissions

One of SU's core features is permissions management. It can be used to set a variety of different player ranks that allow/disallow certain actions and commands without having to assign each individual player. Players can have one or more ranks at once, and will have the greatest allowed power for each permission amongst them.

A full list of current permissions and commands can be generated with /dump_permissions. This file contains every command available to players, who can use it, and its source. ServerUtilities own permissions are also listed, such as warp/teleport cooldowns and warmups, restrictions on block placement/use in claimed areas, and maximum allowed claims/homes. This dump includes the node designations for commands (command.{mod}.{keyword}) which are needed to assign specific permissions to ranks.

• Ranks config: /your_instance/serverutilties/server/ranks.txt
  • "serverutilities.chunkloader.max_chunks": Change the total chunkloaded chunks per player.
  • "serverutilities.claims.max_chunks": Change the total number of claimed chunks per player.
  • "serverutilities.homes.max": Change the allowed number of /home registrations.
• Player list: /your_instance/serverutilties/server/players.txt
• Sample Ranks and configurations are the same as for FTBUtilities

Claimed Chunks

Open in-game inventory, click on the map icon () to the left, then left click on chunks to claim. Claimed chunks will be overlaid with the player's team color, which can be changed from My Teams > Settings > Color. Right-click to unclaim a chunk. Click-drag to claim/unclaim multiple chunks as once.

Chunkloading

Shift+click on any chunk to claim and chunkload it. Shift right-click to keep the claim but no longer chunkcload. Hold Shift and click-drag to claim & load multiple chunks at once. Shift+right click-drag unloads multiple chunks, but retains the claim. There are buttons on the right side for unclaiming all Overworld chunks and all chunks in every dimension.

Chunk Claim data is stored at /your_instance/saves/your_world/serverutilities/teams/claimedchunks/player_name.dat

JourneyMap Integration

SU JourneyMap overlay

Exclusive to ServerUtilities is the ability to see and manage chunkloads/claims from JourneyMap. The SU overlay can be activated with the button showing three figures . Chunks will be shown in the team/player's assigned colour, with a more opaque overlay for chunkloaded areas. Double-click to toggle between claimed and chunkloaded. The action button (default DELETE, Esc > Options > Controls > Visual Prospecting) unclaims a chunk, bu there currently isn't any way of claiming from JourneyMap. Use the SU interface button from the player's inventory.

Like other JourneyMap overlays, it shows on both the full screen map and minimaps, and only one overlay can be displayed at once. The SU overlay is useful for spotting stray chunkloads from past remote resource gathering operations and removing claims without having to visit the area.

Backups

ServerUtilities can be configured to make regular automated backups of the /saves/your_world/ folder as a .zip file. By default it places its archives in the /backups/ folder, in the instance. That means it does not back up a number of key folders, including /journeymap/, /TCNodeTracker/ & /visualprospecting/ (Journeymap maps, prospecting data & waypoints), /schematics/ (for Schematica) and /saves/NEI/ (Not Enough Items bookmarks). Regular manual backups are recommended to supplement the automatic system, especially before upgrading versions.

• Trigger a manual backup: /backup start

Backup settings: Open /your_instance/serverutilities/serverutilities.cfg, then

• • Find "backup_timer": 2.0, where # is the number of hours between backups.
  • Find "backups_to_keep": 3, change value to number of desired backups.
  • Find "enable_backups", set to true to enable automatic backups.

Links

• ServerUtilities - Github
• FTBUtilities - Ranks