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. Players migrating from FTBUtilities & FTBLibrary should remove those mods in order to avoid issues. 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. Players migrating from FTBUtilities can archive their /local/ folder after successfully running ServerUtilities and ensuring everything works as expected. There is no separate library mod needed for ServerUtilities.

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, in which case the rank with highest power will take priority over any overlapping permission nodes from ranks with lower power.

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. Maximum chunk claims/loads cannot be set to a value higher than 30,000.

• Ranks config: /your_instance/serverutilities/server/ranks.txt
  • serverutilities.chunkloader.max_chunks: Change the total chunkloaded chunks per player. (max 30000)
  • serverutilities.claims.max_chunks: Change the total number of claimed chunks per player. (max 30000)
  • serverutilities.homes.max: Change the allowed number of /home registrations.
• Player list: /your_instance/serverutilities/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. CTRL can be held while dragging to claim/unclaim in a large square.

Chunkloading

Shift+click on any chunk to claim and chunkload it. Shift right-click to keep the claim but no longer chunkload. 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

Teleports

Multiple teleportation options are offered including user-definable home points. Access and limits can be configured with player ranks for server owners.

• /sethome your_teleport Sets "your_teleport" as a destination. Can be any string.
• /delhome your_teleport Deletes "your_teleport" as a destination.
• /home your_teleport Teleports the player to destination "your_teleport"
• /home list List of all the player's sethome destinations.
• /spawn Teleports the player to spawn.
• /back Teleports back to the previous location before using a /home. Only works once.

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.

The JourneyMap overlay can be disabled on restart in /your_instance/serverutilities/client/serverutilities.cfg by changing B:journeymap_overlay=true to false.

Backups

Successful backup message.

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. When starting and completing a backup SU will display messages above the hotbar, which can be turned off in the config file.

• Trigger a manual backup: /backup start
• Stop a manual backup in progress: /backup stop

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

• • S:backup_folder_path=./backups/, to change the default backup archive location.
  • S:backup_timer=0.5, where # is the number of hours between backups. e.g. 0.5 would be every half hour.
  • I:backups_to_keep=5, change value to number of desired backups.
  • B:enable_backups=true, set to true to enable automatic backups, false to disable.
  • B:display_file_size=true, change to false to suppress the display of world size/backup size after saving.
  • I:compression_level=1, set between 1 (fastest) and 9 (smallest file) compression level.
  • B:silent_backup=false, change to true to not show backup notifications.
  • B:need_online_players=true, change to false to do backups even when the server is empty.
  • B:use_separate_thread=true, sets if the archive will build in a separate CPU thread.

Trash Can

Trash Can GUI

The Trash Can is a GUI based portable item deletion feature similar to item based trash options. It can be accessed by command with /trash_can, by pressing the Trash Can button from the inventory GUI, or by assigning a keybind under Esc > Options > Controls > Server Utilities > Trash Can (Default NONE). The trash functions as a standard inventory in regards to shortcuts but any item left in it when the window is closed with ESC will be permanently deleted.

Config Files

The /your_instance/serverutilities/serverutilities.cfg file has options for the following:

• AFK Timer / messages
• Auto-Shutdown
• Backups
• Marking of changed nicknames
• Enable/disable specific SU commands
• Debugging (of ServerUtilities)
• Player profile merging
• Replacing the /reload command with SU's version.
• Login messages
• Starter items / welcome package
• Ranks and associated chat colors
• Teams auto-creation/join
• Banlist of dimensions for chunkloading
• Enable/disable chunk loading & claiming
• Disable wall suffocation
• Disable right-click of specific items
• Forcing explosion and PVP settings
• Settings for spawn dimension
• /rtp Request teleport settings
• Hide/show play time
• Unloading of erroring chunks
• Log settings

The client-side /your_instance/serverutilities/client/serverutilities.cfg file has options for the following:

• Time to set the day/night buttons to
• Show item's NBT values
• Show item's OreDictionary values
• Enable/disable the JourneyMap overlay
• Notification location / disable SU notifications
• Dotted line border around loaded chunks
• Show/hide shutdown timer, amount of lead time
• SU buttons location

Links

• ServerUtilities - Github
• FTBUtilities - Ranks