UtilityBiome:Installation

From MutigerAffe Wiki
Jump to navigation Jump to search

Utility Biome is a server plugin with a very small asset pack. The pack holds a single shared noise file that mods can use. It changes no vanilla files.

Requirements

Utility Biome Hytale server
1.0.0 0.7.x (>=0.7.0 <0.8.0)

Hytale 0.6.x is not supported by 1.0.0. Utility Biome itself needs no other mods.

The world needs Hytale's regular world generator. On worlds without it, the biome and cave commands answer that there is no world generator, and chunk features from other mods are not placed.

Installing

  1. Download the jar from CurseForge.
  2. Put it into the mods folder of your server, next to the mod that needs it (for example Better Biomes).
  3. Start the server.

When the library has started, the server log shows the line UtilityBiome 1.0.0 bereit (the log messages of the library are in German).

Matching versions

Mods that depend on Utility Biome name an exact version in their manifest, and the server will not start such a mod when that version is missing. Better Biomes 1.4.0 needs Utility Biome 1.0.0.

If a dependent mod reports that Utility Biome is missing, check that

  • the Utility Biome jar is in the mods folder,
  • its version is the one the dependent mod asks for, and
  • both match your Hytale server version (see the table above).

Permissions

All commands sit under /ub (alias /utilitybiome). Utility Biome does not open them to everyone, so by default only operators can use them. The server console can always use the commands that do not need a player.

Each command has its own permission node. A player needs the node of /ub and the node of the subcommand:

Command Permission node
/ub com.cyberpiratepenguin.utilitybiome.command.ub
/ub where com.cyberpiratepenguin.utilitybiome.command.ub.where
/ub census com.cyberpiratepenguin.utilitybiome.command.ub.census
/ub list com.cyberpiratepenguin.utilitybiome.command.ub.list
/ub caves com.cyberpiratepenguin.utilitybiome.command.ub.caves
/ub cave com.cyberpiratepenguin.utilitybiome.command.ub.cave
/ub next com.cyberpiratepenguin.utilitybiome.command.ub.next
/ub features com.cyberpiratepenguin.utilitybiome.command.ub.features
/ub feature com.cyberpiratepenguin.utilitybiome.command.ub.feature

To allow all of them at once, grant com.cyberpiratepenguin.utilitybiome.command.ub.*. This wildcard covers /ub itself and every subcommand. Keep in mind that /ub next, /ub cave and /ub feature teleport the player.

Configuration

There is no configuration file. Two optional environment variables exist for server admins and developers:

  • UTILITYBIOME_CENSUS runs a biome census when the server starts. See Biome Census.
  • UTILITYBIOME_TEST_FEATURES turns on two test features for mod development. Do not set it on a server people play on: it places crystal pillars with water in 5 % of all new chunks. See Chunk Features.

Updating and removing

  • Updating: replace the jar and restart the server. Utility Biome stores no data of its own.
  • Removing: only remove Utility Biome together with every mod that depends on it, otherwise those mods will not load. Terrain that was already generated stays as it is.
Utility Biome
Installation · Commands · Biome Census · Version History
For modders: Modding API · Chunk Features · Structures · Build-Time Tools
Project page on mutigeraffe.com · Download on CurseForge