Open Terrain Generator Wiki
No edit summary
Tag: Visual edit
No edit summary
Tag: Visual edit
Line 274: Line 274:
 
!Optional
 
!Optional
 
!None
 
!None
!A header to tell OTG that options below it are for game rules.
+
!A header to tell OTG that options below it are for game rules.
Used for Forge single player world creation menu if the file is named Modpack.yaml.
 
 
 
If not included, OTG will leave these settings default.
 
If not included, OTG will leave these settings default.
 
|-
 
|-

Revision as of 04:03, 4 November 2021

Note: This information is for OTG 1.16.5. For 1.12.2, see here.

The dimension & modpack configuration file is only used by Forge. If you are using PaperMC to run OTG, it is advised you set up your worlds/dimensions using a dimension management plugin such as Multiverse. Instructions for using Multiverse with OTG are here.

When using OTG with other Forge mods, be sure to check the Forge Mod Compatibility section for notes and setup instructions.

Introduction

The dimension configuration file is used to set up an OTG configuration for Forge Multiplayer servers and for modpacks (single and multiplayer). This config file defines which OTG presets are applied to worlds/dimensions, as well as seed and portal settings for OTG dimensions.

- For Forge single player, if a dimension config named "Modpack.yaml" is found in the ".minecraft/config/OpenTerrainGenerator/DimensionConfigs/" folder, the in game world creation menu is replaced by a custom screen that locks settings and uses the world/dimension settings from the Modpack.yaml, allowing users to create a new world with 1 click. This allows modpack makers to set up OTG in a predefined way, and ensures players use these settings every time they start an OTG world.

- For Forge multiplayer servers this file can be used by setting the .yaml's filename (without the .yaml extension) as generator-settings in the server.properties. When the MP server is started, the settings and dimensions in the .yaml file will be assigned and created automatically.

Creating a Dimension / Modpack Config

To create the config file, go to the ".minecraft/config/OpenTerrainGenerator/DimensionConfigs/" folder and create a new text file with a .yaml file extension. You may also rename one of the examples automatically generated in the folder the first time Minecraft is started with OTG installed.

The structure of this file is as follows:

Overworld:
  (Insert Overworld settings - see below)
Nether:
  (Insert Nether settings - see below)
End:
  (Insert End settings - see below)
Dimensions:
  (Insert Dimensions settings - see below)
Settings:
  (Insert Settings settings - see below)
GameRules:
  (Insert Gamerules settings - see below)


Most lines are optional so you can customize only what you need to. See the table at the bottom of this page for a full list and explanation of all of the options.

Below are some examples of what a completed config file could look like.

Example 1

OTG "Default" overworld with "Vanilla Vistas" OTG dimension:

Overworld:
  PresetFolderName: "Default"
Dimensions:
- PresetFolderName: "VanillaVistas"


Example 2

Vanilla "flat" overworld with "Vanilla Vistas" OTG dimension.

Overworld:
  NonOTGWorldType: "flat"
Dimensions:
- PresetFolderName: "VanillaVistas"


Example 3

Biomes O' Plenty overworld with OTG nether/end/dimensions:

Overworld:
  NonOTGWorldType: "biomesoplenty"
Nether:
  PresetFolderName: "Skylands"
End:
  PresetFolderName: "SkylandsTall"
Dimensions:
- PresetFolderName: "VanillaVistas"


Note: When using Biomes o' Plenty, set use_world_type = false in BoP's client.toml config file, otherwise OTG's custom world creation screen for modpack configs won't work properly.

Example 4

Vanilla "flat" overworld with OTG nether/end and dimensions and all settings included.

Version: 1
ModpackName: "My Awesome Modpack"
Overworld:
  NonOTGWorldType: "flat"
Nether:
  PresetFolderName: "AlienJungle"
End:
  PresetFolderName: "Skylands"
Dimensions:
- PresetFolderName: "Wildlands"
  Seed: 14
  PortalColor: "beige"
  PortalMob: "minecraft:zombified_piglin"
  PortalIgnitionSource: "minecraft:flint_and_steel"
  PortalBlocks: "minecraft:redstone_block"
- PresetFolderName: "VanillaVistas"
  Seed: 14
  PortalColor: "gold"
  PortalMob: "minecraft:zombified_piglin"
  PortalIgnitionSource: "minecraft:flint_and_steel"
  PortalBlocks: "minecraft:diamond_block"  
Settings:
  GenerateStructures: true
  BonusChest: false
GameRules:
  DoFireTick: true
  MobGriefing: true
  KeepInventory: false
  DoMobSpawning: true
  DoMobLoot: true
  DoTileDrops: true
  DoEntityDrops: true
  CommandBlockOutput: true
  NaturalRegeneration: true
  DoDaylightCycle: true
  LogAdminCommands: true
  ShowDeathMessages: true
  RandomTickSpeed: 3
  SendCommandFeedback: true
  SpectatorsGenerateChunks: true
  SpawnRadius: 10
  DisableElytraMovementCheck: false
  MaxEntityCramming: 24
  DoWeatherCycle: true
  DoLimitedCrafting: false
  MaxCommandChainLength: 65536
  AnnounceAdvancements: true
  DisableRaids: false
  DoInsomnia: true
  DrowningDamage: true
  FallDamage: true
  FireDamage: true
  DoPatrolSpawning: true
  DoTraderSpawning: true
  ForgiveDeadPlayers: true
  UniversalAnger: false


Full List Of Config Options

Parameter Optional Type Description
Version N/A Integer Version number of the modpack config. (Ignored at the moment - not yet implemented for 1.16.5)
ModpackName Optional String Shown as the title in single player OTG world creation menu if the file is named Modpack.yaml
Overworld Required None A header to tell OTG that options below it are for the Overworld
PresetFolderName Required

(unless NonOTGWorldType is used)

String Insert this line below the Overworld header to use an OTG preset as the overworld.

Input the name of the preset folder containing the OTG preset you want to use as the overworld.

This must match a preset folder name in ".minecraft\config\OpenTerrainGenerator\Presets".

See above for examples.

NonOTGWorldType Required

(unless PresetFolderName is used)

String Insert this line below the overworld header to use a non-OTG world as the overworld.

Input the name of the world type (same as server.properties level-type)

Note: When using Biomes o' Plenty, set use_world_type = false in BoP's client.toml config file, otherwise OTG's custom world creation screen for modpack configs won't work properly.

See above for examples

NonOTGGeneratorSettings Optional String Used with NonOTGWorldType. Insert this line if you want to provide a JSON string with settings for NonOTGWorldType, same as server.properties generator-settings.
Nether Optional None A header to tell OTG that options below it are for the Nether.

If not included, OTG will use the Vanilla Nether.

PresetFolderName Optional String Insert this line below the Nether header to use an OTG preset as the overworld.

Input the name of the preset folder containing the OTG preset you want to use as the overworld.

This must match a preset folder name in ".minecraft\config\OpenTerrainGenerator\Presets".

See above for examples.

End Optional None A header to tell OTG that options below it are for the End.

If not included, OTG will use the Vanilla End.

PresetFolderName Optional String Insert this line below the End header to use an OTG preset as the overworld.

Input the name of the preset folder containing the OTG preset you want to use as the overworld.

This must match a preset folder name in ".minecraft\config\OpenTerrainGenerator\Presets".

See above for examples.

Dimensions Optional None A header to tell OTG that options below it are for OTG dimensions.

If not included, OTG will not add any OTG dimensions.

If any of the below settings (other than PresetFolderName) are not included, settings from the preset's WorldConfig.ini are used instead.

- PresetFolderName Optional String Insert this line below the Dimensions header to use an OTG preset as a dimension.

Input the name of the preset folder containing the OTG preset you want to use as the overworld.

This must match a preset folder name in ".minecraft\config\OpenTerrainGenerator\Presets".

The "-" is required here as multiple dimensions can be added.

See above for examples.

Seed Optional Integer Can be set to -1 for a random seed. For the Overworld seed is ignored and taken from server.properties (MP) or world creation menu (SP). *In some cases, dimension seeds may be locked to overworld seed, still need to fix this.
PortalColor Optional String The color of the portal. Options are: beige, black, blue, crystalblue, darkblue, darkgreen, darkred, emerald, flame, gold, green, grey, lightblue, lightgreen, orange, pink, red, white, yellow, default.
PortalMob Optional ID The mob that occasionaly spawns from this portal, "minecraft:zombified_piglin" by default.
PortalIgnitionSource Optional ID The ignition source for the portal, usually "minecraft:flint_and_steel".
PortalBlocks Optional ID One or more blocks that can be used to build a portal. For example: "minecraft:stone, minecraft:dirt".
- PresetFolderName Optional String Repeat the above to add more dimensions.

See above for examples.

Settings Optional None A header to tell OTG that options below it are for world settings.

Used for Forge single player world creation menu if the file is named Modpack.yaml.

If not included, OTG will leave these settings default.

GenerateStructures Optional Boolean Set to True or False.
BonusChest Optional Boolean Set to True or False.
GameRules Optional None A header to tell OTG that options below it are for game rules.

If not included, OTG will leave these settings default.

List of various gamerules Optional Various See above examples for a list of game rules.