BlockFactory:World Settings

From MutigerAffe Wiki
Jump to navigation Jump to search

This page is for server operators and singleplayer hosts. Block Factory has two kinds of settings: the world settings in the world's config.json (world generation and game rules), and a separate mod config for the research test durations.

Where the files are

File Server Singleplayer
World settings universe/worlds/<world>/config.json Saves/<World>/universe/worlds/default/config.json
Mod config mods/com.mutigeraffe_blockfactory/config.json Saves/<World>/mods/com.mutigeraffe_blockfactory/config.json

Missing values are filled in with their defaults when the server starts. Edit the files only while the server is stopped or the singleplayer world is closed.

World settings example

Block Factory registers its own world generator with a higher priority than Hytale's, so every new world uses it. A world config.json with all Block Factory values looks like this (other Hytale keys left out):

{
  "Seed": 123456789,
  "WorldGen": {
    "Type": "BlockFactory",
    "LayoutVersion": 6,
    "ResourceFrequency": 1.0,
    "ResourceSize": 1.0,
    "ResourceRichness": 1.0,
    "Resources": {
      "Uranium": { "Frequency": 2.0 },
      "Iron": { "Size": 1.5, "Richness": 0.5 }
    },
    "NestDensity": 1.0,
    "NestFreeRadius": 500,
    "CreatedWith": "1.0;1.0;1.0"
  },
  "IsPvpEnabled": false,
  "Plugin": {
    "BlockFactory": {
      "Peaceful": false,
      "Raids": true,
      "StartProtectionHours": 2.0,
      "OfflineProtection": false,
      "AbandonedAfterDays": 14,
      "Radiation": false
    }
  }
}

World generation

These keys live under "WorldGen".

Key Default Effect
Type BlockFactory Selects the Block Factory generator.
LayoutVersion 6 (set by the mod) The layout version the world was generated with. Do not change. If a newer Block Factory version generates worlds differently, a world with another version refuses to load and the server log says why. Keep playing with the old version or start a new world.
ResourceFrequency 1.0 How many ore fields appear outside the start area. 0 = none.
ResourceSize 1.0 Size of the ore fields, including the start fields.
ResourceRichness 1.0 Mining rate per block. Ore fields never run out.
Resources empty Optional factors per resource: Frequency, Size and Richness, each multiplied with the global values above (a missing factor counts as 1.0). Resource names: Iron, Copper, Coal, Stone, Sand, Clay, Gold, Oil, Uranium. An unknown name stops the world from loading (the reason is in the server log).
NestDensity 1.0 Density of enemy nests. 0 = no nests.
NestFreeRadius 500 Blocks around the spawn that stay free of nests.
CreatedWith set by the mod The resource settings the world was created with, written on the first start. Do not change.

The world seed is Hytale's own Seed key at the top level of the file. The layout of ore fields, nests and ruins is calculated from it.

Change generator settings before the first start

Generator settings only affect chunks that are generated after the change, and the very first start already generates the chunks around the spawn. So either:

  • create the config.json before the first start, containing only the values you want to change, or
  • regenerate the world after changing them: stop the server and delete the world folder.

The resource settings (ResourceFrequency, ResourceSize, ResourceRichness, Resources) are locked once the world exists. Later changes are ignored with a warning in the server log, because the ore fields in old chunks would no longer match hand mining and drills. To play with other values, start a new world.

Game rules

IsPvpEnabled is Hytale's own key at the top level. The other rules live under "Plugin" → "BlockFactory".

Key Default Effect
IsPvpEnabled false PvP. Also required for raids, and lets towers shoot at players of other teams.
Peaceful false Peaceful mode: nests send no attack groups, do not spread and have no guards; War Golems stay calm and do not attack buildings. See Enemies.
Raids true Teams may damage and loot other teams' buildings (only with IsPvpEnabled). Destroyed buildings leave a ghost.
StartProtectionHours 2.0 Hours after founding during which a team cannot be raided.
OfflineProtection false A team with no member online cannot be raided.
AbandonedAfterDays 14 After this many days with no member online, a team's factory is ownerless: it stands still and can be raided despite start and offline protection. 0 turns the time limit off.
Radiation false An exploded nuclear reactor leaves a radiated area for 20 minutes that hurts players inside. See Nuclear Power.

See Teams and Raids for how teams and raids play.

Mod config: research test duration

The mod's own config.json is created on the first start and applies to the whole server, or to the one singleplayer world. It sets how long the Outlander Test Site needs to test each research.

{
  "SecondsPerScroll": 30,
  "ResearchSeconds": {
    "BF_Research_Steam_Power": 30,
    "BF_Research_Logistics": 60
  }
}
Key Default Effect
SecondsPerScroll 30 Test duration per Knowledge Scroll that a research costs.
ResearchSeconds filled in by the mod Test duration per research in seconds (at least 1). On start, the mod adds every missing research with SecondsPerScroll × its scrolls. Values already in the file are kept.

To make all research faster or slower, delete the ResearchSeconds block and change SecondsPerScroll; the mod writes the new durations on the next start. The file is only read at start.

See also

Block Factory
Start Installation · Getting Started
Basics Controls and Building · Gathering and Crafting · Field Manual and HUD · The World
Progression Epochs · Research · Portal of the Ancient · Great Portal
Factory Belts · Grabbers · Storage · Mining · Smelting · Fabricators · Hunting and Farming
Power and fluids Power · Fluids · Oil Processing · Nuclear Power · Rune Modules
Trains and logic Railways · Signals and Programmable Interface · Vehicles
Workers Goblins · Goblin Planner · Golems · Outlanders
Danger Enemies · Defense · Weapons and Armor · Death and Respawn
Multiplayer and servers Teams and Raids · Commands · World Settings
Reference Buildings · Items · Recipes · Research Tree
Project page on mutigeraffe.com · Download on CurseForge