Dungeon Format

Overview

• metadata The metadata is an object containing global information about the dungeon. It consists of the following.
  • name : string Contains the dungeon's name as referred to in code.
  • species : string Contains the species that the dungeon belongs to. Its purpose is currently unknown.
  • rules See rules.
  • maxRadius : integer Theorized as the maximum radius of the dungeon spread.
  • maxParts : integer Theorized to be the maximum number of parts used by the dungeon.
  • anchor : list<string> The parts that the dungeon can spawn from (AKA heart or core of the dungeon).
  • gravity : integer (Optional) The amount of gravity that applies to the dungeon area.
  • protected : boolean (Optional, Default: false) Indicates that the dungeon tiles and objects are protected from being damaged by the players.
• tiles Information about tiles (brushes).
  • value : color The colour key of the brush in the image.
  • rules (Optional) See rules.
  • brush (Optional) See brushes.
  • connector : boolean (Optional) Used to connect with other parts.
  • connector-value : color (Optional) Not sure.
  • direction : string (Optional) Not sure.
  • comment : string Not actually used by Starbound.
• parts Information about parts (layers).
  • name : string Name of the part.
  • rules See rules.
  • chance : float (Optional) The chance of this part appearing. Default is 1.0.
  • def

Rules

The rules segment can apply to every level of the dungeon hierarchy. It is a list of lists of strings. Each list of strings can have a second member which is another list of some sort. A list of different rules is found below.

• worldGenMustContainSolid
• worldGenMustContainAir
• worldGenMustContainSolidBackground
• worldGenMustContainAirBackground
• allowOverdrawing
• ignorePartMaximumRule
• maxSpawnCount, [integer] Contains only a single integer in the list.
• doNotConnectToPart, [string] Contains a list of part names that this should not connect to.
• doNotCombineWith, [string] Contains a list of part names that this should not combine with, whatever that means.

Brushes

• clear Not sure.
• front, string,string | object The brush for the foreground. It can be either one of the following: 1. A string (the material name) and a second optional string for the mod. 2. An object describing the material. If it is an object type, it may contain the following information.
  • material : string The material name.
  • mod : string (Optional) The material modifier (ore).
  • hueshift : float (Optional) Not sure.
  • modhueshift : float (Optional) Not sure.
• back, string | object The brush for the background. It is the same format as front, without mod. That is, it can be either a string (the material name) or an object describing the material, containing the following fields:
  • material : string The material name.
  • hueshift : float (Optional) Not sure.
• object, string, object The brush for a game object. The first string contains the name of the game object. The second object is optional, containing the following optional information:
  • direction : string The facing direction (left/right).
  • parameters : object Parameters for objects.
• biomeitems Not sure.
• biometree A tree.
• item, Not sure. Contains an item descriptor.
• npc, Contains npc info.
• random, [] Contains a list of brushes and chooses one randomly.
• surface, object Not sure. Contains optional object with the following information.
  • variant : integer
• surfacebackground Not sure.
• liquid, string A liquid. The string contains the liquid type.
• wire, object Wiring. Object contains the following.
  • group : string
  • local : boolean
• playerstart Player spawn point.