ServerUtilities: Difference between revisions
Content added Content deleted
(chunk claiming.) |
m (ranks configs, backups, pic) |
||
| Line 1: | 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, teleports and extended commands. While |
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 <code>/local/</code> for its file storage, but a similar top-level instance folder <code>/serverutilities/</code>. |
||
== Installation == |
== Installation == |
||
| Line 19: | Line 19: | ||
* Ranks config: <code>/your_instance/serverutilties/server/ranks.txt</code> |
* Ranks config: <code>/your_instance/serverutilties/server/ranks.txt</code> |
||
** <code>"serverutilities.chunkloader.max_chunks":</code> Change the total chunkloaded chunks per player. |
|||
** <code>"serverutilities.claims.max_chunks":</code> Change the total number of claimed chunks per player. |
|||
** <code>"serverutilities.homes.max":</code> Change the allowed number of /home registrations. |
|||
* Player list: <code>/your_instance/serverutilties/server/players.txt</code> |
* Player list: <code>/your_instance/serverutilties/server/players.txt</code> |
||
* [https://feedthebeast.notion.site/Ranks-003fd40c2de247aba4730faa7514e12a Sample Ranks and configurations are the same as for FTBUtilities] |
* [https://feedthebeast.notion.site/Ranks-003fd40c2de247aba4730faa7514e12a Sample Ranks and configurations are the same as for FTBUtilities] |
||
== Claimed Chunks == |
== Claimed Chunks == |
||
[[File:SU claim map.png|thumb|right|alt=Top down map of a canyon and desert split by a wide river. The lower left area is mostly overlaid by blue chunks, the central area has a blobby red outline. Five buttons are on the right, a green checkmark, green circulating arrows, two no entry circles with white horizontal bars, and a blue circle with an "i" character.]] |
|||
Open in-game inventory, click on the map icon ([[File:FTBUtilities Map Icon.png|16px]]) 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 <code>My Teams > Settings > Color</code>. Right-click to unclaim a chunk. Click-drag to claim/unclaim multiple chunks as once. |
Open in-game inventory, click on the map icon ([[File:FTBUtilities Map Icon.png|16px]]) 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 <code>My Teams > Settings > Color</code>. Right-click to unclaim a chunk. Click-drag to claim/unclaim multiple chunks as once. |
||
| Line 29: | Line 33: | ||
Chunk Claim data is stored at <code>/''your_instance''/saves/''your_world''/serverutilities/teams/claimedchunks/''player_name''.dat</code> |
Chunk Claim data is stored at <code>/''your_instance''/saves/''your_world''/serverutilities/teams/claimedchunks/''player_name''.dat</code> |
||
{{clear}} |
|||
== JourneyMap Integration == |
== JourneyMap Integration == |
||
| Line 36: | 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. |
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. |
||
{{clear}} |
{{clear}} |
||
== Backups == |
|||
ServerUtilities can be configured to make regular automated backups of the <code>/saves/''your_world''/</code> folder as a .zip file. By default it places its archives in the <code>/backups/</code> 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 [[Installing_and_Migrating#Upgrading|upgrading]] versions. |
|||
* Trigger a manual backup: <code>/backup start</code> |
|||
Backup settings: |
|||
Open <code>/''your_instance''/serverutilities/serverutilities.cfg</code>, then |
|||
** Find <code>"backup_timer": 2.0,</code> where # is the number of hours ''between'' backups. |
|||
** Find <code>"backups_to_keep": 3,</code> change value to number of desired backups. |
|||
** Find <code>"enable_backups"</code>, set to true to enable automatic backups. |
|||
== Links == |
== Links == |
||