ServerUtilities: Difference between revisions

hopefully a compromise formulation
(add quick setup guide to answer the common questions in #help post 2.6.0)
(hopefully a compromise formulation)
 
(3 intermediate revisions by 2 users not shown)
Line 1:
{{cleanup|Subsection on Ranks / ranks config needed.}}
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>.
 
== InstallationQuick Setup ==
Since 2.6.0, ServerUtilities is included in GTNH. Many features are purposefully disabled though to keep balancing intact.
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. 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 <code>/local/</code> folder after successfully running ServerUtilities and ensuring everything works as expected. There is no separate library mod needed for ServerUtilities.
 
If you only want to use itSU for chunkloading you must open <code>/.minecraft/serverutilities/serverutilties.cfg</code> and turn the following settings on
=== Icons ===
* <code>B:chunk_claiming</code>
* <code>B:chunk_loading</code>
in the <code>world</code> category to <code>true</code>. To change the maximum amount of claims/chunkloads findyou also need to go the <code>B:enabledranks</code> under the ranks category and turn itthem on by setting <code>B:enabled=true</code>. Afterwards the amounts can be customized as described in [[ServerUtilities#Permissions|Permissions]].
 
There are various other options in this config file to customize your overall server and what commands you want to have available. Of course some of these options will have a significant impact on balance and game experience. See [[ServerUtilities#Config Files|Config Files]] for more.
 
If you just want to use all of the features that SU provides you also have the option to delete the config file and restart the game. This generates a fresh config file based on the defaults in the mod instead of the modpack. Keep in mind that this will turn on SU backups and of course also affects modpack balance in various ways.
 
== Migrating from FTBUtilities ==
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. Players migrating from FTBUtilities & FTBLibrary shouldneed to 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 <code>/local/</code> folder after successfully running ServerUtilities and ensuring everything works as expected. There is no separate library mod needed for ServerUtilities.
 
=== 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
Line 13 ⟶ 25:
* Wooden Sign - Leaderboards
* Pink Gear - Admin Settings (only Admins/single players)
 
== Quick Setup 2.6.0+ ==
As per GTNH 2.6.0 ServerUtilities is installed by default however to keep balancing intact most features have been disabled.
If you are wanting to use all the features the mod provides it is advised to navigate to the <code>/.minecraft/</code> folder and delete the <code>/serverutilities/</code> folder within. Restarting the game afterwards will generate a new config with most features enabled.
 
If you only want to use it for chunkloading you must open <code>/.minecraft/serverutilities/serverutilties.cfg</code> and turn the following settings on
* <code>B:chunk_claiming</code>
* <code>B:chunk_loading</code>
To change the maximum amount of claims/chunkloads find <code>B:enabled</code> under the ranks category and turn it on. Afterwards the amounts can be customized as described in [[ServerUtilities#Permissions|Permissions]]
 
== Permissions ==
142

edits