ServerUtilities: Difference between revisions
Trash can and pic. anchor links
m (→JourneyMap Integration: disable overlay via config.) |
(Trash can and pic. anchor links) |
||
Line 1:
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|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 <code>/local/</code> for its file storage, but a similar top-level instance folder <code>/serverutilities/</code>.
== Installation ==
Download the latest version from [https://github.com/GTNewHorizons/ServerUtilities/releases 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 <code>/mods/</code> 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. Players migrating from FTBUtilities can archive their <code>/local/</code> folder after successfully running ServerUtilities and ensuring everything works as expected.
=== Icons ===
[[File:SUButtons.png|100px|right|alt=Three rows of two icons, a square map, three people in blue, green and red, a trash can, a grey gear, a wooden sign and a pink gear.|SU buttons]]
* [[#Claimed Chunks|Map]] - Claimed Chunks / Chunkloading
* People - My Team Settings
* [[#Trash Can|Trash Can]] - Item deletion GUI
* Silver Gear - Client Settings
* Wooden Sign - Leaderboards
Line 41:
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 <code>/''your_instance''/serverutilities/client/serverutilities.cfg</code> by changing <code>B:journeymap_overlay=true</code> to <code>false</code>.
{{clear}}
Line 62:
** <code>B:use_separate_thread=true</code>, sets if the archive will build in a separate CPU thread.
== Trash Can ==
[[File:SUTrashCanGUI.png|thumb|right|alt=Light grey grid of 4 by 9 slots with "Trash Can" in the upper left and InventoryTweaks sorting buttons on the upper right. At the bottom a cut off portion of the player's inventory can be seen.|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 <code>/trash_can</code>, by pressing the Trash Can button from the inventory GUI, or by assigning a keybind under <code> Esc > Options > Controls > Server Utilities > Trash Can</code> (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''.
{{clear}}
== Config Files ==
The <code>/''your_instance''/serverutilities/serverutilities.cfg</code> file has options for the following:
| |||