Maintenance script: BlockFactory wiki

2026-10-19T07:05:34Z

BlockFactory wiki

New page

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

== Where the files are ==
{| class="wikitable"
! File !! Server !! Singleplayer
|-
| World settings || <code>universe/worlds/<world>/config.json</code> || <code>Saves/<World>/universe/worlds/default/config.json</code>
|-
| Mod config || <code>mods/com.mutigeraffe_blockfactory/config.json</code> || <code>Saves/<World>/mods/com.mutigeraffe_blockfactory/config.json</code>
|}

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 <code>config.json</code> with all Block Factory values looks like this (other Hytale keys left out):

<pre>
{
"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
}
}
}
</pre>

== World generation ==
These keys live under <code>"WorldGen"</code>.

{| class="wikitable"
! Key !! Default !! Effect
|-
| <code>Type</code> || <code>BlockFactory</code> || Selects the Block Factory generator.
|-
| <code>LayoutVersion</code> || 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.
|-
| <code>ResourceFrequency</code> || 1.0 || How many ore fields appear outside the start area. 0 = none.
|-
| <code>ResourceSize</code> || 1.0 || Size of the ore fields, including the start fields.
|-
| <code>ResourceRichness</code> || 1.0 || Mining rate per block. Ore fields never run out.
|-
| <code>Resources</code> || empty || Optional factors per resource: <code>Frequency</code>, <code>Size</code> and <code>Richness</code>, each multiplied with the global values above (a missing factor counts as 1.0). Resource names: <code>Iron</code>, <code>Copper</code>, <code>Coal</code>, <code>Stone</code>, <code>Sand</code>, <code>Clay</code>, <code>Gold</code>, <code>Oil</code>, <code>Uranium</code>. An unknown name stops the world from loading (the reason is in the server log).
|-
| <code>NestDensity</code> || 1.0 || Density of enemy nests. 0 = no nests.
|-
| <code>NestFreeRadius</code> || 500 || Blocks around the spawn that stay free of nests.
|-
| <code>CreatedWith</code> || 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 <code>Seed</code> 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 <code>config.json</code> '''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 (<code>ResourceFrequency</code>, <code>ResourceSize</code>, <code>ResourceRichness</code>, <code>Resources</code>) 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 ==
<code>IsPvpEnabled</code> is Hytale's own key at the top level. The other rules live under <code>"Plugin"</code> → <code>"BlockFactory"</code>.

{| class="wikitable"
! Key !! Default !! Effect
|-
| <code>IsPvpEnabled</code> || false || PvP. Also required for raids, and lets towers shoot at players of other teams.
|-
| <code>Peaceful</code> || 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 [[BlockFactory:Enemies|Enemies]].
|-
| <code>Raids</code> || true || Teams may damage and loot other teams' buildings (only with <code>IsPvpEnabled</code>). Destroyed buildings leave a ghost.
|-
| <code>StartProtectionHours</code> || 2.0 || Hours after founding during which a team cannot be raided.
|-
| <code>OfflineProtection</code> || false || A team with no member online cannot be raided.
|-
| <code>AbandonedAfterDays</code> || 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.
|-
| <code>Radiation</code> || false || An exploded nuclear reactor leaves a radiated area for 20 minutes that hurts players inside. See [[BlockFactory:Nuclear Power|Nuclear Power]].
|}

See [[BlockFactory:Teams and Raids|Teams and Raids]] for how teams and raids play.

== Mod config: research test duration ==
The mod's own <code>config.json</code> is created on the first start and applies to the whole server, or to the one singleplayer world. It sets how long the [[BlockFactory:Research|Outlander Test Site]] needs to test each research.

<pre>
{
"SecondsPerScroll": 30,
"ResearchSeconds": {
"BF_Research_Steam_Power": 30,
"BF_Research_Logistics": 60
}
}
</pre>

{| class="wikitable"
! Key !! Default !! Effect
|-
| <code>SecondsPerScroll</code> || 30 || Test duration per Knowledge Scroll that a research costs.
|-
| <code>ResearchSeconds</code> || filled in by the mod || Test duration per research in seconds (at least 1). On start, the mod adds every missing research with <code>SecondsPerScroll</code> × its scrolls. Values already in the file are kept.
|}

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

== See also ==
* [[BlockFactory:Commands|Commands]]
* [[BlockFactory:Teams and Raids|Teams and Raids]]
* [[BlockFactory:The World|The World]]
* [[BlockFactory:Research|Research]]

{{BlockFactory Nav}}

BlockFactory:World Settings - Revision history

Maintenance script: BlockFactory wiki