RimWorld Wiki - User contributions [en]

Modding Tutorials/Biomes

2026-05-06T01:54:17Z

Halicade: updated IncidentDefs text

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as different places that a biome is taken into consideration.

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a <code>workerClass</code> defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can appear on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can appear on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[forage]]d per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage ([[Odyssey]]{{OdysseyIcon}}).
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
If this is false and the tile you are in is not a mixed biome, total plant population is based on the whole map rather than a 20 cell radius. Defauilts to true.
|-
| <source lang="xml">
<wildPlantsAreCavePlants>true</wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
Cave plants have their own weight which is used to place them in caves. This makes it so the weight defined in <code>wildPlants</code> is used instead.
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
<MCP_MyCustomPlant MayRequire="username.CustomPlantMod">0.3</MCP_MyCustomPlant>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on an plants properties. Duplicates are not allowed between the two. Plants that appear due to pollution appear in this list as well. Disable <wildPlantsAreCavePlants> to have weights defined here affect cave plants.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
<MCA_MyCustomAnimal MayRequire="username.CustomAnimalMod">0.3</MCP_MyCustomanimal>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on an animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees as well as Royalty intro quests. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused field that is located on Ocean and Lake biomes.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world maps tile. Defaults to true. Note that this tile can still be polluted while on the map tile or by sending a drop-pod of wastepacks to the area.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animals will not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
If false, When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen. If a category is not present, no fish from that category will appear. Despite there being a <code>1</code> to indicate chance, this field is not utilized.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via the BiomeDefs <code>generatesNaturally</code>, and the BiomeWorkers <code>CanPlaceOnLayer</code>, it's score is calculated from the individual biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

=== Biome Generation ===

There is no right or wrong way to create the score for biomes. If you look at biome workers, many of them will use different formula or logic to appear on the map. Here is an example used from the mod [https://github.com/Halicade/GuldenBiome/blob/master/Source/BiomeWorker.cs| Gulden Biome (Continued)].

<source lang="cs">
// We are subclassing the temperate forest biome worker
public class BiomeWorker_GuldenForest : BiomeWorker_TemperateForest
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to completely overwrite the parent biome.
// That's why we only want tiles with an elevation between 500 and 800.
if (tile.elevation is <= 500 or >= 800) {
return 0;
}

// Get what the score is of the parent biome, temperate forest
float score = base.GetScore(biome, tile, planetTile);
// If that score is 0 or less we don't want this biome there.
if (score <= 0) {
return 0;
}

// We add 1.5 so that it is higher than the temperate forest.
// We don't want this number too large, otherwise it will overwrite other biomes.
return score + 1.5f;
}
}
</source>

=== Using Rand ===

If you want a biome to appear randomly around the world map, you need to seed your Rand value. Without this, if you were to regenerate the world using the same world seed, your biome would appear in different tiles. You can use <code>Rand.PushState</code> and <code>Rand.PopState</code>. Or you can use <code>Rand.ValueSeeded</code> or any other method that allows for a seeded outcome. This below example comes from multiple different sources and was rewritten here for better understanding.

<source lang="cs">
public class BiomeWorker_MyCustomBiome : BiomeWorker
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to generate on water.
if (tile.WaterCovered) {
return -100f;
}
// We don't want to generate where it's too cold
if (tile.temperature < -10f) {
return 0f;
}
//We don't want to generate where there is a lot of rain
if (tile.rainfall < 600f) {
return 0f;
}

// We use the tileId as part of the seed to get a constant for each tile.
// "^" is to perform a bitwise XOR operation
// 0x11245d7a is a random hexadecimal value
// We add these last two pieces so that if another mod randomly generates their tiles, the values won't be the same
// If our random value is above 0.009 we won't generate here
// This might seem like a small amount, but there is over 100,000 tiles on a map with 30% coverage so the odds are quite high
if (Rand.ValueSeeded(planetTile.tileId ^ 0x11245d7a) > 0.009f) {
return 0f;
}

// A formula to calculate the score at this tile.
return (float)(16.0 + (tile.temperature - 7.0) + (tile.rainfall - 600.0) / 180.0);
}
}
</source>

== About Terrain modifiers ==

There are many terrain modifiers like <code>lakeBeachTerrain</code> and <code>gravelTerrain</code>. These are used by MapGenUtility to get the appropriate terrain at a specific cell. These can change depending on if you have a [[Landmarks#Mixed_biome|mixed biome]]{{OdysseyIcon}} or a <code>tileMutatorDef</code> that overrides a terrain such as <code>overrideLakeBeachTerrain</code>. Note that not every terrain modifier has an equivalent override. Some specific terrain may be hardcoded.

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>. Additionally, you are not able to set their pollution appearance rate or coastal appearance rate through their properties field either.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.

Some incidents have <code>allowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland. Affected incidents include <code>AmbrosiaSprout</code>, <code>HerdMigration</code>, <code>Alphabeavers</code>, <code>VolcanicAsh</code>, <code>LavaEmergence</code>{{OdysseyIcon}}, <code>LavaFlow</code>{{OdysseyIcon}}, <code>VolcanicDebris</code>{{OdysseyIcon}}, <code>BoomshroomSprout</code>{{OdysseyIcon}}, <code>BioluminescentSpores</code>{{OdysseyIcon}}, <code>DroughtInitial</code>{{OdysseyIcon}}, and <code>Drought</code>{{OdysseyIcon}}

<code>GauranlenPodSpawn</code>{{IdeologyIcon}} is the only incident that makes use of <code>disallowedBiomes</code>.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact on gameplay.

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

[[Category:Modding tutorials]]

Modding Tutorials/Mod Folder Structure

2026-05-03T16:22:25Z

Halicade: _steam applies to 1.5 versions and below

{{DISPLAYTITLE:Mod Folder Structure}}

{{BackToTutorials}}

This is a guide explaining the contents of mod folders and best practices for how they should be laid out for proper recognition by RimWorld as well as compatibility with other mods.

== RimWorld Mod Folder ==

Your local <code>Mods</code> folder for manually installed mods as well as new local mods can be found in the following default installation locations:

{| class="wikitable" style="margin-right:auto"
|-
! Operating System !! Default Folder Location
|-
| Windows || <code>C:\Program Files (x86)\Steam\steamapps\common\RimWorld\Mods</code>
|-
| Mac || <code>~/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Mods</code>
|-
| Linux (standalone) || <code>~/.steam/steam/steamapps/common/RimWorld/Mods</code>
|-
| Linux (GoG) || <code>/home/<user>/GOG/Games/RimWorld/game/Mods/</code>
|}

Each mod should have its own subfolder within the main <code>Mods</code> folder. The name of individual mod folders does not matter and you can name them freely for your own personal organization; your mod's internal ID and title are defined in [[Modding_Tutorials/About.xml|About.xml]] (see below). Unless specified otherwise, all specific files mentioned below must be capitalized and spelled correctly or RimWorld will not recognize them.

=== Example Mod Folder ===

The following is an example of a mod folder with all recognized subfolders:

<source>
Mods
└ MyModFolder
├ About
│ ├ About.xml
│ └ Preview.png
├ Assemblies
├ Defs
├ Languages
├ Patches
├ Sounds
└ Textures

</source>

== <code>About</code> (Required) ==

The only folder required for all mods, the <code>About</code> folder contains information that identifies your mod to RimWorld and allows it to be loaded.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! Name !! Description
|-
| class="TutorialCodeTable-description" |
<code>About.xml</code>
'''(Required)'''
| class="TutorialCodeTable-description" |
''See: [[Modding_Tutorials/About.xml|About.xml]]''

<code>About.xml</code> is used to identify a mod to RimWorld so it can be loaded, and can also be used to specify dependencies and load order helpers for mod compatibility. Please see the [[Modding_Tutorials/About.xml|full guide]] for more information.
|-
| class="TutorialCodeTable-description" |
<code>Preview.png</code>
'''(Required)'''
| class="TutorialCodeTable-description" |
A mod's <code>Preview.png</code> is used as the preview image for that mod in both the in-game mod manager as well as Steam Workshop. It is strongly recommended to use a 640x360 PNG file as this is the default size and aspect ratio (16/9) configured for RimWorld and using other sizes may result in blurring or letterboxing. You can also opt to use 1280x720 for higher resolution artwork, but '''preview files must remain under 1MB or Steam Workshop will reject your upload'''. If you get a "limit exceeded" error, then double-check the size of your <code>Preview.png</code>.

'''Note''': While PNG files are standard, RimWorld does not actually require a PNG file. It is possible to use JPG or even animated GIF files by simply renaming them "Preview.png", but the PNG extension must be used or RimWorld will not recognize it.
|-
| class="TutorialCodeTable-description" |
<code>ModIcon.png</code>
''(Optional)''
| class="TutorialCodeTable-description" |
New in RimWorld 1.5, a mod's <code>ModIcon.png</code> is shown during game loading screens and in the Options UI if your mod has [[Modding_Tutorials/ModSettings|mod settings]]. It should be either a 32x32 or 64x64 PNG file, and too much detail or color should be avoided; Unity texture compression will make overcomplicated icons very crunchy.
|-
| class="TutorialCodeTable-description" |
<code>Manifest.xml</code>
''(Obsolete)''
| class="TutorialCodeTable-description" |
You may see a <code>Manifest.xml</code> file in some older mods. This was a file used by [https://steamcommunity.com/sharedfiles/filedetails/?id=1507748539 Fluffy's Mod Manager] as well as some external mod managers for dependency and versioning information in older versions of RimWorld. This is generally considered obsolete as the most important benefits of having a manifest file have largely been mainlined into <code>About.xml</code>; you do not need this file unless you want specific additional features provided by Mod Manager.
|-
|}
</div>

== <code>Assemblies</code> ==

The <code>Assemblies</code> folder can be used to add custom code to RimWorld in the form of compiled [https://en.wikipedia.org/wiki/Dynamic-link_library dynamic-link library] or DLL files. Properly compiled assemblies will be automatically loaded by RimWorld.

== <code>Defs</code> ==

''See: [[Modding_Tutorials/Defs|Defs]]''

'''XML Definitions''' or '''Defs''' are the primary content definition and configuration source for RimWorld. These Defs define everything from items and plants and animals to faction types and ideoligion options, and as a general rule any mod that adds additional content for RimWorld will likely be adding one or more Defs. Please see the [[Modding_Tutorials/Defs|Def guide]] for more detailed information.

Subfolders and even file names within the <code>Defs</code> does not matter as all XML files are read into memory from each individual mod and you can freely name them however you want for your own personal organization, however it is recommended that you follow vanilla conventions (<code>SoundDef</code>s in the <code>/SoundDefs</code> folder, <code>ThingDef</code>s in the various <code>/ThingDef_***</code> folders) for readability. The one exception to this is if you are using versioned <code>LoadFolders.xml</code> entries: XML files with the same resolved path will overwrite each other, with the last one to be loaded taking precedence.

== <code>Languages</code> ==

''See: [[Modding_Tutorials/Localization|Localization]]''

'''[https://en.wikipedia.org/wiki/Internationalization_and_localization Localization]''' is the process of creating and translating game and mod language content for different languages. This includes both translations for Defs and code-referenced text as well as word list for procedural name and content generation. Please see the [[Modding_Tutorials/Localization|localization guide]] for more information about the <code>Languages</code> folder and its subfolders.

== <code>Patches</code> ==

''See: [[Modding_Tutorials/PatchOperations|PatchOperations]]''

'''<code>PatchOperations</code>''' are a way of modifying Defs from the vanilla game, DLCs, or even other mods in a safe and interoperable manner. This can be used to rebalance or adjust vanilla content, remove or disable unwanted content, or provide optional changes or content for better mod compatibility. Please see the [[Modding_Tutorials/PatchOperations|PatchOperations guide]] for more information.

== <code>Sounds</code> ==

''See: [[Modding_Tutorials/Sounds|Sounds]]''

The <code>Sounds</code> folder is used to hold custom sound files for mods. It is generally recommended to use [https://en.wikipedia.org/wiki/Ogg Ogg files], though Unity can also recognize and use MP3 and WAV files. Please see the [[Modding_Tutorials/Sounds|Sounds guide]] for more information.

Just like textures, sound files in RimWorld are identified by their path names; if a mod contains a sound file with the same path and file name as another mod or even the vanilla game or DLCs, then the last one to be loaded in your mod list will overwrite the others. This is sometimes done intentionally by mods that want to change vanilla or other mod's audio.

To avoid accidental collisions, it's recommended to prefix either your file names or use a namespace folder to reduce the chance that you have the exact same path as another mod:

<source>
Mods
└ MyModFolder
└ Sounds
└ MyNamespace
├ MyCustomSound.ogg
└ AnotherCustomSound.ogg
</source>

== <code>Textures</code> ==

''See: [[Modding_Tutorials/Textures|Textures]]''

The <code>Textures</code> folder is used to hold custom texture files for mods. It is generally recommended to use [https://en.wikipedia.org/wiki/PNG PNG files]. Please see the [[Modding_Tutorials/Textures|Textures guide]] for more information.

Just like sounds, texture files in RimWorld are identified by their path names; if a mod contains a texture file with the same path and file name as another mod or even the vanilla game or DLCs, then the last one to be loaded in your mod list will overwrite the others. This is sometimes done intentionally by re-texture mods that want to change textures from the vanilla game or other mods.

To avoid accidental collisions, it's recommended to prefix either your file names or use a namespace folder to reduce the chance that you have the exact same path as another mod:

<source>
Mods
└ MyModFolder
└ Textures
└ MyNamespace
├ MyCustomTexture.png
└ AnotherCustomTexture.png
</source>

== Versioned Folders (Optional) ==

''Note: It is strongly recommended that you do not declare support for versions of RimWorld that you do not personally test every release with, as RimWorld code and XML has changed in significant ways between every version.''

Content for specific versions of RimWorld can be implemented by placing them in folders named after their minor version numbers:

<source>
Mods
└ MyModFolder
├ 1.4
│ ├ Assemblies
│ ├ Defs
| ├ Languages
│ ├ Sounds
│ ├ Patches
│ └ Textures
├ 1.3
│ └ ...
├ 1.2
│ └ ...
├ 1.1
│ └ ...
│
├ Common
│ └ ...
│
├ About
├ Defs
├ Languages
├ Sounds
├ Patches
└ Textures
</source>

* All versioned folders and the <code>Common</code> folder can contain all normal root folders other than the <code>About</code> folder.
* '''For RimWorld 1.1 and later''', the game will load the first versioned folder that is compatible with the version of the game. Thus, if you only had folders for <code>1.4</code> and <code>1.2</code>, then RimWorld v1.4 would load the <code>1.4</code> folder, while RimWorld v1.3 and v1.2 would both load the <code>1.2</code> folder. All versions will also load <code>Common</code> and any direct root folders.
* '''For RimWorld 1.0 only''', the game does not recognize the <code>Common</code> folder. RimWorld v1.0 is capable of recognizing a <code>1.0</code> folder, but if it is used then the game '''WILL NOT''' load from the root folder; for mods that support RimWorld v1.0, it is typically recommended that content be placed into root folders and override content for newer versions be placed into versioned folders.
* Files with the same relative path will overwrite each other, with the most specific one taking precedence; this applies to XML files (both Def and Patch files), audio files, language files, and textures. Thus, if you have <code>Defs/MyFile.xml</code>, <code>Common/Defs/MyFile.xml</code>, and <code>1.4/Defs/MyFile.xml</code>, only the last one will be read.

== <code>LoadFolders.xml</code> (Optional) ==

Specific rules for which folders are loaded for which version of the game, as well as optional folders to be loaded for specific DLCs or mods can be specified by using a special file called <code>LoadFolders.xml</code>. This file should be placed in your root mod folder:

<source>
Mods
└ MyModFolder
└ LoadFolders.xml
</source>

<code>LoadFolders.xml</code> allows you to specify exactly which folders should be loaded for given versions of RimWorld. '''This supersedes the default versioned folder rules as specified above for all versions of RimWorld except v1.0''', which means that you will need to specify the root or <code>Common</code> folders if you wish to use them. An example file is shown here:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<loadFolders>
<v1.3>
<li>/</li>
<li>1.3</li>
<li IfModActive="Ludeon.RimWorld.Ideology">Ideology/1.3</li>
<li IfModActive="CETeam.CombatExtended">CombatExtended/1.3</li>
</v1.3>
<v1.4>
<li>/</li>
<li>1.4</li>
<li IfModActive="Ludeon.RimWorld.Ideology">Ideology/1.4</li>
<li IfModActive="Ludeon.RimWorld.Biotech">Biotech/1.4</li>
<li IfModActive="CETeam.CombatExtended">CombatExtended/1.4</li>
</v1.4>
</loadFolders>
</source>

This example file specifies that the root folder and a versioned folder should be loaded for RimWorld v1.3 and v1.4, and optionally loads extra folders based on whether the [[Ideology]] DLC and/or Combat Extended mods are loaded. This might correspond to a mod folder structure as follows:

<source>
Mods
└ MyModFolder
├ 1.4
│ ├ Assemblies
│ ├ Defs
│ └ Patches
├ 1.3
│ └ ...
│
├ Ideology
│ ├ 1.4
│ │ └ ...
│ └ 1.3
│ └ ...
├ Biotech
│ └ 1.4
│ └ ...
├ CombatExtended
│ ├ 1.4
│ │ └ ...
│ └ 1.3
│ └ ...
│
├ About
├ Sounds
├ Textures
└ LoadFolders.xml
</source>

* You can also use <code>IfModNotActive</code> to specify that a folder should be loaded if the target DLC or mod is not active:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<loadFolders>
<v1.6>
<li>/</li>
<li>1.6</li>

<li IfModNotActive="Ludeon.RimWorld.Odyssey">CustomBiomes</li>

<li IfModActive="Ludeon.RimWorld.Odyssey">Odyssey</li>
</v1.6>
</loadFolders>
</source>

* Folders that should be loaded if mods and DLCs are ''not'' loaded can also be specified using <code>IfModNotActive</code>.
* Individual <code>IfModActive</code> attribute values can also contain multiple values separated by commas. <code>IfModActive</code> and <code>IfModNotActive</code> are treated as an "or", whereas <code>IfModActiveAll</code> (new in RimWorld 1.6) is treated as an "and":

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<loadFolders>
<v1.6>
<li>/</li>
<li>1.6</li>

<li IfModActive="Dubwise.DubsBadHygiene,Dubwise.DubsBadHygiene.Lite">DBH</li>

<li IfModActiveAll="Ludeon.RimWorld.Biotech,Ludeon.RimWorld.Odyssey">SpaceXenotypes</li>
</v1.6>
</loadFolders>
</source>

* If you have files with the same relative path, then the last one specified by your load order will be used. Thus in the above example setup, if you had <code>Defs/MyFile.xml</code>, <code>1.4/Defs/MyFile.xml</code>, and <code>Ideology/1.4/Defs/MyFile.xml</code>, then the Ideology version would be loaded. This applies to all XML files (both Defs and Patches), Sounds, Textures, and Language files.
* (Applies to 1.5 and below) If you have both a local version of the mod, as well as the steam version, you will need to qualify the steam version with <code>_steam</code> for requiring it to test out compatibility with the steam version. In the example above, <code>IfModActive="CETeam.CombatExtended"</code> would become <code>IfModActive="CETeam.CombatExtended,CETeam.CombatExtended_steam"</code> to support both a local mod version of Combat Extended as well as the steam version.

== Miscellaneous ==

The <code>Core</code> game as well as all DLC folders are functionally identical to mod folders with the exception that official content textures and sound files are bundled into a Unity asset bundle rather than being saved directly to their respective folders. You can find these under the <code>/Data</code> folder inside your RimWorld directory.

=== <code>Source</code> Files ===

Some mods contain a <code>Source</code> folder containing the source code for their compiled assemblies. This is not read by RimWorld in any way but can be included if you wish to share the source code for your assemblies, but it is strongly recommended that you use a public code repository such as [https://github.com/ GitHub] instead as it's easier to read at a glance and shows changes over time that can help diagnose issues and bugs.

[[Category:Modding]]
[[Category:Modding tutorials]]

Modding Tutorials/Biomes

2026-05-03T16:19:20Z

Halicade: /* Fields */

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as different places that a biome is taken into consideration.

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a <code>workerClass</code> defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can appear on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can appear on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[forage]]d per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage ([[Odyssey]]{{OdysseyIcon}}).
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
If this is false and the tile you are in is not a mixed biome, total plant population is based on the whole map rather than a 20 cell radius. Defauilts to true.
|-
| <source lang="xml">
<wildPlantsAreCavePlants>true</wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
Cave plants have their own weight which is used to place them in caves. This makes it so the weight defined in <code>wildPlants</code> is used instead.
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
<MCP_MyCustomPlant MayRequire="username.CustomPlantMod">0.3</MCP_MyCustomPlant>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on an plants properties. Duplicates are not allowed between the two. Plants that appear due to pollution appear in this list as well. Disable <wildPlantsAreCavePlants> to have weights defined here affect cave plants.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
<MCA_MyCustomAnimal MayRequire="username.CustomAnimalMod">0.3</MCP_MyCustomanimal>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on an animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees as well as Royalty intro quests. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused field that is located on Ocean and Lake biomes.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world maps tile. Defaults to true. Note that this tile can still be polluted while on the map tile or by sending a drop-pod of wastepacks to the area.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animals will not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
If false, When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen. If a category is not present, no fish from that category will appear. Despite there being a <code>1</code> to indicate chance, this field is not utilized.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via the BiomeDefs <code>generatesNaturally</code>, and the BiomeWorkers <code>CanPlaceOnLayer</code>, it's score is calculated from the individual biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

=== Biome Generation ===

There is no right or wrong way to create the score for biomes. If you look at biome workers, many of them will use different formula or logic to appear on the map. Here is an example used from the mod [https://github.com/Halicade/GuldenBiome/blob/master/Source/BiomeWorker.cs| Gulden Biome (Continued)].

<source lang="cs">
// We are subclassing the temperate forest biome worker
public class BiomeWorker_GuldenForest : BiomeWorker_TemperateForest
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to completely overwrite the parent biome.
// That's why we only want tiles with an elevation between 500 and 800.
if (tile.elevation is <= 500 or >= 800) {
return 0;
}

// Get what the score is of the parent biome, temperate forest
float score = base.GetScore(biome, tile, planetTile);
// If that score is 0 or less we don't want this biome there.
if (score <= 0) {
return 0;
}

// We add 1.5 so that it is higher than the temperate forest.
// We don't want this number too large, otherwise it will overwrite other biomes.
return score + 1.5f;
}
}
</source>

=== Using Rand ===

If you want a biome to appear randomly around the world map, you need to seed your Rand value. Without this, if you were to regenerate the world using the same world seed, your biome would appear in different tiles. You can use <code>Rand.PushState</code> and <code>Rand.PopState</code>. Or you can use <code>Rand.ValueSeeded</code> or any other method that allows for a seeded outcome. This below example comes from multiple different sources and was rewritten here for better understanding.

<source lang="cs">
public class BiomeWorker_MyCustomBiome : BiomeWorker
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to generate on water.
if (tile.WaterCovered) {
return -100f;
}
// We don't want to generate where it's too cold
if (tile.temperature < -10f) {
return 0f;
}
//We don't want to generate where there is a lot of rain
if (tile.rainfall < 600f) {
return 0f;
}

// We use the tileId as part of the seed to get a constant for each tile.
// "^" is to perform a bitwise XOR operation
// 0x11245d7a is a random hexadecimal value
// We add these last two pieces so that if another mod randomly generates their tiles, the values won't be the same
// If our random value is above 0.009 we won't generate here
// This might seem like a small amount, but there is over 100,000 tiles on a map with 30% coverage so the odds are quite high
if (Rand.ValueSeeded(planetTile.tileId ^ 0x11245d7a) > 0.009f) {
return 0f;
}

// A formula to calculate the score at this tile.
return (float)(16.0 + (tile.temperature - 7.0) + (tile.rainfall - 600.0) / 180.0);
}
}
</source>

== About Terrain modifiers ==

There are many terrain modifiers like <code>lakeBeachTerrain</code> and <code>gravelTerrain</code>. These are used by MapGenUtility to get the appropriate terrain at a specific cell. These can change depending on if you have a [[Landmarks#Mixed_biome|mixed biome]]{{OdysseyIcon}} or a <code>tileMutatorDef</code> that overrides a terrain such as <code>overrideLakeBeachTerrain</code>. Note that not every terrain modifier has an equivalent override. Some specific terrain may be hardcoded.

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>. Additionally, you are not able to set their pollution appearance rate or coastal appearance rate through their properties field either.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.
Some incidents have <code>sallowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact on gameplay.

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

[[Category:Modding tutorials]]

Modding Tutorials/Biomes

2026-03-16T02:12:51Z

Halicade: Added info about using Rand

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as different places that a biome is taken into consideration.

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a <code>workerClass</code> defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can appear on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can appear on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[forage]]d per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage ([[Odyssey]]{{OdysseyIcon}}).
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
If this is false and the tile you are in is not a mixed biome, total plant population is based on the whole map rather than a 20 cell radius. Defauilts to true.
|-
| <source lang="xml">
<wildPlantsAreCavePlants>true</wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
Cave plants have their own weight which is used to place them in caves. This makes it so the weight defined in <code>wildPlants</code> is used instead.
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
<MCP_MyCustomPlant MayRequire="username.CustomPlantMod">0.3</MCP_MyCustomPlant>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on an plants properties. Duplicates are not allowed between the two. Plants that appear due to pollution appear in this list as well.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
<MCA_MyCustomAnimal MayRequire="username.CustomAnimalMod">0.3</MCP_MyCustomanimal>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on an animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused field that is located on Ocean and Lake biomes.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world maps tile. Defaults to true. Note that this tile can still be polluted while on the map tile or by sending a drop-pod of wastepacks to the area.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animals will not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
If false, When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen. If a category is not present, no fish from that category will appear. Despite there being a <code>1</code> to indicate chance, this field is not utilized.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via the BiomeDefs <code>generatesNaturally</code>, and the BiomeWorkers <code>CanPlaceOnLayer</code>, it's score is calculated from the individual biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

=== Biome Generation ===

There is no right or wrong way to create the score for biomes. If you look at biome workers, many of them will use different formula or logic to appear on the map. Here is an example used from the mod [https://github.com/Halicade/GuldenBiome/blob/master/Source/BiomeWorker.cs| Gulden Biome (Continued)].

<source lang="cs">
// We are subclassing the temperate forest biome worker
public class BiomeWorker_GuldenForest : BiomeWorker_TemperateForest
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to completely overwrite the parent biome.
// That's why we only want tiles with an elevation between 500 and 800.
if (tile.elevation is <= 500 or >= 800) {
return 0;
}

// Get what the score is of the parent biome, temperate forest
float score = base.GetScore(biome, tile, planetTile);
// If that score is 0 or less we don't want this biome there.
if (score <= 0) {
return 0;
}

// We add 1.5 so that it is higher than the temperate forest.
// We don't want this number too large, otherwise it will overwrite other biomes.
return score + 1.5f;
}
}
</source>

=== Using Rand ===

If you want a biome to appear randomly around the world map, you need to seed your Rand value. Without this, if you were to regenerate the world using the same world seed, your biome would appear in different tiles. You can use <code>Rand.PushState</code> and <code>Rand.PopState</code>. Or you can use <code>Rand.ValueSeeded</code> or any other method that allows for a seeded outcome. This below example comes from multiple different sources and was rewritten here for better understanding.

<source lang="cs">
public class BiomeWorker_MyCustomBiome : BiomeWorker
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to generate on water.
if (tile.WaterCovered) {
return -100f;
}
// We don't want to generate where it's too cold
if (tile.temperature < -10f) {
return 0f;
}
//We don't want to generate where there is a lot of rain
if (tile.rainfall < 600f) {
return 0f;
}

// We use the tileId as part of the seed to get a constant for each tile.
// "^" is to perform a bitwise XOR operation
// 0x11245d7a is a random hexadecimal value
// We add these last two pieces so that if another mod randomly generates their tiles, the values won't be the same
// If our random value is above 0.009 we won't generate here
// This might seem like a small amount, but there is over 100,000 tiles on a map with 30% coverage so the odds are quite high
if (Rand.ValueSeeded(planetTile.tileId ^ 0x11245d7a) > 0.009f) {
return 0f;
}

// A formula to calculate the score at this tile.
return (float)(16.0 + (tile.temperature - 7.0) + (tile.rainfall - 600.0) / 180.0);
}
}
</source>

== About Terrain modifiers ==

There are many terrain modifiers like <code>lakeBeachTerrain</code> and <code>gravelTerrain</code>. These are used by MapGenUtility to get the appropriate terrain at a specific cell. These can change depending on if you have a [[Landmarks#Mixed_biome|mixed biome]]{{OdysseyIcon}} or a <code>tileMutatorDef</code> that overrides a terrain such as <code>overrideLakeBeachTerrain</code>. Note that not every terrain modifier has an equivalent override. Some specific terrain may be hardcoded.

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>. Additionally, you are not able to set their pollution appearance rate or coastal appearance rate through their properties field either.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.
Some incidents have <code>sallowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact on gameplay.

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

[[Category:Modding tutorials]]

Modding Tutorials/Biomes

2026-03-05T19:10:04Z

Halicade: wildPlantsAreCavePlants fix

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as different places that a biome is taken into consideration.

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a <code>workerClass</code> defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can appear on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can appear on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[forage]]d per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage ([[Odyssey]]{{OdysseyIcon}}).
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
If this is false and the tile you are in is not a mixed biome, total plant population is based on the whole map rather than a 20 cell radius. Defauilts to true.
|-
| <source lang="xml">
<wildPlantsAreCavePlants>true</wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
Cave plants have their own weight which is used to place them in caves. This makes it so the weight defined in <code>wildPlants</code> is used instead.
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
<MCP_MyCustomPlant MayRequire="username.CustomPlantMod">0.3</MCP_MyCustomPlant>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on an plants properties. Duplicates are not allowed between the two. Plants that appear due to pollution appear in this list as well.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
<MCA_MyCustomAnimal MayRequire="username.CustomAnimalMod">0.3</MCP_MyCustomanimal>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on an animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused field that is located on Ocean and Lake biomes.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world maps tile. Defaults to true. Note that this tile can still be polluted while on the map tile or by sending a drop-pod of wastepacks to the area.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animals will not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
If false, When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen. If a category is not present, no fish from that category will appear. Despite there being a <code>1</code> to indicate chance, this field is not utilized.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via the BiomeDefs <code>generatesNaturally</code>, and the BiomeWorkers <code>CanPlaceOnLayer</code>, it's score is calculated from the individual biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

=== Biome Generation ===

There is no right or wrong way to create the score for biomes. If you look at biome workers, many of them will use different formula or logic to appear on the map. Here is an example used from the mod [https://github.com/Halicade/GuldenBiome/blob/master/Source/BiomeWorker.cs| Gulden Biome (Continued)].

<source lang="cs">
// We are subclassing the temperate forest biome worker
public class BiomeWorker_GuldenForest : BiomeWorker_TemperateForest
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to completely overwrite the parent biome.
// That's why we only want tiles with an elevation between 500 and 800.
if (tile.elevation is <= 500 or >= 800) {
return 0;
}

// Get what the score is of the parent biome, temperate forest
float score = base.GetScore(biome, tile, planetTile);
// If that score is 0 or less we don't want this biome there.
if (score <= 0) {
return 0;
}

// We add 1.5 so that it is higher than the temperate forest.
// We don't want this number too large, otherwise it will overwrite other biomes.
return score + 1.5f;
}
}
</source>

== About Terrain modifiers ==

There are many terrain modifiers like <code>lakeBeachTerrain</code> and <code>gravelTerrain</code>. These are used by MapGenUtility to get the appropriate terrain at a specific cell. These can change depending on if you have a [[Landmarks#Mixed_biome|mixed biome]]{{OdysseyIcon}} or a <code>tileMutatorDef</code> that overrides a terrain such as <code>overrideLakeBeachTerrain</code>. Note that not every terrain modifier has an equivalent override. Some specific terrain may be hardcoded.

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>. Additionally, you are not able to set their pollution appearance rate or coastal appearance rate through their properties field either.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.
Some incidents have <code>sallowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact on gameplay.

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

[[Category:Modding tutorials]]

Ideoligion

2026-01-31T14:42:42Z

Halicade: Added days required for cannibalism precepts

{{Ideology}}
{{Stub|reason=Add Nomadic and space habitat precept. Shipborn meme requirements/associated not implemented. traders guild}}
'''Ideoligions''' are both a system of mechanics introduced by, and the primary focus of, the [[Ideology DLC]]. They allow colonies to introduce a variety of new restrictions and capabilities to change gameplay, as well as new interactions with other factions.
{{TOCright}}

== Type of ideoligion ==
Whenever you start a new game, you will see the Ideology selection menu once you've selected a world tile.

* '''Ideology system inactive''' - Disables most of the Ideology system. Player colonies and factions will no longer have any ideoligion. With this option, you can create any ''style'', or cosmetic variant, of building (click the circle icon in the [[Architect]] tab, right next to the search bar).
:However, some aspects of the ideoligion system remain. You can still assign a [[Leader]], and will have access to a funeral and 2 [[ritual]]s - a dance party and drum party.{{Check Tag|Verify|Extremely quick testing}} In addition, there will be 3 randomized [[relic]]s that you can search for.

* '''Create ideoligion (fluid)''' - Design an ideoligion that can change over time.
:A fluid ideoligion only has access to 1 [[meme]] at the start of the game, which cannot be a high impact meme. Otherwise, a fluid ideoligion has the same customization options as a fixed ideoligion. The difference is that a fluid ideology can change over the course of the game. As you gain [[#Development points|development points]], you can add / remove memes, and re-customize just about everything else.

* '''Create ideoligion (fixed)''' - Design an ideoligion with complete control.

* '''Presets''' - Use an ideoligion already created for you. Want to live under the mountain, but don't want to make a full ideoligion? Pick the "Mole people" preset. You will start with a Funeral and 2 other random [[ritual]]s, as well as a random [[relic]]. Other aspects of the ideoligion will also be randomized.
:For example, the "Classic-like" preset will have the following precepts:
<div style="column-count:2; width:600px">
* [[#Corpses|Corpses: Ugly]]
* [[#Insect meat|Insect meat: Despised]]
* [[#Marriage name|Marriage name: Usually man's]]
* [[#Eating nutrient paste|Eating nutrient paste: Disgusting]]
* [[#Physical love|Physical love: Free]]
* [[#Women's spouses|Women's spouses: One only]]
* [[#Men's spouses|Men's spouses: One only]]
</div>

=== Development points ===
{{For|a guide for how to convert a non-fluid ideoligion to a fluid ideoligion via save editing|Fluid ideoligion save conversion guide}}
Fluid ideoligions are mostly the same as a static one, but can be changed over time through development points. When you have enough points, you can reform the ideoligion. It costs 10 points for the first reformation, and increases by +2 per reform until a max of 20 points. You cannot "store" points; once you can reform, no more points are gained.

Development points can be obtained in the following ways:
* Performing [[rituals]]. Rituals will give a varying amount of points depending on if they are "anytime" rituals or "dated" rituals, how many rituals the ideoligion has and the quality of the ritual. If a ritual achieves a goal that awards development points (such as a conversion), both the points for the goal and the ritual are received in full. Anytime rituals (including funerals) give 1 point for a good outcome and 2 points for a great outcome.
Dated rituals grant more points the fewer rituals the ideoligion has, -as detailed below- however Funerals, Gladiator Duels, Blinding, and Scarification rituals '''''Do not''''' count for the following table.
{| class="wikitable"
!
! Terrible
! Boring
! Fun
! Unforgettable
|-
! 1 Ritual
| 2
| 4
| 6
| 7
|-
! 2 Rituals
| 1
| 2
| 3
| 4
|-
! 3 Rituals
| 1
| 1
| 2
| 3
|-
! 4 Rituals
| 0
| 1
| 1
| 2
|-
! 5+ Rituals
| 0
| 1
| 1
| 1
|}

* Converting someone: 1 point.
Certain [[#Precepts|precepts]] allow an ideoligion to gain points from actions related to the precept.
* [[#Blindness|Blindness: Respected, Elevated or Sublime]]: Blinding someone: 1 point
* [[#Charity|Charity: Worthwhile, Important or Essential]]: Completing charity quests and accepting charity events
** [[Quests#Beggars|Helping beggars]]: 2 points
** [[Events#Wanderer joins|Accepting joining wanderer]]: 1 point
** [[Quests#Hospitality|Giving hospitality]] {{RoyaltyIcon}}: 2 points
** [[Quests#Shuttle Crash|Saving shuttle crash survivors]] {{RoyaltyIcon}}: 3 points
** [[Events#Transport pod crash|Saving a pod crash victim]]: 1 point
** [[Quests#Noble Wimp|Saving the noble wimp]] {{RoyaltyIcon}}: 1 point
** [[Quests#Threatened Joiner|Helping the threatened joiner]]: 2 points
* [[#Execution|Execution: Respected if guilty or Required]]: Executing prisoner: 1 point
* [[#Proselytizing|Proselytizing: Occasional, Sometimes or Frequent]]:
** Converting a new member: 1 point (in addition to the normal 1 point)
** Obtaining a [[Relic|relic]]: 5 points
** Completing the [[Quests#Pilgrims|pilgrims]] quest: 2 points
* [[#Raiding|Raiding: Respected or Required]]:
** Raiding someone: 1 point
** Raiding a bandit camp or work site: 2 points
* [[#Ranching|Ranching: Central]]: Successfully completing an [[Quests#Hospitality|Animal Hospitality quest]]{{RoyaltyIcon}}: 2 points
* [[#Slavery|Slavery: Honorable]]: Enslaving new prisoner: 1 point
* [[#Gauranlen connection|Gauranlen Connection: Strong]]: Planting gauranlen tree: 1 point

Reformation allows you to add ''or'' remove 1 meme, ''or'' change the structure of your ideoligion. If you add a meme, you cannot remove / replace another meme or change structure. In addition, you can only add 1 [[style]] at a time. All other changes are unlimited.

== Forming an ideoligion ==
An ideoligion consists of many separate aspects to customize:

'''Primary'''
* '''[[#Structure|Structure]]''' - What deities (or lack thereof) that followers believe in. Examples include ''Abstract theist'', that "god(s) are formless and everywhere", or ''Christian origin'', which is closer to the Abrahamic religions of the west. Structure helps determine the randomized names and lore of your ideoligion. This is almost entirely cosmetic, but can add a few ritual options.

* '''[[#Memes|Memes]]''' - The basic beliefs of the ideoligion. An ideoligion with the ''Cannibal'' meme will definitely enjoy human meat. Each ideoligion can have up to 4 memes. Most memes do not add much on their own, but affect what precepts the ideoligion has and cannot have. Some memes have access to [[roles|specialists]].

* '''[[#Precepts|Precepts]]''' - What a follower's belief systems are. Precepts directly determine how colonists will react to certain actions. An ideoligion with ''Cannibalism: Preferred'' will have followers enjoy eating human meat. An ideoligion with ''Cannibalism: Required (Ravenous)'' will want to eat human meat for every meal.
:Certain precepts have statistical effects beyond mood. For instance, ''Drugs: Essential'' boosts drug crop yield, synthesis speed, and sell price. These tend to be locked behind their associated meme.

'''Secondary'''
* '''[[Rituals]]''' - Special occasions, from Dance Party to Animal Sacrifice to Funerals. Every time you do a ritual, you can end up with a good or bad outcome. Good outcomes will increase colonist [[mood]], and come with a special, defined reward. For example, a spectacular festival can give you a random recruit, or cause a [[gauranlen pod]] to sprout.

:You can increase the chances of a good outcomes by following the ritual's requirements. A funeral can be done without your colonist's body, but the quality will be increased if the corpse is buried.

* '''[[#Roles|Roles]]''' - Every ideoligion has a Leader and Moral Guide. From there, you can have up to 2 types of specialists. A Shooting Specialist will be great at ranged combat, but is unable to do many types of skilled work. Note that you can have as many specialists of a specific type as you want. For example, you can have 3 Shooting Specialists in a single colony, but cannot have a Shooting, Plants, AND Research specialist in the same ideoligion.

* '''[[Relic]]s''' - Ideoligions can have relics. Relics can be either Legendary [[quality]] weapons or specific types of items that serve no other purpose. Relics must be found from a specific, multi-part relic hunt quest, which can take many years. Having a relic present will cause a number of benefits.

* '''Buildings''' - Buildings used by your ideoligion: [[altar]]s, [[sacrificial flag]]s, etc. Largely used for rituals. Altars and the like will eventually be demanded by followers of your ideoligion in a temple room.

* '''Preferences''' - Ideoligions can prefer [[apparel]], [[weapon]]s, and [[xenotype]]s {{BiotechIcon}}, as well as venerate specific [[animal]]s. Colonists will like having/being around preferred items. Whether a colonist will dislike a non-preferred item is dependent on the preference in question.

'''Descriptive'''
* '''[[#Styles|Styles]]''' - How buildings made by an ideoligious builder will look. Largely cosmetic. However, it interacts with the Diversity of Thought precept. If colonists are neutral or bigoted, then they will enjoy being near styles of the same ideoligion. If colonists appreciate Diversity of Thought, they will enjoy being near styled buildings that their ideoligion could not make. Certain styles will affect more or less buildings.

* '''[[#Cultures|Cultures]]''' - Roughly where your ideoligion comes from. Astropolitian represents those coming from space. Corunan represents [[New Tribe|tribes]] in general. Entirely cosmetic.

* '''Lore''' - A randomly generated description of the ideoligion, based off of memes, structures, cultures, etc. Entirely cosmetic.

* '''Icon / color''' - An ideoligion's icon is used whenever an ideology will be displayed. The color of the icon will be a preferred color for followers. Followers gain a {{+|1}} moodlet for wearing their ideology's color, or their own favorite color. All colors require [[dye]] and the same amount of dye.

== Certainty ==
{{Main|Certainty}}

'''Certainty''' is how willing a colonist is to maintain their current ideoligion. Conversion attempts reduce certainty. Once certainty hits 0%, a pawn's ideology will change.

== Structure ==
Choosing your structure affects which symbols the game uses for your ideoligion, and allows for the selection of some rituals that would otherwise require specific memes. It also influences some random generation options and flavor text but these can be overridden by player selection.
{| class="wikitable sortable"
! Structure !! Description !! Styles !! Unlocked Rituals !! Chance to Have Precept
|- id="Abstract theist"
! Abstract theist [[File:Abstract theist.png|64px]]
| The god(s) do not have physical form, but are everywhere at once. They know all, and can do anything. Their will defines the moral structure of the universe. || || ||
|- id="Animist"
! Animist [[File:Animist.png|64px]]
| Spirits live in everything around us. In the plants and animals, rivers and trees, sky and stars. The moral structure of the universe springs from the necessity of respecting them. || Animalist || ||
|- id="Archist"
! Archist [[File:Archist.png|64px]]
| Archotechs are the true gods. They know the moral structure of the universe, and serving them is how we will connect with it. || || ||
|- id="Buddhist origin"
! Buddhist origin [[File:Buddhist origin.png|64px]]
| This ideoligion is a descendant of ancient Buddhism. It may have very different precepts than those of thousands of years ago, but its symbols are similar. || Buddhist || Smokeleaf circle || Headwrap: Relaxed Broadwrap: Relaxed
|- id="Christian origin"
! Christian origin [[File:Christian origin.png|64px]]
| This is a variant of the abstract theist structure. This ideoligion is a descendant of ancient Christianity. It may have very different precepts than those of thousands of years ago, but its symbols are similar. || Christian || Christmas tree party || Headwrap: Relaxed Broadwrap: Relaxed
|- id="Embodied theist"
! Embodied theist [[File:Embodied theist.png|64px]]
| The god(s) walk the planets like us, yet they are powerful and immortal as we are not. They decide the moral structure of the universe. || || ||
|- id="Hindu origin"
! Hindu origin [[File:Hindu origin.png|64px]]
| This is a variant of the embodied theist structure. This ideoligion is a descendant of ancient Hinduism. It may have very different precepts than those of thousands of years ago, but its symbols are similar. || Hindu || Smokeleaf circle || Headwrap: Relaxed Broadwrap: Relaxed
|- id="Ideological"
! Ideological [[File:Ideological.png|64px]]
| There are no gods. The moral structure of the universe is found in our grand narrative of social forces. || || Symbol burning ||
|- id="Islamic origin"
! Islamic origin [[File:Islamic origin.png|64px]]
| This is a variant of the abstract theist structure. This ideoligion is a descendant of ancient Islam. It may have very different precepts than those of thousands of years ago, but its symbols are similar. || Islamic || || Headwrap: Relaxed Broadwrap: Relaxed
|}

== Cultures ==
Cultures affect names, appearances, and symbols.

{| class="wikitable"
! Culture !! Factions Allowed !! Description
|- id="Astropolitan"
! Astropolitan [[File:Astropolitan.png|32px]]
| [[New Arrivals]] [[Sanguophages (Faction)|Sanguophages]]{{BiotechIcon}} [[Traders guild]]{{OdysseyIcon}} [[Salvagers]]{{OdysseyIcon}}|| A broad collection of cultures common among frequent space travelers.
|- id="Rustican"
! Rustican [[File:Civil outlander.png|32px]]
| [[Outlander]] Factions || A hardy industrial cultures common among rimworld outlanders.
|- id="Corunan"
! Corunan [[File:GentleTribe.png|32px]]
| [[New Tribe]] [[Tribal]] Factions || An ancient culture common among rimworld tribes.
|- id="Kriminul"
! Kriminul [[File:Pirate.png|32px]]
| [[Pirate]] Factions || A broad category describing the styles and practices of many pirate groups.
|- id="Sophian"
! Sophian {{RoyaltyIcon}} [[File:Empire map marker.png|32px]]
| [[Empire]] Faction|| A techno-feudal culture centered on the planet Sophiamunda.
|}
Additionally, the [[Ancient]] factions, [[Outlander refugee group]]{{RoyaltyIcon}}, [[Beggars]]{{IdeologyIcon}}, [[Pilgrims]]{{IdeologyIcon}}, and the [[Horax cult]]{{AnomalyIcon}} do not have any culture assigned to them; therefore they may use any existing one randomly.

== Styles ==
{{recode|section=1|reason=Use collapsibles to allow a non-intrusive display of the styles where the reader can tab between the styles}}
An ideoligion can have 0-3 associated styles. People belonging to that ideoligion will apply those styles when making specific items. Colonists will get thoughts based on the styles of the objects around them, depending on their ideoligion's [[#Diversity of thought|diversity of thought]] precept either for having surroundings match or not match their ideoligion. Neutral surroundings produce no thought. If multiple styles of an ideoligion affect the same object, left-most applies. Note that building appearance in the construction menu will be based on your primary ideoligion, but the actual building might be different if built by a pawn of a different ideoligion.

{| class="wikitable sortable"
! style=width:6em | Style !! New buildables !! Affects items !! Affects objects !! Affects ritual ambience sound !! Player-accessible
|- id="Style Hindu"
| [[File:Style Hindu.png|18px]] Hindu
| -
| [[Simple helmet#Styles|Simple helmet]], [[Flak helmet#Styles|Flak helmet]]
| [[Small sculpture#Styles|Small sculpture]], [[Large sculpture#Styles|Large sculpture]], [[Grand sculpture#Styles|Grand sculpture]]
| Yes
| Yes
|- id="Style Christian"
| [[File:Style Christian.png|18px]] Christian
| -
| -
| [[Small sculpture#Styles|Small sculpture]], [[Large sculpture#Styles|Large sculpture]], [[Grand sculpture#Styles|Grand sculpture]]
| Yes
| Yes
|- id="Style Islamic"
| [[File:Style Islam.png|18px]] Islamic
| -
| -
| [[Small sculpture#Styles|Small sculpture]], [[Large sculpture#Styles|Large sculpture]], [[Grand sculpture#Styles|Grand sculpture]]
| Yes
| Yes
|- id="Style Buddhist"
| [[File:Style Buddhism.png|18px]] Buddhist
| -
| -
| [[Small sculpture#Styles|Small sculpture]], [[Large sculpture#Styles|Large sculpture]], [[Grand sculpture#Styles|Grand sculpture]]
| Yes
| Yes
|- id="Style Morbid"
| [[File:Style Morbid.png|18px]] Morbid
| [[Morbid carpet]], [[Morbid slab (broad)]], [[Morbid slab (medium)]], [[Morbid stone tile]] || [[Recon helmet#Styles|Recon helmet]], [[Marine helmet#Styles|Marine helmet]], [[Cataphract helmet#Styles|Cataphract helmet]]
| [[Small sculpture#Styles|Small sculpture]], [[Large sculpture#Styles|Large sculpture]], [[Grand sculpture#Styles|Grand sculpture]], [[Small altar#Styles|Small altar]], [[Medium altar#Styles|Medium altar]], [[Large altar#Styles|Large altar]], [[Grand altar#Styles|Grand altar]], [[Stool#Styles|Stool]], Table ([[Table (1x2)#Styles|1x2]], [[Table (2x2)#Styles|2x2]], [[Table (2x4)#Styles|2x4]], [[Table (3x3)#Styles|3x3]]), [[Standing lamp#Styles|Standing lamp]], [[Wall lamp#Styles|Wall lamp]], [[Torch lamp#Styles|Torch lamp]], [[Wall torch lamp#Styles|Wall torch lamp]], [[Column#Styles|Column]]
| Yes
| Yes
|- id="Style Totemic"
| [[File:Style Totemic.png|18px]] Totemic
| [[Totemic boards]], [[Totemic slab (broad)]], [[Totemic slab (medium)]], [[Totemic stone tile]]
| [[Recon helmet#Styles|Recon helmet]], [[Marine helmet#Styles|Marine helmet]], [[Cataphract helmet#Styles|Cataphract helmet]]
| [[Small sculpture#Styles|Small sculpture]], [[Large sculpture#Styles|Large sculpture]], [[Grand sculpture#Styles|Grand sculpture]], [[Small altar#Styles|Small altar]], [[Medium altar#Styles|Medium altar]], [[Large altar#Styles|Large altar]], [[Grand altar#Styles|Grand altar]], [[Stool#Styles|Stool]], [[Dining chair#Styles|Dining chair]], Table ([[Table (1x2)#Styles|1x2]], [[Table (2x2)#Styles|2x2]], [[Table (2x4)#Styles|2x4]], [[Table (3x3)#Styles|3x3]]), [[Standing lamp#Styles|Standing lamp]], [[Wall lamp#Styles|Wall lamp]], [[Torch lamp#Styles|Torch lamp]], [[Wall torch lamp#Styles|Wall torch lamp]], [[Column#Styles|Column]]
| Yes
| Yes
|- id="Style Spikecore"
| [[File:Style Spikecore.png|18px]] Spikecore
| [[Spikecore floor-star (broad)]], [[Spikecore floor-star (medium)]], [[Spikecore plates]], [[Spikecore stone tile]] || [[Simple helmet#Styles|Simple helmet]], [[Flak helmet#Styles|Flak helmet]], [[Flak jacket#Styles|Flak jacket]], [[Duster#Styles|Duster]], [[Jacket#Styles|Jacket]], [[Parka#Styles|Parka]]
| Table ([[Table (1x2)#Styles|1x2]], [[Table (2x2)#Styles|2x2]], [[Table (2x4)#Styles|2x4]], [[Table (3x3)#Styles|3x3]]), [[Standing lamp#Styles|Standing lamp]], [[Wall lamp#Styles|Wall lamp]], [[Torch lamp#Styles|Torch lamp]], [[Wall torch lamp#Styles|Wall torch lamp]], [[Column#Styles|Column]]
| Yes
| Yes
|- id="Style Rustic"
| [[File:Style Rustic.png|18px]] Rustic
| [[Rustic rug (broad)]], [[Rustic rug (medium)]]
| [[Simple helmet#Styles|Simple helmet]], [[Flak helmet#Styles|Flak helmet]]
| [[Column#Styles|Column]], [[Standing lamp#Styles|Standing lamp]], [[Wall lamp#Styles|Wall lamp]], [[Torch lamp#Styles|Torch lamp]], [[Wall torch lamp#Styles|Wall torch lamp]], Table ([[Table (1x2)#Styles|1x2]], [[Table (2x2)#Styles|2x2]], [[Table (2x4)#Styles|2x4]], [[Table (3x3)#Styles|3x3]])
| Yes
| Yes
|- id="Style Animalist"
| [[File:Style Animalist.png|18px]] Animalist
| [[Animalist slab (broad)]], [[Animalist slab (medium)]]
| [[Recon helmet#Styles|Recon helmet]], [[Marine helmet#Styles|Marine helmet]], [[Cataphract helmet#Styles|Cataphract helmet]], [[War mask#Styles|War mask]]
| [[Small sculpture#Styles|Small sculpture]], [[Large sculpture#Styles|Large sculpture]], [[Grand sculpture#Styles|Grand sculpture]]
| Yes
| Yes
|- id="Style Techist"
| [[File:Style Techist.png|18px]] Techist
| [[Hex carpet]], [[Hex tile]]
| -
| [[Column#Styles|Column]], [[Plant pot#Styles|Plant pot]], [[Standing lamp#Styles|Standing lamp]], [[Wall lamp#Styles|Wall lamp]], [[Shelf#Styles|Shelf]], [[Autodoor#Styles|Autodoor]], Table ([[Table (1x2)#Styles|1x2]], [[Table (2x2)#Styles|2x2]], [[Table (2x4)#Styles|2x4]], [[Table (3x3)#Styles|3x3]])
| Yes
| Yes
|- id="Style Horaxian"
| [[File:Style Horaxian.png|18px]] Horaxian{{AnomalyIcon}}
| -
| [[Axe#Styles|Axe]], [[Club#Styles|Club]], [[Gladius#Styles|Gladius]], [[Knife#Styles|Knife]], [[Mace#Styles|Mace]]
| -
| No
| No
|}

=== Style dominance ===
Pawns consider objects with style dominance within 27 tiles outdoors, or in the same room regardless of distance. An item is considered "uniform" if pawn's ideoligion can build it, and "diverse" otherwise, regardless of the actual style: for example, a totemic table will be considered diverse for an ideoligion with morbid and totemic styles, because the morbid style overrides totemic tables. If the total style dominance of uniform or diverse objects is at least 10 more than the other category, pawns will get an appropriate thought; the actual style of the object does not matter for stacking either: a morbid slab and a totemic slab in the same room will be uniform for an ideoligion with both styles, cancel each other out and give no thought for an ideoligion with one of those styles, and diverse for an ideoligion with neither.

An ideoligion with no styles would still consider its own buildings (such as ideogram), but not ritual seats, to be uniform.

Clothing, whether worn or placed on the ground, and uninstalled objects have no impact on style dominance.

{{#ask: [[Style Dominance::+]]
| ?Style Dominance
}}

== Memes ==
You must choose one to four memes at the beginning of your playthrough to form the foundational ideas of your ideoligion. Some have much more gameplay impact than others. Hovering over a meme will show you the information in this table.

{| {{STDT| sortable text-valign:top}}
! Meme !! Description !! Impact !! Incompatible Memes !! Required Precepts !! Chance to Have Precept !! Disabled Precepts !! Unlocked Roles !! Required Rituals !! Unlocked Rituals !! New Buildables !! Unlocked Craftables !! Start with Research !! Agreeing Traits !! Conflicting Traits !! Styles
|- id="Animal personhood"
! '''Animal personhood''' [[File:Animal personhood.png|64px]]
| Animals have rights as humans do. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || [[#Rancher|Rancher]] || '''[[#Animal connection|Animal connection:]]''' Strong '''[[#Slaughtering animals|Slaughtering animals:]]''' Prohibited, Horrible, or Disapproved '''[[#Meat eating|Meat eating:]]''' Abhorrent, Horrible, or Disapproved {{OdysseyIcon}}'''[[#Fishing|Fishing:]]''' Prohibited or Disapproved || - || - || [[Ideoligion#Animals specialist|Animals specialist]] || - || - || - || - || - || - || - || -
|- id="Blindsight"
! '''[[Blindsight]]''' [[File:Blindsight.png|64px]]
| Only those who are blind can perceive true reality. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || [[#Darkness|Darkness]] || '''[[#Blind psysense|Blind psysense:]]''' Strong '''[[#Blindness|Blindness:]]''' Respected, Elevated, or Sublime || - || '''[[#Blindness|Blindness:]]''' Horrible '''[[#Lighting|Lighting:]]''' Darklight preferred '''[[#Combat in darkness|Combat in darkness:]]''' preferred || [[Ideoligion#Medical specialist|Medical specialist]] || Blinding || - || - || [[Blindfold]] || - || - || - || -
|- id="Cannibal"
! '''Cannibal''' [[File:Cannibal.png|64px]]
| We must consume human flesh. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || - || '''[[#Organ use|Organ use:]]''' Acceptable '''[[#Cannibalism|Cannibalism:]]''' Preferred, Required (strong), or Required (ravenous) '''[[#Execution|Execution:]]''' Don't care, Respected if guilty, or Required || - || '''[[#Execution|Execution:]]''' Always horrible or Horrible if innocent || - || - || Cannibal feast || - || - || - || [[Cannibal (Trait)|Cannibal]] || - || Morbid
|- id="Collectivist"
! '''Collectivist''' [[File:Collectivist.png|64px]]
| Each person is part of a greater whole. People should work to play their part and help the group. ||style="text-align: center;"data-sort-value=1|[[File:Low meme impact.png|32x32px]] Low || [[#Individualist|Individualist]] || '''[[#Work drive|Work drive:]]''' Tripled || Visage mask: Relaxed || '''[[#Marriage name|Marriage name:]]''' Keep names || - || - || Symbol burning || - || - || - || - || - || -
|- id="Darkness"
! '''Darkness''' [[File:Darkness.png|64px]]
| Bright light burns and destroys! Darkness nourishes and creates. People ought to live in darkness. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || [[#Blindsight|Blindsight]] || '''[[#Lighting|Lighting:]]''' Darklight preferred '''[[#Combat in darkness|Combat in darkness:]]''' Preferred || - || - || [[Ideoligion#Mining specialist|Mining specialist]] || - || - || - || - || - || - || - || -
|- id="Female supremacy"
! '''Female supremacy''' [[File:Female supremacy.png|64px]]
| Women are the superior gender and should rule. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#Male supremacy|Male supremacy]] || - || Burka: Relaxed Veil: Strong || - || - || - || - || - || - || - || [[Misandrist]] || [[Misogynist]] || -
|- id="Flesh purity"
! '''Flesh purity''' [[File:Flesh purity.png|64px]]
| The human body should not be debased. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#High life|High life]] [[#Transhumanist|Transhumanist]] || '''[[#Drug use|Drug use:]]''' Prohibited '''[[#Body modification|Body modification:]]''' Abhorrent '''[[#Scarification|Scarification:]]''' Horrible || - || '''[[#Body modification|Body modification:]]''' Approved '''[[#Physical love|Physical love:]]''' Free and approved || [[Ideoligion#Medical specialist|Medical specialist]] || - || Symbol burning || - || - || - || [[Body purist]] [[Nudist]] || [[Body modder]] || -
|- id="Guilty"
! '''Guilty''' [[File:Guilty.png|64px]]
| Our people carry guilt from ages past. Others are more worthy. ||style="text-align: center;" data-sort-value=1|[[File:Low meme impact.png|32x32px]] Low || [[#Supremacist|Supremacist]] [[#Loyalist|Loyalist]] || '''[[#Pain|Pain:]]''' Idealized '''[[#Charity|Charity:]]''' Essential, Important, or Worthwhile || - || '''[[#Apostasy|Apostasy:]]''' Abhorrent, Horrible, and Guilty '''[[#Slavery|Slavery:]]''' Honorable || - || - || Symbol burning || - || [[Torture crown]] || - || - || - || -
|- id="High life"
! '''High life''' [[File:High life.png|64px]]
| Exotic states of mind are central to a good life. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#Flesh purity|Flesh purity]] || '''[[#Drug use|Drug use:]]''' Essential || Flophat: Relaxed || '''[[#Drug use|Drug use:]]''' Prohibited, Medical only, or Medical/social only || [[Ideoligion#Plants specialist|Plants specialist]] || Smokeleaf circle || Smokeleaf circle || [[Autobong]] [[Mindbend carpet]] || - || - || [[Chemical interest]] [[Chemical fascination]] || - || -
|- id="Human primacy"
! '''Human primacy''' [[File:Human primacy.png|64px]]
| Humans are the moral center of the universe. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#Nature primacy|Nature primacy]] || '''[[#Bonding|Bonding:]]''' Disapproved || - || '''[[#Slaughtering animals|Slaughtering animals:]]''' Prohibited, Horrible, and Disapproved '''[[#Killing innocent animals|Killing innocent animals:]]''' Abhorrent, Horrible, and Disapproved '''[[#Mining|Mining:]]''' Prohibited, Horrible, and Disapproved '''[[#Cutting trees|Cutting trees:]]''' Prohibited, Horrible, and Disapproved || [[Ideoligion#Production specialist|Production specialist]] || - || Symbol burning || - || - || - || - || - || -
|- id="Individualist"
! '''Individualist''' [[File:Individualist.png|64px]]
| Each person is a free individual with the right to their own ideas and decisions. Nobody should be made to conform. ||style="text-align: center;" data-sort-value=1|[[File:Low meme impact.png|32x32px]] Low || [[#Collectivist|Collectivist]] [[#Supremacist|Supremacist]] || - || - || '''[[#Slavery|Slavery:]]''' Honorable || - || - || Symbol burning || - || - || - || - || - || -
|- id="Loyalist"
! '''Loyalist''' [[File:Loyalist.png|64px]]
| We stand for our own before others. ||style="text-align: center;" data-sort-value=1|[[File:Low meme impact.png|32x32px]] Low || [[#Supremacist|Supremacist]] [[#Guilty|Guilty]] || - || - || - || - || - || Symbol burning || - || - || - || - || - || -
|- id="Male supremacy"
! '''Male supremacy''' [[File:Male supremacy.png|64px]]
| Men are the superior gender and should rule. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#Female supremacy|Female supremacy]] || - || Burka: Relaxed Veil: Strong || - || - || - || - || - || - || - || [[Misogynist]] || [[Misandrist]] || -
|- id="Nature primacy"
! '''Nature primacy''' [[File:Nature primacy.png|64px]]
| Man is a stain on nature's perfection. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#Human primacy|Human primacy]] || - || - || - || [[Ideoligion#Plants specialist|Plants specialist]] || || - || - || - || - || - || - || Animalist
|- id="Nudism"
! '''Nudism''' [[File:Nudism.png|64px]]
| Clothing binds, controls, and suffocates us. We should all hang free. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || - || '''[[#Male clothing|Male clothing:]]''' Fully nude or Pants at most '''[[#Female clothing|Female clothing:]]''' Fully nude or Pants at most || - || - || - || - || Symbol burning || - || - || - || [[Nudist]] || - || -
|- id="Pain is virtue"
! '''Pain is virtue''' [[File:Pain is virtue.png|64px]]
| Virtue is shown through suffering of self and others. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || - || '''[[#Pain|Pain:]]''' Idealized '''[[#Comfort|Comfort:]]''' Ignored '''[[#Slab bed|Slab bed:]]''' Preferred || - || '''[[#Charity|Charity:]]''' Essential, Important, and Worthwhile '''[[#Execution|Execution:]]''' Always abhorrent and Always horrible '''[[#Scarification|Scarification:]]''' Horrible '''[[#Skullspike|Skullspike:]]''' Disapproved || - || Scarification || Symbol burning || [[Slab bed]] [[Slab double bed]] || [[Torture crown]] || - || [[Ascetic]] [[Tortured artist]] [[Masochist]] || [[Wimp]] [[Gourmand]] || Morbid
|- id="Proselytizer"
! '''Proselytizer''' [[File:Proselytizer.png|64px]]
| It is our duty to spread our beliefs. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || - || '''[[#Proselytizing|Proselytizing:]]''' Occasional, Sometimes, or Frequent || - || - || - || - || - || - || - || - || - || - || -
|- id="Raider"
! '''Raider''' [[File:Raider.png|64px]]
| The strong should take from the weak. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || - || '''[[#Raiding|Raiding:]]''' Respected or Required '''[[#Execution|Execution:]]''' Horrible if innocent, Don't care, Respected if guilty, or Required || - || '''[[#Skullspike|Skullspike:]]''' Disapproved '''[[#Slavery|Slavery:]]''' Abhorrent, Horrible, and Disapproved || [[Ideoligion#Shooting specialist|Shooting specialist]] [[Ideoligion#Melee specialist|Melee specialist]]|| - || Symbol burning || - || - || - || - || - || -
|- id="Rancher"
! '''Rancher''' [[File:Rancher.png|64px]]
| Raising animals is the right way; raising plants to eat is not. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#Animal personhood|Animal personhood]] || '''[[#Ranching|Ranching:]]''' Central '''[[#Meat eating|Meat eating:]]''' Mildly required, Seriously required, or Strictly required || - || - || [[Ideoligion#Animals specialist|Animals specialist]] || - || Symbol burning || - || - || - || - || - || -
|- id="Supremacist"
! '''Supremacist''' [[File:Supremacist.png|64px]]
| Our people should dominate all others. ||style="text-align: center;" data-sort-value=1|[[File:Low meme impact.png|32x32px]] Low || [[#Individualist|Individualist]] [[#Loyalist|Loyalist]] [[#Guilty|Guilty]] || '''[[#Slavery|Slavery:]]''' Acceptable or Honorable '''[[#Execution|Execution:]]''' Required, Respected if guilty, or Don't care || - || '''[[#Charity|Charity:]]''' Essential, Important and Worthwhile '''[[#Skullspike|Skullspike:]]''' Disapproved || [[Ideoligion#Shooting specialist|Shooting specialist]] [[Ideoligion#Melee specialist|Melee specialist]] || - || Symbol burning || - || - || - || - || - || -
|- id="Transhumanist"
! '''Transhumanist''' [[File:Transhumanist.png|64px]]
| Human progress means merging with technology. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || [[#Flesh purity|Flesh purity]] || '''[[#Sleep accelerator|Sleep accelerator:]]''' Preferred '''[[#Neural supercharge|Neural supercharge:]]''' Preferred '''[[#Biosculpting|Biosculpting:]]''' Accelerated '''[[#Age reversal|Age reversal:]]''' Demanded '''[[#Eating nutrient paste|Eating nutrient paste:]]''' Don't mind '''[[#Body modification|Body modification:]]''' Approved || Slicecap: Relaxed || '''[[#Body modification|Body modification:]]''' Abhorrent or Disapproved || [[Ideoligion#Research specialist|Research specialist]] || - || - || [[Hex carpet]] [[Hex tile]] [[Neural supercharger]] [[Sleep accelerator]] || - || - || [[Body modder]] || [[Body purist]] || Techist
|- id="Tree connection"
! '''Tree connection''' [[File:Tree connection.png|64px]]
| Trees are the essence of life, and we must be near them. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || - || '''[[#Trees|Trees:]]''' Desired '''[[#Rough living|Rough living:]]''' Welcomed '''[[#Temperature|Temperature:]]''' Tough '''[[#Gauranlen connection|Gauranlen connection:]]''' Strong
|| - || - || [[Ideoligion#Plants specialist|Plants specialist]] || - || - || - || - || [[Research#Tree sowing|Tree sowing]] || - || - || -
|- id="Tunneler"
! '''Tunneler''' [[File:Tunneler.png|64px]]
| Humans ought to live underground, and enjoy the succulent fruit of the depths. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High || - || '''[[#Fungus|Fungus:]]''' Preferred '''[[#Insect meat|Insect meat:]]''' Loved '''[[#Indoors|Indoors:]]''' Preferred '''[[#Mining yield|Mining yield:]]''' High || - || '''[[#Mining|Mining:]]''' Prohibited, Horrible, or Disapproved || [[Ideoligion#Mining specialist|Mining specialist]] || - || - || [[Fungal gravel]] || - || [[Research#Stonecutting|Stonecutting]] || [[Undergrounder]] || - || -
|- id="Bloodfeeding"
! '''Bloodfeeding''' {{BiotechIcon}} [[File:Bloodfeeding.png|64px]]
| Drinking blood is sacred. Bloodfeeders should be worshipped. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || - || '''[[#Bloodfeeders|Bloodfeeders:]]''' Revered '''[[#Organ use|Organ use:]]''' Acceptable '''[[#Cannibalism|Cannibalism:]]''' Acceptable or Preferred '''[[#Execution|Execution:]]''' Don't care, Respected if guilty, or Required || - || - || - || - || - || - || - || [[Research#Electricity|Electricity]] [[Research#Deathrest|Deathrest]] || - || - || Morbid
|- id="Ritualist"
! '''Ritualist''' {{AnomalyIcon}} [[File:Ritualist.png|64px]]
| There is a greater energy in the universe. Through ritual we can understand it and harness its power. ||style="text-align: center;" data-sort-value=2|[[File:Medium meme impact.png|32x32px]] Medium || - || '''[[#Psychic rituals|Psychic rituals:]]''' Exalted '''[[#Void study|Void study:]]''' Very efficient '''[[#Research|Research:]]''' Slow, Very Slow or Extremely Slow || - || - || - || - || - || - || - || - || - || - || Morbid
|- id="Inhuman"
! '''Inhuman''' {{AnomalyIcon}} [[File:Inhuman.png|64px]]
| Humanity is a barrier to our connection with the machine god and its pleasurable rewards. ||style="text-align: center;" data-sort-value=3|[[File:High meme impact.png|32x32px]] High|| - || '''[[#Inhumanizing|Inhumanizing:]]''' Required '''[[#Execution|Execution:]]''' Respected if guilty '''[[#Cannibalism|Cannibalism:]]''' Acceptable '''[[#Corpses|Corpses:]]''' Don't care '''[[#Eating nutrient paste|Eating nutrient paste:]]''' Don't mind '''[[#Skullspike|Skullspike:]]''' Desired '''[[#Slavery|Slavery:]]''' Acceptable '''[[#Physical love|Physical love:]]''' Free '''[[#Male clothing|Male clothing:]]''' No rules '''[[#Female clothing|Female clothing:]]''' No rules '''[[#Organ use|Organ use:]]''' Acceptable '''[[#Diversity of thought|Diversity of thought:]]''' Neutral, Mild bigotry, Moderate bigotry or Intense bigotry || - || - || - || - || - || - || - || - || - || - || -
|- id="Shipborn"
! '''Shipborn''' {{OdysseyIcon}} [[File:Shipborn.png|64px]]
| Humans were destined to live among the stars. ||style="text-align: center;" data-sort-value=3|[[File:Medium meme impact.png|32x32px]] Medium|| - || '''[[#Space_Habitat|Space habitat:]]''' Preferred '''[[#Indoors|Indoors:]]''' Preferred '''[[#Eating_Nutrient_Paste|Eating nutrient paste:]]''' Don't mind '''[[#Temperature|Temperature:]]''' Tough || - || - || - || - || - || - || - || - || - || [[Undergrounder|Undergrounder]] || -
|}

=== Other Faction Customization ===
{| class="wikitable sortable"
! Meme !! Civil outlander !! Rough outlander !! Gentle tribe !! Fierce tribe !! Savage tribe !! Cannibal tribe{{IdeologyIcon}} !! Nudist tribe{{IdeologyIcon}} !! Pirate gang !! Pirate cannibal gang{{IdeologyIcon}} !! Shattered Empire{{RoyaltyIcon}} !! Ancient faction*** !! Outlander refugee group{{RoyaltyIcon}} !! Beggars & Pilgrims{{IdeologyIcon}} !! Yttakin pirates{{BiotechIcon}} !! Waster pirates{{BiotechIcon}} !! Sanguophages{{BiotechIcon}} !! Horax cult{{AnomalyIcon}}
|-
| Supremacist || {{Cross}} || '''Required''' || {{Cross}} || {{Cross}} || '''Required''' || {{Check}} || {{Check}} || '''Required''' || '''Required''' || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || '''Required''' || {{Check}} || {{Cross}}
|-
| Loyalist || {{Cross}} || {{Cross}}* || {{Check}} || {{Check}} || {{Cross}}* || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || '''Required''' || '''Required''' || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Guilty || {{Cross}} || {{Cross}}* || {{Check}} || {{Check}} || {{Cross}}* || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Individualist || {{Check}}** || {{Cross}}* || {{Check}} || {{Check}} || {{Cross}}* || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Collectivist || {{Check}}** || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || '''Required''' || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Transhumanist || {{Cross}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || '''Required''' || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Flesh purity || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Raider || {{Cross}} || {{Check}} || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || '''Required''' || '''Required''' || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || '''Required''' || '''Required''' || {{Check}} || {{Cross}}
|-
| Proselytizer || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| High life || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Nature primacy || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Human primacy || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || '''Required''' || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Female supremacy || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Male supremacy || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Animal personhood || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || '''Required''' || {{Cross}} || {{Check}} || {{Cross}}
|-
| Rancher || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Pain is virtue || {{Cross}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}}
|-
| Darkness || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Tunneler || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Tree connection || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}}
|-
| Nudism || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || '''Required''' || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}}
|-
| Blindsight || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}}
|-
| Cannibal || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || '''Required''' || {{Check}} || {{Cross}} || '''Required''' || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || '''Required''' || {{Cross}}
|-
| Bloodfeeding{{BiotechIcon}} || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || '''Required''' || {{Cross}}
|-
| Ritualist{{AnomalyIcon}} || {{Cross}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Check}} || {{Check}} || {{Cross}} || {{Cross}} || {{Check}} || '''Required'''
|-
| Inhuman{{AnomalyIcon}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || {{Cross}} || '''Required'''
|}
<nowiki/>* Appears on faction's options but conflicts with required meme 
<nowiki/>** Since only two memes available, one of Individualist OR Collectivist must be chosen 
<nowiki/>*** Only restricts what memes can be auto-generated and loaded from saved ideoligions, can otherwise lack or possess any memes

=== Natural goodwill with other factions ===
Additionally, Supremacist and Raider have {{Bad|-50}} with everyone, Loyalist {{Bad|-10}} with everyone, and Guilty {{Good|+10}} with everyone. There is a {{Good|+10}} bonus for having the same ideoligion.

Modifiers stack, but each pair only applies once; for example Flesh purity + Cannibal vs Flesh purity + Cannibal give {{Good|+10}} for Flesh purity/Flesh purity, {{Good|+10}} for Cannibal/Cannibal, and {{Good|+10}} for Flesh purity/Cannibal.

{| class="wikitable sortable" style="text-align:center"
! !! Individualist !! Collectivist !! Transhumanist !! Flesh purity !! Proselytizer !! High life !! Nature primacy !! Human primacy !! Female supremacy !! Male supremacy !! Animal personhood !! Rancher !! Pain is virtue !! Nudism !! Cannibal
|-
! Individualist
| style="background-color:#d5d9db; color:forestgreen;"|'''+10''' || style="color:firebrick;|'''-10''' || || || style="color:firebrick;|'''-10''' || || || || style="color:firebrick;|'''-10''' || style="color:firebrick;|'''-10''' || || || || || style="color:firebrick;|'''-10'''
|-
! Collectivist
| style="color:firebrick;|'''-10''' || style="background-color:#d5d9db" |{{Good|+10}} || || || || || || || || || || || || ||
|-
! Transhumanist
| || || style="background-color:#d5d9db" |{{Good|+10}} || style="color:firebrick;|'''-20''' || || || style="color:firebrick;|'''-20''' || style="color:forestgreen;|'''+10''' || || || || || || ||
|-
! Flesh purity
| || || style="color:firebrick;|'''-20''' || style="background-color:#d5d9db" |{{Good|+10}} || || style="color:firebrick;|'''-30''' || || style="color:forestgreen;|'''+10''' || || || || || || || style="color:forestgreen;|'''+10'''
|-
! Proselytizer
| style="color:firebrick;|'''-10''' || || || ||style="background-color:#d5d9db" | || || || || || || || || || ||
|-
! High life
| || || || style="color:firebrick;|'''-30''' || || style="background-color:#d5d9db" |{{Good|+10}} || || || || || || || || ||
|-
! Nature primacy
| || || style="color:firebrick;|'''-20''' || || || || style="background-color:#d5d9db" |{{Good|+10}} || style="color:firebrick;|'''-30''' || || || style="color:forestgreen;|'''+10''' || style="color:firebrick;|'''-30''' || || ||
|-
! Human primacy
| || || style="color:forestgreen;|'''+10''' || style="color:forestgreen;|'''+10''' || || || style="color:firebrick;|'''-30''' || style="background-color:#d5d9db" |{{Good|+10}} || || || style="color:firebrick;|'''-10''' || || || ||
|-
! Female supremacy
| style="color:firebrick;|'''-10''' || || || || || || || || style="background-color:#d5d9db" |{{Good|+10}} || style="color:firebrick;|'''-30''' || || || || ||
|-
! Male supremacy
| style="color:firebrick;|'''-10''' || || || || || || || || style="color:firebrick;|'''-30''' || style="background-color:#d5d9db" |{{Good|+10}} || || || || ||
|-
! Animal personhood
| || || || || || || style="color:forestgreen;|'''+10''' || style="color:firebrick;|'''-10''' || || || style="background-color:#d5d9db" |{{Good|+10}} || style="color:firebrick;|'''-10''' || || ||
|-
! Rancher
| || || || || || || style="color:firebrick;|'''-30''' || || || || style="color:firebrick;|'''-10''' ||style="background-color:#d5d9db" | || || ||
|-
! Pain is virtue
| || || || || || || || || || || || || style="background-color:#d5d9db" |{{Good|+10}} || || style="color:forestgreen;|'''+10'''
|-
! Nudism
| || || || || || || || || || || || || || style="background-color:#d5d9db" |{{Good|+10}} ||
|-
! Cannibal
| style="color:firebrick;|'''-10''' || || || style="color:forestgreen;|'''+10''' || || || || || || || || || style="color:forestgreen;|'''+10''' || || style="background-color:#d5d9db" |{{Good|+10}}
|}

== Precepts ==
{{Recode|reason=Convert mood descriptions to [[Template: Thought]]. {{Error|DO NOT}} convert without adequate detail to fully utilize the template, including max stack count, duration etc.}}
Associated precepts have a chance to appear if a meme is present, but can still be removed if not required.

Some precepts are available to all ideologies, some require at least one of the enabling memes, and some may be unavailable if certain memes are present.

=== Present in every ideoligion ===
There are 19 issues (precept categories) that are present in every ideoligion and may not be removed. However, their level may be changed. They include "basic" precepts from the base game, used in "Play Classic".

{| class="wikitable sortable"
! Issue !! Precept !! Description !! Requirement !! Associated !! Effects

|- id="Blindness"
! rowspan="4"| Blindness [[File:Blindness.png|64px]]
| Horrible || Blinding people for ideoligious reasons is horrible. || Not [[#Blindsight|Blindsight]] || || Colonists gain Mood: Someone got blinded: -2 unless they have the Psychopath or Bloodlust traits
|-
| Respected || To be blind is a moral thing worthy of respect. || [[#Blindsight|Blindsight]] || [[#Blindsight|Blindsight]] || Colonists gain Moods: Blind (+5), Vision Blocked (+2), or Was Blinded (+3). They also gain a +10 Opinion bonus towards blind pawns, or a -2 Opinion malus to sighted pawns.
|-
| Elevated || The blind stand pure above the sighted. || [[#Blindsight|Blindsight]] || [[#Blindsight|Blindsight]] || Moods as Respected, but Blind increases to +10 and Was Blinded to +5. Half-Blind (+1) and Not Blind (-3) are added. Opinion bonus towards blind pawns increases to +35 and malus towards sighted pawns increases to -10. Opinion bonus towards half-blind pawns is added (+10).
|-
| Sublime || Only the blind can be truly noble, for the sighted find their minds clouded by physical vision. || [[#Blindsight|Blindsight]] || [[#Blindsight|Blindsight]] || Moods as Elevated, but Blind increases to +15, Was Blinded to +6. Half-Blind drops to -1, and Not Blind to -6. Opinion bonus towards blind pawns increases to +50 and malus towards sighted pawns increases to -30.

|- id="Cannibalism"
! rowspan="7" | Cannibalism [[File:Cannibalism.png|64px]]
| Abhorrent || Eating human flesh is a deeply abhorrent and disgusting act. || || || {{Thought|value=-20|stack=1|label=ate human meat|desc=I had to eat human meat. This is an offense against everything I believe.|duration=1}} -12 mood for butchering a human -5 mood for a human butchered in the colony -20 opinion for butchering a human -10 opinion for eating human meat Wearing [[stuffable]] [[apparel]] made of [[human leather]]:
* 1 item: {{Thought|desc=Wearing human leather is disturbing. Who could do this?|label=human leather <APPAREL NAME>|value=-2|stack=1}}
* 2 item: {{Thought|desc=I'm dressed like an insane person.|label=human leather <APPAREL NAME> (+1)|value=-4|stack=1}}
* 3 item: {{Thought|desc=I think there may be a face on my clothes. Oh, no... my clothes *are* a face.|label=human leather <APPAREL NAME> (+2)|value=-6|stack=1}}
* 4+ item: {{Thought|desc=I look like a freak from a horror show, and I feel like I'm in a horror show.|label=human leather <APPAREL NAME> etc|value=-8|stack=1}}
Disabled by: [[Psychopath]], [[Bloodlust]], and [[Cannibal (Trait)|Cannibal]] traits and the [[Inhumanized]] hediff.
|-
| Horrible || Eating human flesh is a horrible thing to do. || || || {{Thought|value=-12|stack=1|label=ate human meat|desc=I had to eat human meat. This was a horrible thing.|duration=1}} -6 mood for butchering a human -3 mood for a human butchered in the colony -10 opinion for butchering a human -5 opinion for eating human meat Wearing [[stuffable]] [[apparel]] made of [[human leather]]:
* 1 item: {{Thought|desc=Wearing human leather is wrong.|label=human leather <APPAREL NAME>|value=-2|stack=1}}
* 2 item: {{Thought|desc=I feel really uncomfortable with all this human leather apparel.|label=human leather <APPAREL NAME> (+1)|value=-3|stack=1}}
* 3 item: {{Thought|desc=Why am I wearing so much human leather? This is horrible!|label=human leather <APPAREL NAME> (+2)|value=-5|stack=1}}
* 4+ item: {{Thought|desc=I look like a freak, this is horrifying!|label=human leather <APPAREL NAME> etc|value=-6|stack=1}}
Disabled by: [[Psychopath]], [[Bloodlust]], and [[Cannibal (Trait)|Cannibal]] traits and the [[Inhumanized]] hediff.
|-
| Disapproved || Eating human flesh is an ugly thing to do. || || [[#Pain is virtue|Pain is virtue]] || {{Thought|value=-5|stack=1|label=ate human meat|desc=I had to eat human meat. I believe such actions are wrong.|duration=1}} -3 mood for butchering a human -1 mood for a human butchered in the colony -5 opinion for butchering a human -3 opinion for eating human meat Wearing [[stuffable]] [[apparel]] made of [[human leather]]:
* 1 item: {{Thought|desc=I should not be wearing human leather apparel.|label=human leather <APPAREL NAME>|value=-1|stack=1}}
* 2 item: {{Thought|desc=I'm dressed in human skin. I do not like this.|label=human leather <APPAREL NAME> (+1)|value=-2|stack=1}}
* 3 item: {{Thought|desc=Why am I wearing so much human leather apparel? We should have something else to wear for me...|label=human leather <APPAREL NAME> (+2)|value=-3|stack=1}}
* 4+ item: {{Thought|desc=I should really wear non-human leather apparel. I look like a crazy person.|label=human leather <APPAREL NAME> etc|value=-4|stack=1}}
Disabled by: [[Psychopath]], [[Bloodlust]], and [[Cannibal (Trait)|Cannibal]] traits and the [[Inhumanized]] hediff.
|-
| Acceptable || Human meat is just meat, like any other. || || [[#Pain is virtue|Pain is virtue]] ||'''Mood:''' Nullifies {{Thought|desc=I saw a dead body laying on the ground. It was disturbing.|label=observed corpse|value=-4|stack=3|multi=0.5|duration=0.5}} Nullifies the following penalties for wearing [[stuffable]] [[apparel]] made of [[human leather]]:
* 1 item: {{Thought|desc=Wearing human leather is disturbing. Who could do this?|label=human leather <APPAREL NAME>|value=-2|stack=1}}
* 2 item: {{Thought|desc=I'm dressed like an insane person.|label=human leather <APPAREL NAME> (+1)|value=-4|stack=1}}
* 3 item: {{Thought|desc=I think there may be a face on my clothes. Oh, no, my clothes *are* a face.|label=human leather <APPAREL NAME> (+2)|value=-6|stack=1}}
* 4+ item: {{Thought|desc=I look like a freak from a horror show, and I feel like I'm in a horror show.|label=human leather <APPAREL NAME> etc|value=-8|stack=1}}
|-
| Preferred || To consume human meat is a noble and necessary part of life. || || [[#Cannibal|Cannibal]] || '''Mood:''' Nullifies {{Thought|desc=I saw a dead body laying on the ground. It was disturbing.|label=observed corpse|value=-4|stack=3|multi=0.5|duration=0.5}} {{Thought|value=+2|stack=1|label=ate human meat|desc=I ate human meat. It makes me feel noble and strong.|duration=1}} -2 mood for not eating human meat for 8 days Wearing [[stuffable]] [[apparel]] made of [[human leather]]:
* 1 item: {{Thought|desc=I feel good wearing human leather apparel.|label=human leather <APPAREL NAME>|value=+1|stack=1}}
* 2 item: {{Thought|desc=I enjoy wearing the skin of others.|label=human leather <APPAREL NAME> (+1)|value=+2|stack=1}}
* 3 item: {{Thought|desc=I wear the faces of my enemies. This makes me happy.|label=human leather <APPAREL NAME> (+2)|value=+3|stack=1}}
* 4+ item: {{Thought|desc=I look like a real cannibal. Who could doubt me?|label=human leather <APPAREL NAME> etc|value=+4|stack=1}}
Disabled by: [[Psychopath]] and [[Bloodlust]] traits.
|-
| Required (strong) || Consuming human flesh is important. It should be in every meal. || [[#Cannibal|Cannibal]] || [[#Cannibal|Cannibal]] || '''Mood:''' Nullifies {{Thought|desc=I saw a dead body laying on the ground. It was disturbing.|label=observed corpse|value=-4|stack=3|multi=0.5|duration=0.5}} -2 mood for eating food without human meat -3 opinion for eating food without human meat {{Thought|value=+4|stack=1|label=ate human meat|desc=I ate human meat, as every real human should.|duration=1}} -4 mood for not eating human meat for 8 days Wearing [[stuffable]] [[apparel]] made of [[human leather]]:
* 1 item: {{Thought|desc=I enjoy wearing the faces of others.|label=human leather <APPAREL NAME>|value=+2|stack=1}}
* 2 item: {{Thought|desc=This will scare them. All will know my power.|label=human leather <APPAREL NAME> (+1)|value=+3|stack=1}}
* 3 item: {{Thought|desc=The faces on my clothes aren't smiling, but they make *me* happy.|label=human leather <APPAREL NAME> (+2)|value=+5|stack=1}}
* 4+ item: {{Thought|desc=The flesh! The flesh signals my triumph!|label=human leather <APPAREL NAME> etc|value=+6|stack=1}}
Disabled by: [[Psychopath]] and [[Bloodlust]] traits.
|-
| Required (ravenous) || Man-flesh is morality. To eat a meal without it is unthinkable. || [[#Cannibal|Cannibal]] || [[#Cannibal|Cannibal]] || '''Mood:''' Nullifies {{Thought|desc=I saw a dead body laying on the ground. It was disturbing.|label=observed corpse|value=-4|stack=3|multi=0.5|duration=0.5}} -4 mood for eating food without human meat -5 opinion for eating food without human meat {{Thought|value=+6|stack=1|label=ate human meat|desc=I ate human meat! The world is right, and I am as I should be.|duration=1}} -8 mood for not eating human meat for 8 days Wearing [[stuffable]] [[apparel]] made of [[human leather]]:
* 1 item: {{Thought|desc=I enjoy wearing the suffering of others.|label=human leather <APPAREL NAME>|value=+2|stack=1}}
* 2 item: {{Thought|desc=This will scare them. All will know my power.|label=human leather <APPAREL NAME> (+1)|value=+4|stack=1}}
* 3 item: {{Thought|desc=The faces on my clothes aren't smiling, but they make *me* happy.|label=human leather <APPAREL NAME> (+2)|value=+6|stack=1}}
* 4+ item: {{Thought|desc=The flesh! The flesh signals my triumph!|label=human leather <APPAREL NAME> etc|value=+8|stack=1}}
Disabled by: [[Psychopath]] and [[Bloodlust]] traits.
|- id="Corpses"
! rowspan="2" | Corpses [[File:Precept corpses.png|64px]]
| Ugly || The sight of a dead person is horrible. || || || '''Mood:''' Experiences default {{Thought|desc=I saw a dead body laying on the ground. It was disturbing.|label=observed corpse|value=-4|stack=3|multi=0.5|duration=0.5}} upon seeing a [[human]] [[corpse]]. Note that this thought is nullified by the [[Bloodlust]], [[Psychopath]], and [[Cannibal (Trait)|Cannibal]] traits, as well as pro-[[#Cannibalism|Cannibalism]] precepts. Experiences default {{Thought|desc=I saw a rotting corpse laying on the ground. It was disturbing.|label=observed rotting corpse|value=-6|stack=5|multi=0.5|duration=0.5}}
|-
| Don't care || The sight of a dead person is nothing to be concerned about. || [[#Pain is virtue|Pain is virtue]] [[#Cannibal|Cannibal]] [[#Supremacist|Supremacist]] [[#Raider|Raider]] || [[#Pain is virtue|Pain is virtue]] [[#Cannibal|Cannibal]] [[#Raider|Raider]] || '''Mood:''' Nullifies {{Thought|desc=I saw a dead body laying on the ground. It was disturbing.|label=observed corpse|value=-4|stack=3|multi=0.5|duration=0.5}} Nullifies {{Thought|desc=I saw a rotting corpse laying on the ground. It was disturbing.|label=observed rotting corpse|value=-6|stack=5|multi=0.5|duration=0.5}}

|- id="Diversity of thought"
! rowspan="7" | Diversity of thought [[File:IdeoDiversity.png|64px]]
| Intense bigotry || Other beliefs are evil deceptions ruining the world. It's totally unacceptable to let them exist in the community. || || [[#Loyalist|Loyalist]] [[#Proselytizer|Proselytizer]] || -3, -6, or -9 mood for having other ideologies in the colony +3 for having all colonists of the same ideology -25 opinion for different ideology -5 mood for having a leader of a different ideoligion -4 mood for having another ideoligion's altar in the same room as own ideoligion's +5 mood for matching style surroundings -4 mood for mismatching style surroundings -6 mood for participating in another ideoligion's ritual
|-
| Moderate bigotry || Other beliefs are immoral delusions which do real harm. It's bad to let them exist in the community. || || [[#Loyalist|Loyalist]] [[#Proselytizer|Proselytizer]] || -2, -4, or -6 mood for having other ideologies in the colony +2 for having all colonists of the same ideology -15 opinion for different ideology -4 mood for having a leader of a different ideoligion -2 mood for having another ideoligion's altar in the same room as own ideoligion's +4 mood for matching style surroundings -3 mood for mismatching style surroundings -4 mood for participating in another ideoligion's ritual
|-
| Mild bigotry || Other beliefs are clearly folly. It's not good to let them exist in the community. || || [[#Loyalist|Loyalist]] [[#Proselytizer|Proselytizer]] || -1, -2, or -3 mood for having other ideologies in the colony +1 for having all colonists of the same ideology -5 opinion for different ideology -3 mood for having a leader of a different ideoligion -1 mood for having another ideoligion's altar in the same room as own ideoligion's +3 mood for matching style surroundings -2 mood for mismatching style surroundings -3 mood for participating in another ideoligion's ritual
|-
| Neutral || Other beliefs are neither approved or disapproved. || || || -2 mood for having a leader of a different ideoligion +2 mood for matching style surroundings 0 mood for mismatching style surroundings
|-
| Appreciated || Other beliefs are worth understanding. It's good to live with others who think differently. || || [[#Individualist|Individualist]] || +1, +2, or +3 mood for having other ideologies in the colony 0 mood for matching style surroundings +2 mood for mismatching style surroundings
|-
| Highly appreciated || Other beliefs hold unique knowledge. It's great to live with others who think differently. || [[#Individualist|Individualist]] || [[#Individualist|Individualist]] || +2, +4, or +6 mood for having other ideologies in the colony 0 mood for matching style surroundings +3 mood for mismatching style surroundings
|-
| Exalted || Working through disagreement is the height of morality. It's very moral to live with others who think differently. || [[#Individualist|Individualist]] || [[#Individualist|Individualist]] || +3, +6, or +9 mood for having other ideologies in the colony 0 mood for matching style surroundings +4 mood for mismatching style surroundings

|- id="Eating nutrient paste"
! rowspan="2" | Eating Nutrient Paste [[File:EatingNutrientPaste.png|64px]]
| Disgusting || Nutrient paste is disgusting. || || || '''Mood:''' Experiences default {{Thought|desc=I had to eat a disgusting, tasteless meal. I know it keeps you alive, but nobody wants to swallow that glop.|label=ate nutrient paste meal|value=-4|stack=1|duration=1}} Note that this thought is nullified by the [[ascetic]] trait.
|-
| Don't mind || There's nothing wrong with a meal of efficient, healthy nutrient paste. || [[#Transhumanist|Transhumanist]] [[#Inhuman|Inhuman]] || [[#Transhumanist|Transhumanist]] || '''Mood:''' Prevents {{Thought|desc=I had to eat a disgusting, tasteless meal. I know it keeps you alive, but nobody wants to swallow that glop.|label=ate nutrient paste meal|value=-4|stack=1|}}

|- id="Execution"
! rowspan=6 | Execution [[File:Execution.png|64px]]
| Always abhorrent || Executing a prisoner is an abhorrent evil under any circumstances. || Not [[#Pain is virtue|pain is virtue]] || [[#Individualist|Individualist]] || Pawns will not execute prisoners -20 mood for 6 days for killing a prisoner -3/-4/-6/-7/-7 mood for 6 days for guilty execution/euthanasia/execution/organ harvest/ripscanning kill on a colonist -3/-4/-6/-7/-7 mood for 6 days for guilty execution/euthanasia/execution/organ harvest/ripscanning kill on a prisoner or guest -7 mood for 6 days for non-execution prisoner death -25 opinion for executing a prisoner -25 opinion for killing a prisoner{{Check Tag|Moods need verification}}
|-
| Always horrible || Executing a prisoner is a horrible thing under any circumstances. || Not [[#Pain is virtue|pain is virtue]] Not [[#Cannibal|cannibal]] || [[#Individualist|Individualist]] || -15 mood for 6 days for killing or executing a prisoner -2/-3/-5/-6 mood for 6 days for guilty execution/euthanasia/execution/organ harvest kill on a colonist -2/-3/-5/-6 mood for 6 days for guilty execution/euthanasia/execution/organ harvest kill on a prisoner or guest -5 mood for 6 days for non-execution guilty prisoner death -15 opinion for executing a prisoner -15 opinion for killing a prisoner{{Check Tag|Moods need verification}}
|-
| Horrible if innocent || Executing an innocent prisoner is a horrible thing. If the prisoner is guilty, it's acceptable. || Not [[#Cannibal|cannibal]] || || -15 mood for 6 days for killing or executing an innocent prisoner -2/-3/-5/-6 mood for 6 days for guilty execution/euthanasia/execution/organ harvest kill on a colonist -2/-3/-5/-6 mood for 6 days for guilty execution/euthanasia/execution/organ harvest kill on a prisoner or guest -5 mood for 6 days for non-execution guilty prisoner death -30 opinion for executing an innocent prisoner -15 opinion for killing an innocent prisoner{{Check Tag|Moods need verification}}
|-
| Don't care || Executing prisoners is acceptable, whether they are guilty or innocent. || || ||
|-
| Respected if guilty || Executing prisoners is acceptable. If the prisoner is guilty, it is cause for great happiness. || || [[#Pain is virtue|Pain is virtue]] [[#Collectivist|Collectivist]] || +10 mood for 6 days for executing a guilty prisoner +3 mood for 6 days for a guilty prisoner executed +20 opinion for executing a guilty prisoner
|-
| Required || Prisoners must be executed on a regular basis. When they are, it is a happy occasion. || || [[#Supremacist|Supremacist]] [[#Pain is virtue|Pain is virtue]] || +10 mood for 6 days for executing a prisoner +10 mood for killing a prisoner +3 mood for 2 days for prisoner or guest executed -3 mood for no executions for 30 days +15 opinion for executing a prisoner +15 opinion for killing a prisoner

|- id="Fungus"
! rowspan="2" | Fungus [[File:Fungus.png|64px]]
| Despised || That dark-grown fungus food is just disgusting || Not [[#Tunneler|Tunneler]] || || Ate [[raw fungus|fungus]] raw: -6 Ate fungus cooked: -3
|-
| Preferred || Fungus is the right crop to eat. Crops of the light are poisoned by the air and sun. || [[#Tunneler|Tunneler]] || [[#Tunneler|Tunneler]] || Ate [[raw fungus|fungus]]: +3 Ate cooked fungus: +3 Ate non-fungus plant raw: -5 Ate non-fungus plant cooked: -3

|- id="Insect meat"
! rowspan="2" | Insect Meat [[File:InsectMeat.png|64px]]
| Despised || Insect meat is disgusting to even look at, much less eat. Slimy! || || || -6 mood for eating insect meat -3 mood for eating cooked insect meat
|-
| Loved || There is nothing more divine than the succulent, slimy flesh of an insect || || [[#Tunneler|Tunneler]] || Gives a +6 moodlet when pawns eat meals with insect meat as an ingredient, duration 1 day.

|- id="Marriage name"
! rowspan="6" | Marriage Name [[File:MarriageName.png|64px]]
| Always Man's || Couples must share the man's name. || || [[#Male Supremacy|Male supremacy]] || Couples always take man's name
|-
| Usually Man's || Most couples share the man's name || || || As random, but 95% to not consider taking woman's name and 75% to not consider keeping names
|-
| Random || Couples randomly choose whether to share a name, and which name to share. || || || Couples randomly select between taking man's, woman's, or keeping names
|-
| Keep Names || Both partners keep their names upon marriage. || Not [[#Collectivist|Collectivist]] || || Couples always keep their names
|-
| Usually Woman's || Most couples share the woman's name || || || As random, but 95% to not consider taking man's name and 75% to not consider keeping names
|-
| Always Woman's || Couples must share the woman's name. || || [[#Female supremacy|Female supremacy]] || Couples always take woman's name

|- id="Female clothing"
! rowspan=7 | Female Clothing [[File:Nudity Female.png|64px]]
| Fully nude || Women must be entirely nude at all times. Utility items like shields belts or jump packs are acceptable. || || [[#Male supremacy|Male supremacy]] [[#Nudism|Nudism]] || -4 mood when wearing any clothing and for 0.5 days after removing it -5 opinion for wearing clothes
|-
| Pants at most || Women should cover their groin, but may not cover anything else. Utility items like shields belts or jump packs are acceptable. || || [[#Nudism|Nudism]] || -4 mood when wearing any clothing except pants and for 0.5 days after removing it -4 mood for not covering groin -5 opinion for wearing clothes other than pants -10 opinion for uncovered groin
|-
| No rules || A woman may display or cover any part of her body. || || [[#Individualist|Individualist]] ||
|-
| Pants || Women must cover their groin. The rest of the body may be covered, or not. || || || -4 mood for not covering groin -10 opinion for uncovered groin
|-
| Pants and shirt || Women must cover their groin and chest. The rest of the body may be covered, or not. || || || -4 mood for not covering groin or chest -10 opinion for uncovered groin or chest
|-
| Pants, shirt, and hat || Women must cover their entire body and hair. The face may be covered, or not. || || [[#Male supremacy|Male supremacy]] || -4 mood for not covering groin, chest, or hair -10 opinion for uncovered groin, chest, or hair
|-
| Fully covered || Women must cover their entire body, including their hair and face. || || [[#Male supremacy|Male supremacy]] || -4 mood for not covering groin, chest, hair, or face -10 opinion for uncovered groin, chest, hair, or face

|- id="Male clothing"
! rowspan=7 | Male Clothing [[File:Nudity Male.png|64px]]
| Fully nude || Men must be entirely nude at all times. Utility items like shields belts or jump packs are acceptable. || || [[#Female supremacy|Female supremacy]] [[#Nudism|Nudism]] || -4 mood when wearing any clothing and for 0.5 days after removing it -5 opinion for wearing clothes
|-
| Pants at most || Men should cover their groin, but may not cover anything else. Utility items like shields belts or jump packs are acceptable. || || [[#Nudism|Nudism]] || -4 mood when wearing any clothing except pants and for 0.5 days after removing it -4 mood for not covering groin -5 opinion for wearing clothes other than pants -10 opinion for uncovered groin
|-
| No rules || A man may display or cover any part of his body. || || [[#Individualist|Individualist]] ||
|-
| Pants || Men must cover their groin. The rest of the body may be covered, or not. || || || -4 mood for not covering groin -10 opinion for uncovered groin
|-
| Pants and shirt || Men must cover their groin and chest. The rest of the body may be covered, or not. || || || -4 mood for not covering groin or chest -10 opinion for uncovered groin or chest
|-
| Pants, shirt, and hat || Men must cover their entire body and hair. The face may be covered, or not. || || [[#Female supremacy|Female supremacy]] || -4 mood for not covering groin, chest, or hair -10 opinion for uncovered groin, chest, or hair
|-
| Fully covered || Men must cover their entire body, including their hair and face. || || [[#Female supremacy|Female supremacy]] || -4 mood for not covering groin, chest, hair, or face -10 opinion for uncovered groin, chest, hair, or face

|- id="Organ use"
! rowspan=4 | Organ use [[File:OrganUse.png|64px]]
| Totally abhorrent || Any harvesting, trading, or installing natural organs is an abhorrent evil. || || Flesh purity || -30 mood for harvesting someone's organ -10 mood for organ harvested in the colony -30 mood for trading an organ -5 mood for organ traded in the colony -30 mood for installing an organ -4 mood for organ installed in the colony -30 opinion for harvesting an organ -30 opinion for trading an organ -15 opinion for installing an organ
|-
| No harvest or sell || Harvesting organs is a horrible thing. Selling any natural organ is pretty bad too. However, it's okay to buy and install them. || || Flesh purity || -15 mood for harvesting someone's organ -5 mood for organ harvested in the colony -8 mood for selling an organ -2 mood for organ sold in the colony -20 opinion for harvesting an organ -10 opinion for selling an organ
|-
| No harvest || Harvesting organs is a horrible thing. However, it's okay to buy, install, or sell them. || || Cannibal Raider Collectivist || -15 mood for harvesting someone's organ -5 mood for organ harvested in the colony -20 opinion for harvesting an organ
|-
| Acceptable || It's okay to harvest, buy, install, or sell organs. || || Cannibal Raider Collectivist ||

|- id="Physical love"
! rowspan="7" | Physical Love [[File:PhysicalLove.png|64px]]
| Free || Physical intimacy is a natural part of life, with any partner, married or not. || || Individualist
|-
| Prohibited || The physical act of lust is always vile, disgusting, and wrong. || || [[#Flesh purity|Flesh purity]] [[#Pain is virtue|Pain is virtue]] || Pawns will not share beds -30 mood for 1 day for lovin' -20 opinion for lovin'
|-
| Horrible || The physical act of lust is vile, though within marriage it is necessary. || || [[#Flesh purity|Flesh purity]] [[#Pain is virtue|Pain is virtue]] || Pawns will not share beds with non-spouses -30 mood for 1 day for lovin' with non-spouse -20 opinion for lovin' with non-spouse -5 mood for 1 day for lovin' with spouse -5 opinion for lovin' with spouse
|-
| Spouse only (strict) || To make love with another outside of marriage is deeply immoral. || || || Pawns will not share beds with non-spouses -30 mood for 1 day for lovin' with non-spouse -20 opinion for lovin' with non-spouse
|-
| Spouse only (moderate) || To make love with another outside of marriage is wrong. || || || Pawns will not share beds with non-spouses -15 mood for 1 day for lovin' with non-spouse -10 opinion for lovin' with non-spouse
|-
| Spouse only (mild) || Though it's understandable to make love with another outside of marriage, it's not a good thing. || || || Pawns will not share beds with non-spouses -5 mood for 1 day for lovin' with non-spouse -5 opinion for lovin' with non-spouse
|-
| Free and approved || The physical act of love is a noble thing, no matter who does it with whom. || Not [[#Flesh purity|flesh purity]] || [[#Individualist|Individualist]] || +5 opinion for loving'

|- id="Research"
! rowspan="7"| Research [[File:Research.png|64px]]
| Not allowed || To research technology is an immoral act. It is not to be done. || || || '''Prohibition:''' Pawns are unwilling to research.
|-
| Extremely slow || Research isn't a worthwhile activity at all. Why try hard at it? || || || '''Stats:''' [[Research Speed]]: {{Bad|x0.25}}
|-
| Very slow || Research work is unworthy of serious respect. Better not to be seen trying hard at it. || || || '''Stats:''' [[Research Speed]]: {{Bad|x0.50}}
|-
| Slow || Research work just isn't particularly meaningful. Why try hard at it? || || || '''Stats:''' [[Research Speed]]: {{Bad|x0.75}}
|-
| Normal || Research is a worthwhile form of work that the community needs. || || || '''Stats:''' [[Research Speed]]: '''×1.00'''
|-
| Fast || Research is an especially virtuous activity. || || || '''Stats:''' [[Research Speed]]: {{Good|x1.25}}
|-
| Very fast || Research is among the most meaningful acts a person can perform. || || || '''Stats:''' [[Research Speed]]: {{Good|x1.50}}

|- id="Scarification"
! rowspan="4"| Scarification [[File:Scarification.png|64px]]
| Extreme || Every person ought to bear the ritual scars - all over. || [[#Pain is virtue|Pain is virtue]] || || +6 mood for getting scarified +3 mood for having 5 scars -3 mood for having fewer than 5 scars +10 opinion for having 5 scars -5 opinion for having 1-4 scars -10 opinion for having no scars
|-
| Heavy || Every person ought to bear the ritual scars - many of them. || [[#Pain is virtue|Pain is virtue]] || || +5 mood for getting scarified +2 mood for having 3 scars -2 mood for having fewer than 3 scars +5 opinion for having 3 scars -3 opinion for having 1-2 scars -5 opinion for having no scars
|-
| Minor || Every person ought to bear a ritual scar. || [[#Pain is virtue|Pain is virtue]] || || +3 mood for getting scarified +1 mood for having a scar -1 mood for having no scars +3 opinion for having a scar -3 opinion for having no scars
|-
| Horrible || Scarifying people for ideoligious reasons is horrible. || Not [[#Pain is virtue|Pain is virtue]] || || -2 mood for scarification ceremony in the colony

|- id="Skullspike"
! rowspan="2" | Skullspike [[File:Precept skullspike.png|64px]]
| Desired || A skull on a spike symbolizes our superiority. || || [[#Pain is virtue|Pain is virtue]] [[#Supremacist|Supremacist]] [[#Raider|Raider]] || Adds a mood increase of {{+|1}} for 1-3 [[Skullspike|skullspikes]], {{+|2}} for 4-8 skullspikes, and {{+|3}} for 9+ skullspikes. Mood effects negated by the [[Masochist]] trait.
|-
| Disapproved || Putting skulls on spikes is a barbaric practice. || Not [[#Pain is virtue|Pain is virtue]] Not [[#Supremacist|Supremacist]] Not [[#Raider|Raider]] || || Adds a mood malus of {{--|1}} for 1-3 [[Skullspike|skullspikes]], {{--|2}} for 4-8 skullspikes, and {{--|3}} for 9+ skullspikes. Mood effects negated by the [[Masochist]] trait.

|- id="Slavery"
! rowspan="5" | Slavery [[File:Slavery.png|64px]]
| Abhorrent || Owning or trading human beings is deeply evil. || Not [[#Raider|raider]] || [[#Guilty|Guilty]] [[#Individualist|Individualist]] || '''Prohibitions:''' Pawns will not sell pawns into [[slavery]] Pawns will not enslave [[prisoners]] '''Mood:''' {{Thought|desc=We sold someone into slavery. It was an abhorrent, barbaric act.|label=slave sold|value=-10|stack=5|multi=0.75|duration=6}} (Colony wide). Does not apply to quest lodgers. {{Thought|desc=We're keeping slaves. It's barbaric.|label=slaves in colony|value=-3}}, per slave. Does not apply to quest lodgers. '''Opinion:''' {{--|20}} for selling a pawn into slavery {{--|20}} opinion for enslaving a pawn
|-
| Horrible || Owning or trading human beings is a horrible thing. || Not [[#Raider|raider]] || [[#Guilty|Guilty]] [[#Individualist|Individualist]] || '''Mood:''' {{Thought|desc=We're keeping slaves. It's wrong.|label=slaves in colony|value=-2}}, per [[slave]]. Does not apply to quest lodgers. {{Thought|desc=I sold a person into slavery. I'm not sure I can forgive myself.|label=sold slave|value=-10|stack=1|duration=6}} {{Thought|desc=I forced someone into slavery. How can I justify that?|label=enslaved prisoner|value=-10|stack=1|duration=6}} (Only if they weren't previously enslaved) {{Thought|desc=We sold someone into slavery. What a horrible thing to do.|label=slave sold|value=-3|stack=5|multi=0.75|duration=6}} (Colony wide). Does not apply to quest lodgers. {{Thought|desc=We enslaved someone. What a horrible thing to do to another human.|label=prisoner enslaved|value=-3|stack=5|multi=0.75|duration=6}} (Colony wide). Does not apply to quest lodgers. '''Opinion:''' {{--|10}} for selling a pawn into slavery {{--|10}} opinion for enslaving a pawn
|-
| Disapproved || Slavery is part of life, though it is extremely distasteful. || Not [[#Raider|raider]] || [[#Guilty|Guilty]] [[#Individualist|Individualist]] || '''Mood:''' {{Thought|desc=We're keeping slaves. Even if it's necessary, it's distasteful and I wish we wouldn't.|label=slaves in colony|value=-1}}, per [[slave]]. Does not apply to quest lodgers. {{Thought|desc=I sold a person into slavery. I hope nothing terrible happens to them.|label=sold slave|value=-5|stack=1|duration=6}} {{Thought|desc=I enslaved a person. It's hard to justify such actions.|label=enslaved prisoner|value=-5|stack=1|duration=6}} (Only if they weren't previously enslaved) {{Thought|desc=We sold a person into slavery. We shouldn't have done that.|label=slave sold|value=-2|stack=5|multi=0.75|duration=6}} (Colony wide). Does not apply to quest lodgers. {{Thought|desc=We enslaved someone. We shouldn't have done that.|label=prisoner enslaved|value=-2|stack=5|multi=0.75|duration=6}} (Colony wide). Does not apply to quest lodgers. '''Opinion:''' {{--|5}} for selling a pawn into slavery {{--|5}} opinion for enslaving a pawn
|-
| Acceptable || Slavery is a normal, unremarkable part of life. || || || ''No mood or opinion effects for enslaving, buying, or selling slaves.'' Faction will accept slaves when being traded with.
|-
| Honorable || One who owns and trades slaves should be honored and respected. || Not [[#Guilty|guilty]] Not [[#Individualist|individualist]] || [[#Supremacist|Supremacist]] [[#Collectivist|Collectivist]] [[#Pain is virtue|Pain is virtue]] || '''Mood:''' {{Thought|desc=We've got slaves. It means we're on the right path.|label=slaves in colony|value=+1}}, per [[slave]] {{Thought|desc=Without slaves, nobody will respect us.|label=no slaves in colony|value=-2|stack=1}}, if Low [[expectations]] or higher {{Thought|desc=I sold someone into slavery. It'll make people notice my stature.|label=sold slave|value=+4|stack=1|duration=6}} {{Thought|desc=I took someone into slavery. With no choice, they had to submit to me.|label=enslaved prisoner|value=+4|stack=1|duration=6}} (Only if they weren't previously enslaved) {{Thought|desc=We sold someone into slavery! A great display of our honor and power.|label=slave sold|value=+2|stack=5|multi=0.75|duration=6}} (Colony wide) {{Thought|desc=We enslaved someone. Now they know our honor and power!|label=prisoner enslaved|value=+2|stack=5|multi=0.75|duration=6}} (Colony wide) '''Opinion:''' {{+|10}} for selling a pawn into slavery {{+|10}} opinion for enslaving a pawn Faction will accept slaves when being traded with.
|- id="Women's spouses"
! rowspan=5 | Women's spouses [[File:SpouseCountFemale.png|64px]]
| One only || Women may have one spouse only. || || ||
|-
| Two or fewer || Women may have up to two spouses. || || [[#Female Supremacy|Female supremacy]] ||
|-
| Three or fewer || Women may have up to three spouses. || || [[#Female Supremacy|Female supremacy]] ||
|-
| Four or fewer || Women may have up to four spouses. || || [[#Female Supremacy|Female supremacy]] ||
|-
| Unlimited || Women may have as many spouses as they like. || || [[#Female Supremacy|Female supremacy]] ||

|- id="Men's spouses"
! rowspan=5 | Men's spouses [[File:SpouseCountMale.png|64px]]
| One only || Men may have one spouse only. || || ||
|-
| Two or fewer || Men may have up to two spouses. || || [[#Male Supremacy|Male supremacy]] ||
|-
| Three or fewer || Men may have up to three spouses. || || [[#Male Supremacy|Male supremacy]] ||
|-
| Four or fewer || Men may have up to four spouses. || || [[#Male Supremacy|Male supremacy]] ||
|-
| Unlimited || Men may have as many spouses as they like. || || [[#Male Supremacy|Male supremacy]] ||
|}

=== Optional ===
These precepts can be added through memes or by player choice.

{| class="wikitable sortable"
! Issue !! Precept !! Description !! Requirement !! Associated !! Effects
|- id="Slaughtering animals"
! rowspan="3"| Slaughtering animals [[File:AnimalSlaughter.png|64px]]
| Prohibited || Slaughtering animals is absolutely prohibited. || || [[#Animal personhood|Animal personhood]] [[#Nature Primacy|Nature primacy]] || '''Prohibitions:''' Slaughter animal '''Mood:'''
* {{Thought|desc=Someone slaughtered an animal! A tragic loss of a unique life.|label=animal slaughtered|value=-4|duration=6|stacks=5|multi=0.75}}
'''Opinions:''' Slaughtered animal: {{Bad|-10}}
|-
| Horrible || To slaughter an animal is a horrible thing. || || [[#Animal personhood|Animal personhood]] [[#Nature Primacy|Nature primacy]] || '''Mood:'''
* {{Thought|desc=I had to slaughter an animal! It was horrible to snuff out a mind like that.|label=slaughtered animal|value=-15|duration=6|stacks=1}}
* {{Thought|desc=Someone slaughtered an animal! What a horrible thing, to snuff out a mind like that.|label=animal slaughtered|value=-2|duration=6|stacks=5|multi=0.75}}
'''Opinions:''' Slaughtered animal: {{Bad|-5}}
|-
| Disapproved || To slaughter an animal is an ugly thing. || || [[#Animal personhood|Animal personhood]] [[#Nature Primacy|Nature primacy]] || '''Mood:'''
* {{Thought|desc=I had to slaughter an animal. It was an ugly thing to do.|label=slaughtered animal|value=-5|duration=6|stacks=1}}
* {{Thought|desc=Someone slaughtered an animal. It's a sad thing.|label=animal slaughtered|value=-1|duration=6|stacks=5|multi=0.75}}
'''Opinions:''' Slaughtered animal: {{Bad|-3}}
|- id="Apostasy"
! rowspan="3"| Apostasy [[File:Apostasy.png|64px]]
| Abhorrent || To leave our ideoligion after having known it is the depth of immorality. || Not [[#Guilty|Guilty]] || [[#Loyalist|Loyalist]] [[#Proselytizer|Proselytizer]] || '''Opinions:''' 
*Changed ideoligion: {{Bad|-30}} 
*Apostate: {{Bad|-10}} 
'''Stats:'''
* [[Global Certainty Loss Factor]]: {{Good|×40%}}
|-
| Horrible || To leave our ideoligion after having known it indicates deep moral flaws. || Not [[#Guilty|Guilty]] || [[#Loyalist|Loyalist]] [[#Proselytizer|Proselytizer]] || '''Opinions:''' 
*Changed ideoligion: {{bad|-15}} 
*Apostate: {{Bad|-5}} 
'''Stats:'''
* [[Global Certainty Loss Factor]]: {{Good|×60%}}
|-
| Disapproved || To leave our ideoligion after having known it indicates character flaws. || Not [[#Guilty|Guilty]] || [[#Loyalist|Loyalist]] [[#Proselytizer|Proselytizer]] || '''Opinions:''' 
*Changed ideoligion: {{Bad|-8}} 
*Apostate: {{Bad|-3}} 
'''Stats:'''
* [[Global Certainty Loss Factor]]: {{Good|×80%}}
|- id="Autonomous weapons"
! rowspan="3"| Autonomous weapons [[File:AutonomousWeapons.png|64px]]
| Prohibited || Allowing a machine to decide to kill is an absolutely inhuman thing to do. || || [[#Nature primacy|Nature primacy]] || Cannot build Turrets Colonists gain Mood: {{Thought|desc=We use automated weapons. It's absolutely abhorrent to give life-and-death decisions to a machine.|label=automated weapons|value=-12|stack=1}}
|-
| Horrible || Allowing a machine to decide to kill is a terrible thing. || || [[#Nature primacy|Nature primacy]] || Colonists gain Mood: {{Thought|desc=We use automated weapons. It's horrible to give life-and-death decisions to a machine.|label=automated weapons|value=-8|stack=1}}
|-
| Disapproved || Allowing a machine to decide to kill is an ugly thing. || || [[#Nature primacy|Nature primacy]] || Colonists gain Mood: {{Thought|desc=We use automated weapons. It's really ugly to give life-and-death decision to a machine.|label=automated weapons|value=-4|stack=1}}
|- id="Body modification"
! rowspan="3"| Body modification [[File:BodyModifications.png|64px]]
| Abhorrent || To modify the natural human body is a flagrant violation of clear moral laws. || Not [[#Transhumanist|Transhumanist]] || [[#Flesh purity|Flesh purity]] || '''Mood''':
* {{Thought|desc=I had to install an artificial body enhancement. This was deeply offensive to my beliefs.|label=installed enhancement|value=-30|duration=6}}
* {{Thought|desc=I have an artificial body enhancement. It's an abhorrent offense against everything I believe!|label=artificial enhancement|value=-18|duration=6}}
'''Opinion:''' {{Bad|-10}} against anyone that installed a prosthetic or artificial part, {{Bad|-5}} against anyone with a prosthetic or artificial part. 
These do not apply if the pawn is not a Body Modder. Xenogenes trigger this mood penalty if they are not inheritable.
|-
| Disapproved || To modify the natural human body is an ugly, dirty act. || Not [[#Transhumanist|Transhumanist]] || [[#Flesh purity|Flesh purity]] || '''Mood''':
* {{Thought|desc=I had to install an artificial body enhancement. This was clearly against my beliefs.|label=installed enhancement|value=-5|duration=6}}
* {{Thought|desc=I have an artificial body enhancement. I don't believe such things are acceptable.|label=artificial enhancement|value=-4|duration=6}}
'''Opinion:''' {{Bad|-5}} against anyone that installed a prosthetic or artificial part, {{Bad|-3}} against anyone with a prosthetic or artificial part. 
These do not apply if the pawn is not a Body Modder. Xenogenes trigger this mood penalty if they are not inheritable.
|-
| Approved || Humans should strive to reach our full potential by improving our flawed natural bodies. || Not [[#Flesh purity|Flesh purity]] || [[#Transhumanist|Transhumanist]] || '''Mood:'''
* {{Thought|desc=I don't have any artificial body enhancements. It's against my beliefs to be so unenhanced.|label=no artificial enhancement|value=-3|stack=1}} at or above moderate expectations, nullified by Body purist.
* {{Thought|desc=This artificial enhancement matches my belief.|label=transhumanist modded|value=1|stack=1}} for 1 artificial part.
* {{Thought|desc=The more artificial enhancements I get, the stronger my expression of my beliefs.|label=transhumanist connected|value=1|stack=1}} for 2 artificial part.
* {{Thought|desc=My connection to my belief is increased by my third artificial enhancement. But I could use more.|label=transhumanist enhanced|value=2|stack=1}} for 3 artificial part.
* {{Thought|desc=Only two more artificial enhancements are required to fully synchronize with my beliefs.|label=transhumanist synchronized|value=2|stack=1}} for 4 artificial part.
* {{Thought|desc=Five artificial enhancements! I'm beginning to feel perfect integration with my beliefs.|label=transhumanist integrated|value=3|stack=1}} for 5 artificial part.
* {{Thought|desc=It's as though I've left the weak flesh behind.|label=transhumanist transformed|value=3|stack=1}} for 5+ artificial part.
All bonus disabled for Body Modder. 
{{Bad|-3}} opinion for zero artificial parts if expectations ≥ Moderate (disabled for Body Purist) {{Check Tag|Xenogenes?|Xenogens count as artificial for body modder/purist traits, do they also count for ideo?}}
|- id="Charity"
! rowspan=3| Charity [[File:Charity.png|64px]]
| Essential || We must always be charitable to those in need. To refuse one would be an inhuman act, no matter the circumstances. || Not [[#Supremacist|supremacist]] Not [[#Pain is virtue|pain is virtue]] || [[#Guilty|Guilty]] || -8 mood for refusing to help on a charity quest<ref group="Optional precepts" name="Charity quest">Charity quest is one marked as such in the quest log, and includes: beggars, relic pilgrims, joining wanderer, crashing shuttle, pod crash refugee, refugees, chased noble, and joining wanderer in danger</ref> -12 mood for attacking beggars or pilgrims +4 mood for helping on a charity quest<ref group="Optional precepts" name="Charity quest"/>
|-
| Important || It's important to be charitable to those in need. Refusing to help is a terrible act. || Not [[#Supremacist|supremacist]] Not [[#Pain is virtue|pain is virtue]] || [[#Guilty|Guilty]] || -4 mood for refusing to help on a charity quest<ref group="Optional precepts" name="Charity quest"/> -8 mood for attacking beggars or pilgrims +2 mood for helping on a charity quest<ref group="Optional precepts" name="Charity quest"/>
|-
| Worthwhile || Helping those in need is a good thing. It makes the community stronger. || Not [[#Supremacist|supremacist]] Not [[#Pain is virtue|pain is virtue]] || [[#Guilty|Guilty]] || -2 mood for refusing to help on a charity quest<ref group="Optional precepts" name="Charity quest"/> -6 mood for attacking beggars or pilgrims +1 mood for helping on a charity quest<ref group="Optional precepts" name="Charity quest"/>
|- id="Drug use"
! rowspan=4| Drug use [[File:DrugUse.png|64px]]
| Prohibited || The body should absolutely not be poisoned by chemicals. The only exception is the use of medicine in direct medical care. || Not [[#High life|High life]] || [[#Flesh purity|Flesh purity]] [[#Collectivist|Collectivist]] || Pawns are unwilling to take or administer drugs 
* {{Thought|desc=I used a drug. Such chemicals in the body are a horrible offense against my beliefs.|label=used drug|value=-4|duration=3}}
* {{Thought|desc=I administered a drug. It was a horrible offense against my beliefs.|label=administered drug|value=-15|duration=3}}<ref group="Optional precepts" name="Drug use">As pawns with this precept are unwilling to administer drugs, this won't appear on normal gameplay.</ref>
{{Bad|-3}} opinion for consuming or administering a drug, for 5 days. 
None of the above applies to pawns with [[Traits#Chemical fascination|Chemical fascination]] or [[Traits#Chemical interest|Chemical interest]]
|-
| Medical only || Poisoning the body for recreational purposes is a deeply immoral act. || Not [[#High life|High life]] || [[#Collectivist|Collectivist]] || Pawns are unwilling to take or administer recreational drugs. 
* {{Thought|desc=I used a recreational drug. It was an offense against my beliefs.|label=used recreational drug|value=-15|duration=3}}
* {{Thought|desc=I administered a recreational drug. It was a horrible offense against my beliefs.|label=administered recreational drug|value=-15|duration=3}}
{{Bad|-5}} opinion for consuming or administering a recreational drug, for 5 days. 
None of the above applies to pawns with [[Traits#Chemical fascination|Chemical fascination]] or [[Traits#Chemical interest|Chemical interest]]
|-
| Medical or social only || A drink with a smoke is fine, especially with friends, but poisoning the body with powerful chemicals is wrong. || Not [[#High life|High life]] || [[#Collectivist|Collectivist]] || Pawns are unwilling to take or administer hard drugs.
* {{Thought|desc=I used a hard drug - not medical or even social. It was a horrible offense against my beliefs.|label=used hard drug|value=-15|duration=3}}
* {{Thought|desc=I administered a hard drug - not medical or even social. It was a horrible offense against my beliefs.|label=used hard drug|value=-15|duration=3}}
{{Bad|-8}} opinion for consuming or administering a hard drug, for 5 days. 
None of the above applies to pawns with [[Traits#Chemical fascination|Chemical fascination]] or [[Traits#Chemical interest|Chemical interest]]
|-
| Essential || Exotic states of mind are central to a good life. || [[#High life|High life]] || [[#High life|High life]]
| '''Stats:'''
* [[Drug Crop Harvest Yield]]: {{Good|×150%}}
* [[Drug Synthesis Speed]]: {{Good|×150%}}
* [[Drug Sell Price Improvement]]: {{+|10%}}
'''Moods''' (excludes [[Teetotaler]]s):
* {{Thought|desc=The right path goes through altered consciousness, and I am walking it.|label=high life|value=3|duration=0.75|stack=1}}
* {{Thought|desc=This is a hidden state.|label=high life|value=0|duration=0.25|stack=1}}. An invisible state.
* {{Thought|desc=I should be altering my consciousness. It's not right to be sober so long.|label=high life missing|value=-1|duration=1|stack=1}}
* {{Thought|desc=I should be altering my consciousness. It's not right to be sober so long.|label=high life missing|value=-10|duration=9|stack=1}}
The moods above are scaled linearly based on the time since last non-medical drug ingested. First a {{Good|+3}} mood that last 0.75 days, decaying to 0 over the course the following 0.25 days. At 2 days since last consumption, first mood penalty applies. This penalty will increase by {{Bad|-1}} each day without further consumption, reaching the maximum of {{Bad|-10}} at 11 days.
|- id="Combat in darkness"
! Combat in darkness [[File:DarknessCombat.png|64px]]
| Preferred || We fight better in the dark. || Not [[#Blindsight|blindsight]] || [[#Darkness|Darkness]]
| '''Stats:'''
* [[Shooting Accuracy]]:
** [[Shooting Accuracy Outdoors Dark|Outdoors Dark]] and [[Shooting Accuracy Indoors Dark|Indoors Dark]]: {{+|25%}}
** [[Shooting Accuracy Outdoors Lit|Outdoors Lit]] and [[Shooting Accuracy Indoors Lit|Indoors Lit]]: {{--|20%}}
* [[Melee Dodge Chance]]:
** [[Melee Dodge Chance Outdoors Night|Outdoors Night]] and [[Melee Dodge Chance Indoors Dark|Indoors Dark]]: {{+|10%}}
** [[Melee Dodge Chance Outdoors Day|Outdoors Day]] and [[Melee Dodge Chance Indoors Lit|Indoors Lit]]: {{--|10%}}
* [[Melee Hit Chance]]:
** [[Melee Hit Chance Outdoors Dark|Outdoors Dark]] and [[Melee Hit Chance Indoors Dark|Indoors Dark]]: {{+|10%}}
** [[Melee Hit Chance Outdoors Lit|Outdoors Lit]] and [[Melee Hit Chance Indoors Lit|Indoors Lit]]: {{--|10%}}
|- id="Cutting trees"
! rowspan=3 | Cutting trees [[File:Precept tree cutting.png|64px]]
| Prohibited || To violate the forest by cutting down a tree is a deeply abhorrent act and should never be done. || Not [[#Human primacy|Human primacy]] || [[#Nature primacy|Nature primacy]] || Disables logging camps. Pawns will not cut trees {{Thought|desc=We cut down a tree. Such things violations of nature should never be done.|label=tree felled|value=-4|stack=5|multi=0.75|duration=3}} for cutting a tree {{Thought|desc=We extracted a tree from the ground and then let it die. Such things violations of nature should never be done.|label=extracted tree died|value=-4|stack=5|multi=0.75|duration=3}} for an uprooted tree dying {{--|10}} opinion for cutting a tree
|-
| Horrible || To cut down a tree is a horrible act. || Not [[#Human primacy|Human primacy]] || [[#Nature primacy|Nature primacy]] || Disables logging camps. {{Thought|desc=I had to cut down a tree. It was wrong to scar nature this way.|label=tree felled|value=-10|stack=1|duration=3}} for cutting a tree {{Thought|desc=We cut down a tree. It's wrong to scar nature this way.|label=tree felled|value=-2|stack=5|multi=0.75|duration=3}} for a tree cut {{Thought|desc=We extracted a tree from the ground and let it die. It's wrong to scar nature this way.|label=extracted tree died|value=-2|stack=5|multi=0.75|duration=3}} for an uprooted tree dying {{--|5}} opinion for cutting a tree
|-
| Disapproved || To cut down a tree is a distasteful thing to do. || Not [[#Human primacy|Human primacy]] || [[#Nature primacy|Nature primacy]] || Disables logging camps. {{Thought|desc=I had to cut down a tree. It was wrong to scar nature this way.|label=tree felled|value=-5|stack=1|duration=3}} for cutting a tree {{Thought|desc=We cut down a tree. It wasn't good to harm nature this way.|label=tree felled|value=-1|stack=5|duration=3}} for a tree cut {{Thought|desc=We extracted a tree from the ground and let it die. It wasn't good to harm nature this way.|label=extracted tree died|value=-1|stack=5|multi=0.75|duration=3}} for an uprooted tree dying {{--|3}} opinion for cutting a tree
|- id="Killing innocent animals"
! rowspan="3" | Killing innocent animals [[File:KillingInnocentAnimals.png|64px]]
| Abhorrent || To kill an innocent animal is a horrifically inhuman act. Innocent animals are those who are not attacking, or who were only driven to attack by human provocation.<ref group="Optional precepts" name="Innocent animal">An animal is deemed innocent if: It isn't under a mental state, or the mental state was caused by damage (ex: Manhunter, PanicFlee) or psycast (ex: Berserk, Neuroquake psycast). The above excludes animals belonging to hostile factions, animals hunting humans (or animals belonging to a human faction), and animals with scaria.</ref> || Not [[#Human primacy|human primacy]] || [[#Nature primacy|Nature primacy]] [[#Animal personhood|Animal personhood]] || Disables hunting camps Pawns will not attack innocent animals {{Thought|desc=An innocent, adorable animal was killed! That's murder!|label=innocent animal killed|value=-4|stack=5|mult=0.75|duration=6}} if innocent animal is killed {{--|15}} opinion for killing innocent animal
|-
| Horrible || To kill an innocent animal is a horrible act. Innocent animals are those who are not attacking, or who were only driven to attack by human provocation. || Not [[#Human primacy|human primacy]] || [[#Nature primacy|Nature primacy]] [[#Animal personhood|Animal personhood]] || Disables hunting camps {{Thought|desc=I had to kill an innocent animal. It was almost like being forced to murder.|label=killed innocent {0}|value=-15|duration=6}} for killing an innocent animal {{Thought|desc=An innocent animal was killed. What a terrible, heartless act against another being.|label=innocent animal killed|value=-2|stack=5|mult=0.75|duration=6}} if innocent animal is killed {{--|10}} opinion for killing innocent animal
|-
| Disapproved || To kill an innocent animal is an ugly act. Innocent animals are those who are not attacking, or who were only driven to attack by human provocation. || Not [[#Human primacy|human primacy]] || [[#Nature primacy|Nature primacy]] [[#Animal personhood|Animal personhood]] || Disables hunting camps {{Thought|desc=I had to kill an innocent animal. It was not something I approve of.|label=killed innocent {0}|value=-5|duration=6}} for killing an innocent animal {{Thought|desc=An innocent animal was killed. I do not approve of this.|label=innocent animal killed|value=-1|stack=5|mult=0.75|duration=6}} if innocent animal is killed {{--|5}} opinion for killing innocent animal

|- id="Lighting"
! Lighting [[File:Lighting.png|64px]]
| Darklight preferred || Normal lights are too bright. Darklights are better. || Not [[#Blindsight|blindsight]] || [[#Darkness|Darkness]] || {{Thought|desc=This dim light is perfect. I feel focused and energized.|label=darklight|value=+4|stack=1}} with [[Darklight]] {{Thought|desc=This indoor light is too bright. I would prefer something dimmer.|label=indoor light|value=-4|stack=1}} in dim light (30% - 89% [[light]]){{Check Tag|Verify|Verify bounds match normal definition}} {{Thought|desc=I cannot stand this terrible light. My senses are overwhelmed!|label=blinding light|value=-8|stack=1}} in bright light. (90% - 100% [[light]]){{Check Tag|Verify|Verify bounds match normal definition}} No modifier for Darkness. (0% - 29% [[light]]){{Check Tag|Verify|Verify bounds match normal definition}} Surgery penalty without Darklight. Disables low-[[light]] [[move speed]] penalties Disables low-[[light]] [[global work speed]] penalties
|- id="Meat eating"
! rowspan=6 | Meat eating [[File:MeatEating.png|64px]]
| Abhorrent || Eating meat of any kind is deeply evil. || Not [[#Human primacy|human primacy]] || [[#Animal personhood|Animal personhood]] [[#Flesh purity|Flesh purity]] || Disables hunting camps {{Thought|desc=I had to eat meat. It was an abhorrent violation of everything I believe.|label=ate meat|value=-24|duration=1|stack=1}} for eating meat {{--|15}} opinion for eating meat
|-
| Horrible || Eating meat of any kind is a horrible act. || Not [[#Human primacy|human primacy]] || [[#Animal personhood|Animal personhood]] [[#Flesh purity|Flesh purity]] || Disables hunting camps {{Thought|desc=I had to eat meat. It was a horrible violation of my beliefs.|label=ate meat|value=-12|duration=1|stack=1}} for eating meat {{--|10}} opinion for eating meat
|-
| Disapproved || Eating meat of any kind should be avoided. || Not [[#Human primacy|human primacy]] || [[#Animal personhood|Animal personhood]] [[#Flesh purity|Flesh purity]] || Disables hunting camps {{Thought|desc=I had to eat meat. It's not something I approve of.|label=ate meat|value=-4|duration=1|stack=1}} for eating meat {{--|5}} opinion for eating meat
|-
| Mildly required || Every meal ought to have meat. || Not [[#Human primacy|human primacy]] || [[#Animal personhood|Animal personhood]] (but conflicts) [[#Flesh purity|Flesh purity]] || Disables farming camps {{Thought|desc=I ate a meal without any meat. It was an unacceptable deviation from the proper carnivore diet. Some eggs, milk, or processed food without vegetables or would have also been okay.|label=ate vegetarian|value=-4|duration=1|stack=1}} for eating food without meat {{--|5}} opinion for eating food without meat
|-
| Seriously required || Every meal must have meat. Eggs, milk, and processed food are okay as well. || Not [[#Human primacy|human primacy]] || [[#Animal personhood|Animal personhood]] (but conflicts) [[#Flesh purity|Flesh purity]] || Disables farming camps {{Thought|desc=I ate a meal without any meat. It was an horrible violation of the proper carnivore diet. Some eggs, milk, or processed food without vegetables would have also been okay.|label=ate vegetarian|value=-10|duration=1|stack=1}} for eating food without meat {{--|10}} opinion for eating food without meat
|-
| Strictly required || If a meal doesn't have meat, the person who eats it must be morally deficient. Eggs, milk, and processed foods are fine. || Not [[#Human primacy|human primacy]] || [[#Animal personhood|Animal personhood]] (but conflicts) [[#Flesh purity|Flesh purity]] || Disables farming camps {{Thought|desc=I ate a meal without any meat. It was an abhorrent violation of the proper carnivore diet. Some eggs, milk, or processed food without vegetables would have also been okay.|label=ate vegetarian|value=-16|duration=1|stack=1}} for eating food without meat {{--|15}} opinion for eating food without meat

|- id="Mining"
! rowspan=3 | Mining [[File:Mining.png|64px]]
| Prohibited || Raping the natural earth with mining tools is a horrifically evil act. || Not [[#Human primacy|human primacy]] Not [[#Tunneler|tunneler]] || [[#Nature primacy|Nature primacy]] || Disables mining camps Pawns will not mine 
* {{Thought|desc=We mined a hole in the pure earth. What a terrible offense against nature.|label=mined|value=-4|duration=2|stacks=5|multi=0.75}}
* {{Thought|desc=I destroyed a natural wall. What a terrible offense against nature.|label=destroyed natural wall|value=-40|duration=2|stacks=1}}
{{Bad|-15}} opinion for mining a block, for 4 days.
|-
| Horrible || Violating the natural earth with mining tools is a horrible act. || Not [[#Human primacy|human primacy]] Not [[#Tunneler|tunneler]] || [[#Nature primacy|Nature primacy]] || Disables mining camps 
* {{Thought|desc=I had to mine a hole. It was an offense against the earth.|label=mined|value=-20|duration=2|stacks=1}}
* {{Thought|desc=Someone mined a hole in the pure earth. It was a horrible violation of nature.|label=mined|value=-2|duration=2|stacks=5|multi=0.75}}
* {{Thought|desc=I destroyed a natural wall. It was a horrible violation of nature.|label=destroyed natural wall|value=-20|duration=2|stacks=1}}
{{Bad|-10}} opinion for mining a block, for 2 days.
|-
| Disapproved || Mining into the natural earth is an ugly act. || Not [[#Human primacy|human primacy]] Not [[#Tunneler|tunneler]] || [[#Nature primacy|Nature primacy]] || Disables mining camps 
* {{Thought|desc=I had to mine a hole. I disapprove of harming the earth this way.|label=mined|value=-3|duration=2|stacks=1}}
* {{Thought|desc=Someone mined a hole in the pure earth. It's wrong to scar the world this way.|label=mined|value=-1|duration=2|stacks=5|multi=0.75}}
* {{Thought|desc=I destroyed a natural wall. It's wrong to scar the world this way.|label=destroyed natural wall|value=-3|duration=2|stacks=1}}
{{Bad|-5}} opinion for mining a block, for 2 days.
|- id="Raiding"
! rowspan=2 | Raiding [[File:Raiding.png|64px]]
| Respected || We don't work like common laborers, we take from the weak as the strong should. Failing to do so is a mark of shame. || || || '''Mood:''' {{+|3}} mood for 5 days for participating in a raid {{+|6}} mood for a raid less than 25 days ago {{--|6}} mood for a raid more than 25 days ago 
'''Stats:'''
* [[Global Work Speed]] {{--|8%}}
|-
| Required || We don't work like common laborers, we take from the weak as the strong should. Failing to do so is a tremendous shame. || || || '''Mood:''' {{+|6}} mood for 5 days for participating in a raid {{+|12}} mood for a raid less than 25 days ago {{--|12}} mood for a raid more than 25 days ago 
'''Stats:'''
* [[Global Work Speed]] {{--|16%}}
|- id="Trees"
! Trees [[File:Trees.png|64px]]
| Desired || It's essential to live surrounded by beautiful trees. || || [[#Tree connection|Tree connection]] || Gives a thought, scaling from -5 to +9 for having (or not having) many trees on the map Gives a thought, scaling from 0 to -20 for the number of trees chopped in the last quadrum
|- id="Biosculpting"
! rowspan="2" | Biosculpting [[File:Precept biosculpting.png|64px]]
| Despised || Biosculpter pods violate the purity human flesh and should never be used. || Not [[#Transhumanist|Transhumanist]] || || '''Mood:''' {{Thought|desc=My body was despoiled by the use of a biosculpter pod.|label=used biosculpter pod|value=-8|stack=1|duration=12}} after using [[biosculpter pod]].
|-
| Accelerated || All biosculpting cycles take half the usual time. || [[#Transhumanist|Transhumanist]] || [[#Transhumanist|Transhumanist]] || All biosculpting cycles take half the usual time.
|- id="Growth vats"
! rowspan="2"| Growth vats{{BiotechIcon}} [[File:GrowthVats.png|64px]]
| Prohibited || Growth vats rob children of their childhood. || || || '''Prohibitions:''' Build [[growth vat]] '''Mood:'''
* {{Thought|desc=I hate the thought of that awful growth vat being in our colony.|label=growth vat|value=-3|stack=1}} 
* {{Thought|desc=I can't stand the thought of my child floating in that awful machine.|label=my child is in a growth vat|value=-3|stack=3}}. Nullifying trait: [[Psychopath]] 
* {{Thought|desc=I'm happy to see my kids be kids. Their childhood is too precious to be wasted in a vat.|label=Child not in growth vat|value=1|stack=1}} 
|-
| Essential || We have the technology for safer childbirth and faster childhoods. Believers will develop faster in growth vats but will be unhappy if their children are not in a vat. || || [[#Transhumanist|Transhumanist]] || '''Mood:'''
* {{Thought|desc=Childbirth is a terrifying thought. We should have vats to safely grow our children.|label=natural pregnancy|value=-5|stack=1}}. Minimum [[expectations]]: Moderate
* {{Thought|desc=I don't feel safe with my child running around. They should be growing safely in a vat.|label=Child not in growth vat|value=-2|stack=3}}. Minimum [[expectations]]: Moderate 
'''Stats:'''
* {{BiotechIcon}} [[Growth Vat Occupant Speed]]: {{Good|×130%}} (only to pawns with the ideoligion; [[embryo]]s / [[babies]] are not boosted)
|- id="Bloodfeeders"
! rowspan="2"| Bloodfeeders{{BiotechIcon}} [[File:Bloodfeeders.png|64px]]
| Revered || Bloodfeeders should be worshipped. Believers will be happy if there is a bloodfeeder in the colony and will not mind being fed upon. || || || '''Mood:'''
* {{Thought|desc=The bloodfeeders stand above us, yet one has died here. We will surely be punished for this.|label=bloodfeeder died|value=-2|stack=3|duration=10}} (Colony wide) when a bloodfeeder dies.{{Check Tag|Any faction?|Does the bloodfeeder have to be of the player faction? Any allied faction? Any faction at all including enemies?}}.
* {{Thought|desc=Let them worship me. Feeding upon them places them below me, as animals are below humans.|label=revered bloodfeeder|value=+4|stack=1}} for being a bloodfeeder.
* {{Thought|desc=Without a bloodfeeder master, our colony feels incomplete and pointless. We should make a bloodfeeder our leader.|label=no bloodfeeders|value=-2|stack=1}} (Colony wide) for having no bloodfeeders in the colony.
* {{Thought|desc=Without a bloodfeeder master, our colony feels incomplete and pointless. We should make a bloodfeeder our leader.|label=no bloodfeeder master|value=-1|stack=1}} (Colony wide) for having bloodfeeders in the colony, but not as the [[#Leaders|leader]].
* {{Thought|desc=The bloodfeeder's presence is a great honor. May they live forever.|label=bloodfeeder master|value=+2|stack=1}} (Colony wide) for having A bloodfeeder as the [[#Leaders|leader]].
Nullifies {{Thought|desc=I was violated by a bloodfeeder like some kind of livestock.|label=fed on by <NAME>|value=-5|stack=1|duration=5}}{{Check Tag|Stacking?|Check if it stacks, change stack var as appropriate}} '''Opinions:''' {{+|20}} for being a Bloodfeeder
|-
| Reviled || Anyone who drinks blood to survive is a monster. || || || '''Mood:'''
* {{Thought|desc=The only good bloodfeeder is a dead one.|label=bloodfeeder died|value=+5|stack=3|duration=10}} (Colony wide) when a bloodfeeder dies.
* {{Thought|desc=I am what I hate. I must rid myself of this curse.|label=bloodfeeder self hatred|value=-12|stack=1}} for being a bloodfeeder.
* {{Thought|desc=One of them walks among us. We should expel the bloodfeeder from our home.|label=bloodfeeder among us|value=-8|stack=1}} (Colony wide) for having a bloodfeeder in the colony.
'''Opinions:''' {{--|40}} for being a Bloodfeeder
|- id="Child labor"
! rowspan="2"| Child labor{{BiotechIcon}} [[File:ChildLabor.png|64px]]
| Encouraged || Children build character through work. It's important for everyone to contribute.|| || [[#Collectivist|Collectivist]] || '''Mood:'''
* {{Thought|desc=Why are we letting children waste their youth on games?|label=children assigned recreation|value=-3|stack=1}}. Adults only. 
'''Stats:'''
* [[Global Work Speed]]: {{+|20%}} ([[Children]] only)
|-
| Disapproved || Childhood is sacred. We should let kids be kids. || || [[#Individualist|Individualist]] || '''Mood:'''
* {{Thought|desc=It's upsetting to see children forced to work. They only get one childhood.|label=children assigned work|value=-3|stack=1}}. Adults only. Note: This refers to the Schedule tab. Children can have jobs assigned in their Work tab without mood penalty. 
'''Stats:'''
* [[Learning Rate Factor]]: {{+|20%}} ([[Children]] only)
|- id="Mechanoid labor"
! Mechanoid labor{{BiotechIcon}} [[File:MechanoidLabor.png|64px]]
| Enhanced || Why should we work when we have machines? || ||
| '''Stats:'''
* [[Global Work Speed]]: {{--|8%}}
* {{BiotechIcon}} [[Mech Work Speed Offset]]: {{+|20%}}
|- id="Psychic rituals"
! rowspan=3| Psychic rituals{{AnomalyIcon}} [[File:PsychicRituals.png|64px]]
| Abhorrent || Psychic rituals are utterly evil. || || || '''Prohibitions:''' Participate in psychic ritual '''Mood:''' Psychic ritual performed: {{--|4}} Involved in psychic ritual: {{--|12}} '''Opinions:''' Involved in psychic ritual: {{--|20}}
|-
| Disapproved || Psychic rituals should be avoided when possible. || || ||| '''Mood:''' {{Thought|desc=We shouldn't be using such dark powers. It's just not right.|label=Psychic ritual performed|value=-2|stack=1}} {{Thought|desc=That ritual was wrong. I should not have been there.|label=Involved in psychic ritual|value=-6|stack=1}} '''Opinions:''' Involved in psychic ritual: {{--|10}} '''Stats:'''
* [[Psychic Ritual Quality Offset]]: {{--|10%}}
|-
| Exalted || Connecting with psychic flows brings us closer to truth. || || [[#Ritualist|Ritualist]] || '''Mood:''' {{Thought|desc=It was an amazing experience to truly connect with something greater than myself.|label=Involved in psychic ritual|value=+3|stack=1}}. {{Thought|desc=Failing to use these rituals shows everyone how misguided we are.|label=No psychic ritual for 6 days (Min expectations: High)|value=-3|stack=1}}. '''Opinions:''' Involved in psychic ritual: {{+|10}} '''Stats:'''
* [[Psychic Ritual Quality Offset]]: {{+|10%}}
|- id="Void study"
! rowspan=4| Void study{{AnomalyIcon}} [[File:VoidStudy.png|64px]]
| Very inefficient || All this void nonsense is superstition. Let's focus on reality. || ||
| '''Stats:'''
* [[Study Efficiency]]: {{Bad|×50%}}
|-
| Inefficient || Trying to understand the unknowable is pointless. We should focus more on meaningful activities. || ||
| '''Stats:'''
* [[Study Efficiency]]: {{Bad|×75%}}
|-
| Efficient || The void is a true mystery that deserves to be studied. || ||
| '''Stats:'''
* [[Study Efficiency]]: {{Good|×125%}}
|-
| Very efficient || The void is the ultimate truth. || || [[#Ritualist|Ritualist]]
| '''Stats:'''
* [[Study Efficiency]]: {{Good|×150%}}
|-
|- id="Inhumanizing"
! Inhumanizing{{AnomalyIcon}} [[File:Inhumanizing.png|64px]]
| Required || Human morality and feeling are a distraction. We must leave humanity behind. Mental breaks will cause followers to become [[inhumanized]]. || || [[#Inhuman|Inhuman]] || '''Mood:'''
*{{Thought|desc=I'm ashamed of my humanity. I want to embrace the void but I fear it.|label=Human shame|value=-8|stack=1}} if not inhumanized.
'''Mental breaks:'''
* [[Mental_break#Humanity_break|Humanity break]]
|-

|- id="Fishing"
! rowspan=3 | Fishing{{OdysseyIcon}} [[File:Fishing.png|64px]]
| Prohibited || Fishing is immoral. We should never do it. || || [[#Animal Personhood|Animal Personhood]] || '''Prohibitions:''':
*[[Fishing]]
'''Mood''':
*{{Thought|desc=Someone is killing fish! Our slippery brothers and sisters are dying.|label=Someone slaughtered fish|value=-4|stack=1|duration=6}}.
{{--|10}} opinion for slaughtering fish
|-

|-
| Disapproved || Fishing is gruesome. We should avoid it. || || [[#Animal Personhood|Animal Personhood]] || '''Mood''':
*{{Thought|desc=I had to kill fish. It was an ugly thing to do.|label=Slaughtered fish|value=-4|stack=1|duration=6}}.
*{{Thought|desc=Someone is killing fish! We should protect these beautiful creatures.|label=Someone slaughtered fish|value=-2|stack=1|duration=6}}.
'''Stats''':
*[[Fishing speed]]: {{--|25%}}
*[[Fishing yield]]: {{--|10%}}
{{--|5}} opinion for slaughtering fish
|-

|-
| Sacred || Fishing is part of the right path. || || || '''Mood''':
*{{Thought|desc=I wish we were somewhere we could fish.|label=Not enough fish|value=-4|stack=1}}.
*{{Thought|desc=Fishing puts me on the right path - at least for a little while.|label=Fished recently|value=+2|stack=1|duration=1}}.
'''Stats''':
*[[Fishing yield]]: {{Good|+10%}}
|-

|}
<references group="Optional precepts"/>

=== Meme-specific ===
These issues and their precepts can only be added by having a specific meme, and cannot be removed as long as the meme is present.

{| class="wikitable sortable"
! Issue !! Precept !! Description !! Meme !! Effects

|- id="Age reversal"
! Age reversal [[File:AgeReversal.png|64px]]
| Demanded || Why get old? One must have a once-yearly age reversal treatment in the biosculpter pod. || [[#Transhumanist|Transhumanist]] || '''Mood:''' {{Thought|desc=I'm getting old. I should get an age reversal in a biosculpter pod.|label=harmful aging|value=-4|stack=1}}, if a pawn with at least high expectations and a biological age of 25 didn't have age reversal in the last year. {{Thought|desc=My youth is draining away. I should get an age reversal in a biosculpter pod.|label=terrible aging|value=-7|stack=1}}, if a pawn with at least high expectations and a biological age of 25 didn't have age reversal in the last year and 15 days. {{Thought|desc=I am trapped in a decaying prison of flesh! I need to get an age reversal in a biosculpter pod.|label=horrific aging|value=-10|stack=1}}, if a pawn with at least high expectations and a biological age of 25 didn't have age reversal in the last year and 30 days. {{Thought|desc=Aging and death have no hold on me. I am forever, as an enhanced human ought to be.|label=received age reversal|value=+3|stack=1|duration=4}} after age reversal. '''Notes:'''
*Initial colonists, newly generated pawns (due to events, quests, raids, etc.), as well as pawns after changing map due to Archonexus quest have a 20 to 40 day grace period before they start demanding age reversal (it will replace their age reversal demanded date, even if it would come after that period).
*Whenever a pawn's faction or ideology change they'll get a 15-20 day grace period before they start demanding age reversal (unless their next age reversal demanded date will come after that period).

|- id="Animal connection"
! Animal connection [[File:Precept animal connection.png|64px]]
| Strong || We have a strong connection to our animal friends || [[#Animal personhood|Animal personhood]] ||
* 2x [[Tame Animal Chance]]
* 2x [[Bond Chance Factor]]

|- id="Blind psysense"
! Blind psysense [[File:BlindPsysense.png|64px]]
| Strong|| Our blind have special ways of connecting with the psychic aether || [[#Blindsight|Blindsight]] || '''Stats:''' [[Psychic Sensitivity]]: {{+|30%}} for [[Sight|blind]] pawns.

|- id="Bonding"
! Bonding [[File:Bonding.png|64px]]
| Disapproved || To emotionally bond with a lower being is a shameful act || [[#Human primacy|Human primacy]] || Disables [[Animals#Bonding|animal bonding]] event for pawns with ideology. Does '''not''' disable pre-existing bonds or disable their [[thoughts]].

|- id="Comfort"
! Comfort [[File:Comfort.png|64px]]
| Ignored || We should pay no attention to comfort || [[#Pain is virtue|Pain Is Virtue]] || Disables [[comfort]] need, and comfort-related thoughts, both positive and negative

|- id="Eclipse"
! Eclipse [[File:Precept Eclipse.png|64px]]
| Beautiful || Eclipses are a beautiful respite from the blinding sunlight. || [[#Darkness|Darkness]] ''unless'' [[#Blindsight|blindsight]] || {{+|5}} mood for seeing an [[eclipse]]

|- id="Gauranlen connection"
! Gauranlen connection [[File:GauranlenConnection.png|64px]]
| Strong || We have a special connection with the Gauranlen trees. The trees refocus production easily under our influence, and we are not satisfied unless we have that connection. || [[#Tree connection|Tree connection]] || '''Mood:''' {{Thought|desc=I am happily connected to a Gauranlen tree.|label=Gauranlen connection|value=+3|stack=1}} when connected to [[Gauranlen tree]]. {{Thought|desc=Without a connection to a Gauranlen tree, I feel disconnected from nature.|label=want Gauranlen connection|value=-0|stack=1}}, at Very Low [[expectations]]. {{Thought|desc=Without a connection to a Gauranlen tree, I feel disconnected from nature.|label=want Gauranlen connection|value=-1|stack=1}}, at Low [[expectations]]. {{Thought|desc=Without a connection to a Gauranlen tree, I feel disconnected from nature.|label=want Gauranlen connection|value=-2|stack=1}}, at Moderate [[expectations]]. {{Thought|desc=Without a connection to a Gauranlen tree, I feel disconnected from nature.|label=want Gauranlen connection|value=-4|stack=1}}, at High [[expectations]]. {{Thought|desc=Without a connection to a Gauranlen tree, I feel disconnected from nature.|label=want Gauranlen connection|value=-6|stack=1}}, at Sky High [[expectations]]. '''Stats:''' [[Pruning speed]]: {{+|25%}}

|- id="Mining yield"
! Mining yield [[File:MiningYield.png|64px]]
| High || Mining is so important that we do it with great focus and respect, and we get more resources because of that. || [[#Tunneler|Tunneler]] || '''Stats:''' [[Mining yield]]: {{+|10%}}

|- id="Neural supercharge"
! Neural supercharge [[File:NeuralSupercharger.png|64px]]
| Preferred || Having a neural supercharge is the new standard. Without it, you're obsolete. || [[#Transhumanist|Transhumanist]] || '''Mood:''' {{Thought|desc=Without a neural supercharge, I'm running below my true capacity. It's depressing.|label=want neural supercharge|value=-6|stack=1}} whenever 2+{{Check Tag|Verify time|Is it two days?}} days have passed since [[Neural supercharger|neural supercharging]], assuming Moderate [[expectations]] or higher.

|- id="Pain"
! Pain [[File:Pain.png|64px]]
| Idealized || To experience nerve-singing pain is a mark of morality. || [[#Pain is virtue|Pain is virtue]] [[#Guilty|Guilty]] || '''Mood:''' {{Thought|desc=The pain grounds me. I appreciate it|label=minor pain|value=+3|stack=1}}, [[pain]] between 1% and 14% inclusive. Replaces default {{--|5}} {{Thought|desc=The pain cleanses me. I like it.|label=serious pain|value=+5|stack=1}}, [[pain]] between 15% and 39% inclusive. Replaces default {{--|10}} {{Thought|desc=The pain purifies me. I need it!|label=intense pain|value=+7|stack=1}}, [[pain]] between 40% and 79% inclusive. Replaces default {{--|15}} {{Thought|desc=The pain makes me sublime! I wish to become it!|label=mind-shattering pain|value=+9|stack=1}}, [[pain]] of 80%+. Replaces default {{--|20}} '''Note:''' These thoughts are replaced by the [[Masochist]] specific thoughts for pawns with that trait, and with the default values for [[Wimp]]s.

|- id="Proselytizing"
! rowspan=3 | Proselytizing [[File:Proselytizing.png|64px]]
| Occasional || Those who know the truth should try to bring it to others, when it seems appropriate. || [[#Proselytizer|Proselytizer]] || '''Stats:''' Social chat [[conversion]] attempt frequency: '''×300''' '''Development points:''' {{+|1}} each pawn converted to the ideoligion.{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}} {{+|5}} for a successful [[relic]] hunt.{{Check Tag|Final Quest only?|Is this only given when the relic is actually acquired?}}{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}} {{+|2}} for each successful Reliquary Pilgrims quest.{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}}
|-
| Sometimes || Those who know the truth should bring it to others at every opportunity. || [[#Proselytizer|Proselytizer]] || '''Stats:''' Social chat [[conversion]] attempt frequency: '''×500''' '''Development points:''' {{+|1}} each pawn converted to the ideoligion.{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}} {{+|5}} for a successful [[relic]] hunt.{{Check Tag|Final Quest only?|Is this only given when the relic is actually acquired?}}{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}} {{+|2}} for each successful Reliquary Pilgrims quest.{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}}
|-
| Frequent || Those who know the truth have a duty to always spread it and drive out other beliefs. || [[#Proselytizer|Proselytizer]] || '''Stats:''' Social chat [[conversion]] attempt frequency: '''×700''' '''Development points:''' {{+|1}} each pawn converted to the ideoligion.{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}} {{+|5}} for a successful [[relic]] hunt.{{Check Tag|Final Quest only?|Is this only given when the relic is actually acquired?}}{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}} {{+|2}} for each successful Reliquary Pilgrims quest.{{Check Tag|Verify|Based on code, needs to be tested and confirmed in game}}

|- id="Ranching"
! Ranching [[File:Ranching.png|64px]]
| Central || We must raise and consume many large animals, and we must not eat plants. || [[#Rancher|Rancher]] || '''Stats:''' [[Plant Work Speed]]: {{Bad|x70%}} [[Tame Animal Chance]]: {{Good|x120%}} [[Animal Gather Yield]]: {{Good|x120%}} [[Butchery Efficiency]]: {{Good|x120%}} [[Animals Learning Factor]]: {{Good|x200%}}. [[Animal Products Price Improvement]]: {{+|10%}}.{{Check Tag|Mechanics?|How does this apply in the order of operations}} Affects [[meat]], [[leather]] and [[wool]] of all types, including [[Human]]. [[Eggs]], [[milk]], [[insect jelly]], and live [[animals]] are not affected. '''Mood:''' {{--|3}}/{{--|2}}/{{--|1}}/{{+|1}}/{{+|2}}/{{+|3}} [[mood]] based on total animal body size per colonist,{{Check Tag|What ratios?|What ratio is each cut off?}}{{Check Tag|Colonist only?|Wb slaves, prisoners, quest guests etc? What about colonists without this precept?}} if Low [[expectations]] or higher. Does not apply to quest lodgers. {{Thought|desc=I sowed a human food plant. It was wrong - humans should eat animals, and animals should eat nature-made plants.|label=sowed human food plant|value=-4|duration=2}} if Low [[expectations]] or higher.{{Check Tag|Which plants?}}{{Check Tag|Sow only?|Can you harvest plants without issue?}} Does not apply to quest lodgers. '''Development points:''' {{+|2}} for each successful [[Quests#Hospitality|Animal hospitality]] quest.{{RoyaltyIcon}}

|- id="Rough living"
! Rough living [[File:RoughLiving.png|64px]]
| Welcomed || We don't need to separate ourselves from the roughness of nature. || [[#Tree connection|Tree connection]] [[#Pain is virtue|Pain Is Virtue]] || Nullifies:
*{{Thought|desc=I had to eat a meal off the ground. Can't we get a table around here?|label=Ate without table|value=-3|stack=1|duration=1}}
*{{Thought|desc=I had to sleep outdoors without any protection from the elements.|label=slept outside|value=-4|stack=1|duration=1}}
*{{Thought|desc=I had to sleep on the ground like an animal.|label=slept on ground|value=-4|stack=1|duration=1}}
*{{Thought|desc=I'm soaking wet.|label=soaking wet|value=-3|stack=1|duration=0.1}}

|- id="Slab bed"
! Slab bed [[File:Precept Slab Bed.png|64px]]
| Preferred || The right way to sleep is on a slab bed. || [[#Pain is virtue|Pain is virtue]] || Makes colonists prefer slab beds, and gives a +2 thought when they sleep in slab beds.

|- id="Sleep accelerator"
! Sleep accelerator [[File:Precept sleep accelerator.png|64px]]
| Preferred || One should always use a sleep accelerator. Slow-sleeping is just foolishly wasting your potential. || [[#Transhumanist|Transhumanist]] || +3 mood for 1 day when using [[sleep accelerator]]

|- id="Indoors"
! Indoors [[File:SmallSpaces.png|64px]]
| Preferred || We were meant to live indoors. There's nothing bothersome about being in tight quarters. || [[#Tunneler|Tunneler]] [[#Shipborn|Shipborn]]{{OdysseyIcon}} ||
*Adds needs: [[Needs#Indoors|Indoors]]
*Removes needs: [[Needs#Outdoors|Outdoors]]

|- id="Temperature"
! Temperature [[File:Precept temperature.png|64px]]
| Tough || Extreme temperatures don't bother us as much. || [[#Tree connection|Tree connection]] [[#Pain is virtue|Pain is virtue]] [[#Shipborn|Shipborn]]{{OdysseyIcon}} || Nullifies:
*{{Thought|desc=I had to sleep in the cold. We really need some heaters.|label=slept in the cold|value=-4|stack=1|duration=1}}
*{{Thought|desc=I had to sleep in unbearable heat. Can't we have air conditioning?|label=slept in the heat|value=-4|stack=1|duration=1}}
'''Note''': It doesn't appear to affect comfortable temperatures or the related [[hypothermia]]/[[heatstroke]] tolerances. It is only referenced for the above moodlets

|- id="Work drive"
! Work drive [[File:Precept work drive.png|64px]]
| Tripled ||The duration of the leader's work drive ability is tripled. || [[#Collectivist|Collectivist]] || 3x Work Drive Duration (from 3 days to 9 days)

|- id="Space habitat"
! Space Habitat{{OdysseyIcon}} [[File:Precept space habitat.png|64px]]
| Preferred || Planetary living is for lower animals. We should live in orbit or among the stars. || [[#Shipborn|Shipborn]] || '''Mood''':
*{{Thought|desc=I'll never feel at home here in the dirt. We should be in space.|label=Planetary habitat|value=-2|stack=1}}
*{{Thought|desc=It feels good to be where I belong. I can't stand being down there in the dirt.|label=Space habitat|value=4|stack=1}}
|}

== Roles ==
{{Main|Roles}}
Roles are positions available to pawns that grant them both special benefits and drawbacks. Every ideoligion has at least two roles: [[Leader]] and [[Moral guide]]. There can be only 1 '''leader''' globally, and 1 '''moral guide''' per ideoligion.

<div style="display:inline-table; padding: 0.5em;">
{| {{STDT| sortable text-valign:top}}
!Name !! colspan=5 | Abilities
|- id="Leader"
! [[Leader]] [[File: Leader.png|link=Leader]]
| style="text-align:center" | [[Combat command]] [[File:CombatCommand.png|link=Combat command|64px]]
| style="text-align:center" | [[Work drive]] [[File:WorkDrive.png|link=Work drive|64px]]
| style="text-align:center" | [[Leader speech]] [[File:LeaderSpeech.png|link=Leader speech|64px]]
| style="text-align:center" | [[Trial]] [[File:Trial.png|link=Trial|64px]]
|-
|- id="Moral guide"
! [[Moral guide]] [[File: MoralGuide.png|link=Moral guide]]
| style="text-align:center" | [[Roles#Convert|Convert]] [[File:Convert.png|link=Roles#Convert|64px]]
| style="text-align:center" | [[Counsel]] [[File:Counsel.png|link=Counsel|64px]]
| style="text-align:center" | [[Reassure]] [[File:Reassure.png|link=Reassure|64px]]
| style="text-align:center" | [[Conversion ritual]] [[File:ConversionRitual.png|link=Conversion ritual|64px]]
| style="text-align:center" | [[Preach health]] [[File:PreachHealth.png|link=Preach health|64px]]
|}
</div>

Additionally, each ideoligion grants up to 2 types of [[specialist]]s; a role that grants large bonuses and abilities related to a specific field in exchange of inability of doing one or more types of work. This limitation only applies to the type of specialization, not the total number of specialists.

<div style="display:inline-table; padding: 0.5em;">
{| {{STDT| sortable text-valign:top}}
!Name !! Required Memes !! Disabled Work Types !! Abilities
|- id="Shooting specialist"
! [[Shooting specialist]] [[File: SpecialistShooting.png|link=Shooting specialist]]
|
* [[Ideoligion#Raider|Raider]]
* [[Ideoligion#Supremacist|Supremacist]]
|
* Crafting
* Cooking
* Plantwork
* Mining
* Constructing
| style="text-align:center" |[[Marksman command]] [[File:MarksmanCommand.png|link=Marksman command|64px]]
|- id="Animals specialist"
! [[Animals specialist]] [[File: SpecialistAnimals.png|link=Animals specialist]]
|
* [[Ideoligion#Animal personhood|Animal personhood]]
* [[Ideoligion#Rancher|Rancher]]
|
* Crafting
* Cooking
* Plantwork
* Mining
* Constructing
| style="text-align:center" |[[Animal calm]] [[File:AnimalCalm.png|link=Animal calm|64px]]
|- id="Medical specialist"
! Medical Specialist [[File: SpecialistMedical.png|link=Medical specialist]]
|
* [[Ideoligion#Flesh purity|Flesh purity]]
* [[Ideoligion#Blindsight|Blindsight]]
|
* Violent
| style="text-align:center" |[[Immunity drive]] [[File:ImmunityDrive.png|link=Immunity drive|64px]]
|- id="Melee specialist"
! Melee Specialist [[File: SpecialistMelee.png|link=Melee specialist]]
|
* [[Ideoligion#Raider|Raider]]
* [[Ideoligion#Supremacist|Supremacist]]
|
* Crafting
* Cooking
* Plantwork
* Mining
* Constructing
* Hunting
* Shooting
| style="text-align:center" |[[Berserk trance]] [[File:BerserkTrance.png|link=Berserk trance|64px]]
|}
</div>

<div style="display:inline-table; padding: 0.5em;">
{| {{STDT| sortable text-valign:top}}
!Name !! Required Memes !! Disabled Work Types !! Abilities
|- id="Mining specialist"
! [[Mining specialist]] [[File: SpecialistMining.png|link=Mining specialist]]
|
* [[Ideoligion#Darkness|Darkness]]
* [[Ideoligion#Tunneler|Tunneler]]
|
* Animals
* Crafting
* Cooking
* Plantwork
* Constructing
| style="text-align:center" |[[Mining command]] [[File:MiningCommand.png|link=Mining command|64px]]
|- id="Plants specialist"
! [[Plants specialist]] [[File: SpecialistPlants.png|link=Plants specialist]]
|
* [[Ideoligion#High life|High life]]
* [[Ideoligion#Nature primacy|Nature primacy]]
* [[Ideoligion#Tree connection|Tree connection]]
|
* Animals
* Crafting
* Cooking
* Constructing
* Mining
| style="text-align:center" |[[Farming command]] [[File:FarmingCommand.png|link=Farming command|64px]]
|- id="Production specialist"
! [[Production specialist]] [[File: SpecialistProduction.png|link=Production specialist]]
|
* [[Ideoligion#Human primacy|Human primacy]]
|
* Dumb labor
* Animals
* Cooking
* Plantwork
* Mining
| style="text-align:center" |[[Production command]] [[File:ProductionCommand.png|link=Production command|64px]]
|- id="Research specialist"
! [[Research specialist]] [[File: SpecialistResearch.png|link=Research specialist]]
|
* [[Ideoligion#Transhumanist|Transhumanist]]
|
* Dumb labor
* Animals
* Cooking
* Plantwork
* Mining
| style="text-align:center" |[[Research command]] [[File:ResearchCommand.png|link=Research command|64px]]
|}
</div>

== Rituals ==
{{Main|Rituals}}

{{Ritual table}}

== Relics ==
{{Main|Relic}}
Relics are objects revered by your ideoligion that require a series of quests in order to be obtained. These are always of legendary quality, when applicable. Relics grant various boni, both when found and when present in rituals, some of which require being placed in a [[Reliquary]]. A relic being lost causes a malus of {{Thought|desc=The relic has been lost! A travesty!|label=relic lost|value=-5|stack=5|duration=30}} while a relic being destroyed causes a malus of {{Thought|desc=The relic was destroyed! A travesty!|label=relic destroyed|value=-5|stack=5|duration=30}}.

When placed in a Reliquary, pilgrims of your ideoligion will visit your colony to pay reverence to the relic.

== Buildings ==
Ideoligions can add special buildings that are required for either rituals or as statues of that ideologion.

=== Ritual seat ===
Ideologions can have a maximum of 1 type of ritual seat.
{| class="wikitable"
|-
! [[File:Kneel_pillow.png|32px]]
| [[Kneel_pillow|Kneel pillow]]
|-
! [[File:Kneel_sheet.png|32px]]
| [[Kneel_sheet|Kneel sheet]]
|-
! [[File:Pew.png|32px]]
| [[Pew]]
|}

=== Building ===
Ideologions can have a maximum of 5 types of ideologion-related buildings.

{| class="wikitable"
|-
! Image !! Name !! Type !! Minimum expectations !! Room requirements !! Note
|-
! [[File:Ideogram_morbid_b.png|32px]]
| [[Ideogram]] || Altar / Ideogram || Moderate || All floored No beds allowed No work facilities allowed ||! rowspan="5" | You can only have one Altar / Ideogram at the same time.
|-
! [[File:Small_altar.png|32px]]
| [[Small_altar|Small altar]] || Altar / Ideogram || Moderate || Room impressiveness 60 All floored No beds allowed No work facilities allowed
|-
! [[File:Medium_altar.png|32px]]
| [[Medium_altar|Medium altar]] || Altar / Ideogram || Moderate || Room impressiveness 60 No beds allowed No work facilities allowed
|-
! [[File:Large_altar.png|32px]]
| [[Large_altar|Large altar]] || Altar / Ideogram || Moderate || Room area: 25 tiles No beds allowed No work facilities allowed
|-
! [[File:Grand_altar.png|32px]]
| [[Grand_altar|Grand altar]] || Altar / Ideogram || Moderate || All floored Room area: 25 tiles No beds allowed No work facilities allowed
|-
! [[File:Christmas_tree.png|32px]]
| [[Christmas_tree|Christmas tree]] || Christmas tree || N/A || N/A || N/A
|-
! [[File:Sacrificial_flag.png|32px]]
| [[Sacrificial_flag|Sacrificial flag]] || Sacrificial flag || Moderate || All floored No beds allowed No work facilities allowed || N/A
|-
| colspan="6" | Ideologions can add statue-like buildings that are required when there are 3 or more pawns of the ideoligion in your faction and their expectations reach moderate or higher. These buildings can be placed in the same room. Placing the buildings in a room which doesn't meet the requirements will give a "[building name] disrespected" negative moodlet to all pawns of the ideologion.
|-
! [[File:Sculpture_small_totemic_a.png|32px]]
| [[Small_sculpture|Small sculpture]] || Statue || High || Room impressiveness 60 Column x4 No beds allowed No work facilities allowed || Small sculpture as a named ideologion building is a variation of the regular small sculpture. Its [[Small_sculpture#Styles|appearance]] depends on the Origin or the Style that the ideologion has.
|-
! [[File:Sculpture_large_totemic_a.png|32px]]
| [[Large_sculpture|Large sculpture]] || Statue || High || All floored No beds allowed No work facilities allowed || Large sculpture as a named ideologion building is a variation of the regular large sculpture. Its [[Large_sculpture#Styles|appearance]] depends on the Origin or the Style that the ideologion has.
|-
! [[File:Sculpture_grand_totemic_a.png|32px]]
| [[Grand_sculpture|Grand sculpture]] || Statue || Moderate || Room area: 25 tiles All floored No beds allowed No work facilities allowed || Grand sculpture as a named ideologion building is a variation of the regular grand sculpture. Its [[Grand_sculpture#Styles|appearance]] depends on the Origin or the Style that the ideologion has.
|}

== Weapon preferences ==
Ideoligion can have one or several pairs of noble and despised weapons types. Weapon pairs can't be combined if they overlap.

Wielding a noble weapon grants +3 mood while wielding a despised one grants -5.

Killing any pawn{{Check Tag|Verify}} with a noble weapon grants +3 mood for 1 day{{Check Tag|Thought Template|Convert to thought template}} while using a despised one to attack anything - including objects - grants -5 for 2 days.{{Check Tag|Thought Template|Convert to thought template}}

{| class="wikitable"
! Pair !! First group !! Second group
|-
| Melee / Ranged || All melee weapons, including beer and wood || All ranged weapons, including grenades
|-
| Melee piercer / Melee blunt || [[Thrumbo horn]], [[Elephant tusk]], [[Breach axe]], [[Gladius]], [[Longsword]], [[Knife]], [[Ikwa]], [[Spear]], [[Persona monosword]], [[Monosword]], [[Plasmasword]], [[Persona plasmasword]] || [[Beer]], [[Wood]], [[Mace]], [[Club]], [[Persona zeushammer]], [[Axe]], [[Warhammer]], [[Zeushammer]], [[Eltex staff]]
|-
| Long shots / Short shots || [[Bolt-action rifle]], [[Sniper rifle]] || [[Machine pistol]], [[Pump shotgun]], [[Chain shotgun]], [[Heavy SMG]]
|-
| Ranged heavy / Ranged light || [[Incendiary launcher]], [[Smoke launcher]], [[EMP launcher]], [[Heavy SMG]], [[LMG]], [[Sniper rifle]], [[Minigun]], [[Triple rocket launcher]], [[Greatbow]], [[Charge lance]] || [[Revolver]], [[Autopistol]], [[Machine pistol]], [[Short bow]], [[Recurve bow]], [[Charge rifle]]
|-
| Neolithic / Ultratech || [[Wood]], [[Club]], [[Knife]], [[Ikwa]], [[Spear]], [[Short bow]], [[Pila]], [[Recurve bow]], [[Greatbow]] || [[Persona monosword]], [[Persona zeushammer]], [[Persona plasmasword]], [[Monosword]], [[Zeushammer]], [[Plasmasword]], [[Eltex staff]]
|}

== Apparel preferences ==
{{Stub|section=1|reason=Missing several details inc but not limited to how it spawns on pawns}}

=== Apparel type combinations ===
Some kinds of [[apparel]] can be set as desired apparel.
{| class="wikitable"
|-
! Apparel type !! Name
|-
| [[Apparel#Headgear|Headgear]] || [[Authority_cap|Authority cap]], [[Beret]], [[Bowler_hat|Bowler hat]], [[Broadwrap]], [[Ceremonial_hood|Ceremonial hood]], [[Cowboy_hat|Cowboy hat]], [[Face_mask|Face mask]], [[Flophat]], [[Headwrap]], [[Hood]], [[Ritual_mask|Ritual mask]], [[Shadecone]], [[Slicecap]], [[Tailcap]], [[Torture_crown|Torture crown]], [[Tribal_headdress|Tribal headdress]], [[Tuque]], [[Veil]], [[Visage_mask|Visage mask]], [[War_mask|War mask]]
|-
| [[Apparel#Eyes|Eyes]] || [[Blindfold]]
|-
| [[Apparel#Skin|Skin]] || [[Button-down_shirt|Button-down shirt]]
|-
| [[Apparel#Outer|Outer]] || [[Burka]], [[Robe]]
|}
The player can set any of these pieces to be desired for men, women, or both, and can choose between a relaxed and strong desire. Multiple kinds (a maximum of 8 {{Check Tag|Verify?|Verify what's the limit?}}) of apparel can be chosen. You can select both a relaxed and a strong desire for the same gender / apparel type combination, for example, a female relaxed headgear and a female strong headgear. Note that selecting the same apparel type and preference twice will result in a conflict, for example, if you select a female: strong cowboy hat and an everyone: strong hood. To maximize the number of available desired apparel:
{| class="wikitable"
|-
! Apparel type !! Gender / Preference combination
|-
| [[Apparel#Headgear|Headgear]] || Female: relaxed Female: strong Male: relaxed Male: strong
|-
| [[Apparel#Eyes|Eyes]] || [[Blindfold]]
|-
| [[Apparel#Skin|Skin]] || [[Button-down_shirt|Button-down shirt]]
|-
| [[Apparel#Outer|Outer]] || Everyone: relaxed Everyone: strong
|}

=== Mood effects ===

Wearing a desired apparel or a certain color has mood effect on the pawn.

==== Desired apparel ====

Pawns that are wearing all of their desired apparel will gain a small mood bonus of {{+|1}} for a relaxed desire, and {{+|2}} for a strong desire. There is no difference in the mood bonus for having multiple pieces of desired apparel in the ideology, the bonus is only for wearing all of their desired apparel. Unlike role-specific apparel, there is no mood penalty for not wearing desired apparel.

==== Color mood effect ====

Ideoligions have an ideoligion color. Pawns gain a gain a {{+|1}} mood buff if more than 60% of a colonist's apparel is their favorite color or the color of their ideoligion. If their favorite color and their ideoligion's color are the same, they will gain both mood buffs for a total of {{+|2}}. For a full list of valid apparel color options, see the [[Dye]] page.

The color of the ideoligion can be set at generation, while a pawn's favorite color is determined when the pawn is generated.{{Check Tag|Children?|Confirm when children gain a favorite color}} Apparel can be dyed at the [[styling station]] for one [[dye]] per piece of apparel. Note that unlike with preferred apparel, outside of the [[Man in Black]] event, pawns will not necessarily spawn wearing color that matches their ideoligion or preferred colors.

=== Spawning ===

Pawns that have an ideologion with desired apparel may spawn wearing it. The criteria for this are not fully understood, but pawnkinds that do not spawn with apparel that occupies the coverage and layer of the item preferred by the ideoligion appear to always spawn with the item. If the pawnkind does have conflicting apparel that may, or is required to, spawn, then a portion of those pawnkinds will spawn with the apparel. This can lead to knock-on effects, such as some Empire [[Empire#Cataphract|Cataphracts]] {{RoyaltyIcon}} spawning with hats in place of their [[cataphract helmet|helmets]] {{RoyaltyIcon}} making them weaker in combat. Note that this also applies to colonist spawns, including at game start. In any case, it is unknown if this is limited by the apparel value limits imposed on some pawnkinds.

== Xenotype preferences ==
{{Biotech|section=1}}
{{Stub|section=1|reason= Needs proper write up. Test if specific to Sanguophage or the implanter gene. Also [[Template: Thought]]}}
Believers consider this xenotype to hold a higher moral or spiritual status than others. They will be happy if their colony has only preferred xenotypes. However, having any preferred xenotypes means that all other xenotypes are considered disliked and believers will be unhappy living alongside them.

Up to three [[Xenotypes]] can be selected as preferred xenotypes, including baseliner and a custom xenotype. If at least one is selected then a positive mood will be generated if every colonist is a preferred type, but a negative scaling mood if even one colonist is not a preferred type.

Believers will not accept becoming a non-preferred xenotype via reimplant ability or [[xenogerm]]s. If [[Sanguophage]] is not a preferred type and at least one other preferred type is set, colonists will refuse Sanguophage xenogerm implantation and quests that award Sanguophage xenogerm will fail to give the reward.{{Check Tag|Fail?|Will not offer that as a reward? Will generate as a reward but not give it? Will not generate the quest? Will not generate the option that would be to receive the xenogerm? Will replace it with something else?}}

Opinion:
* Preferred xenotype: {{+|10}}
* Disliked xenotype: {{--|30}}

Mood:
* All preferred xenotype: {{+|2}}
* Some disliked xenotypes: {{--|2}}
* Many disliked xenotypes: {{--|3}}
* Tons of disliked xenotypes: {{--|4}}
* I am disliked xenotype<: {{--|6}}

== Venerated animals ==
{{Stub|section=1|reason=General stub. Also: Check body size requirements. Add Table of options with bodysize and hunger/body size}}
{{Quote|This animal is considered by believers to hold a special spiritual or moral status, which means it must be venerated and may never be harmed.|Description}}
An ideoligion can have up to 18 venerated [[animal]]s.

Colonists will not hunt or attack venerated animals with ranged weapons (but will attack them in melee), unless the animal is in manhunter mood. They will not slaughter tame venerated animals.

Colonists will butcher venerated animals without any issue, but will refuse to eat their [[meat]] or any meal made with it (including meals stacked together), even when starving. They can be manually ordered to eat such food, but will get -8 mood for 5 days. If a colonist that venerates an animal is unconscious, other colonists (of any ideoligion) will not feed them such food, and '''cannot''' be manually ordered to do so. Colonists take no issue using [[leather]], [[wool]], [[milk]], or [[eggs]] of the venerated animal.

Colonists will get -5 mood for 5 days if a tame venerated animal dies for any reason. Releasing tame animals is fine.

Colonists will get a positive thought for the amount of tame venerated animals in the colony, depending on their total body size divided by the total number of colonists: +2 for 1 or more, +3 for 2 or more, +4 for 4 or more, and +5 for 6 or more. In case of multiple venerated animals, all their body sizes are added together, producing a single thought. All colonists are counted for this, but only those of an appropriate ideoligion will get the thought.

Despite being tameable, [[Insectoids]] cannot be selected as a venerated animal.

Venerated animals are twice as easy to tame.

== Hair and tattoos ==
An ideoligion has associated hairstyles, beards, and tattoos. Specific hairstyles and tattoos may be allowed for men, women, or either. Some of those may be more or less common.

Newly spawned pawns of an ideoligion will always have matching appearance.

If pawn's hairstyle, beard, or tattoo do not match what their ideoligion allows (usually as a result of a conversion), they will try to use [[styling station]] on their free time to automatically change their looks, and will have a -??{{Check Tag|Value?}} mood penalty until they do so. They can also be sent to adjust their appearance manually.

== Version history ==
* [[Ideology DLC]] Release - Added.
* [[Version/1.3.3067|1.3.3067]] - Fixed gender supremacy memes having opposite agreeing traits e.g. Female Supremacy inexplicably being agreed with by Misogynist traited pawns.
** Fix: Essential roles can be removed.
* [[Version/1.3.3069|1.3.3069]] -
** Adjust trees-related thoughts. Negatives for killing trees are reduced. Positives for seeing trees are amplified.
** Chance of resentment on failed conversion attempt reduced from 36% to 20%. Chance of fight reduced from 4% to 2%.
** If a pawn has sight under 50%, he should gain a psychic sensitivity bonus of up to 50%.
* [[Version/1.3.3069b|1.3.3069b]] - Added a feature that lets you save and load ideoligions within the ideoligion customization screen.
* [[Version/1.3.3074|1.3.3074]] - Desired apparel now uses the same faction restrictions as role apparel does. Tribal-Only: War mask, Tribal Headdress. Non-tribal only: Slicecap, Beret. Removed visage mask restriction to non-tribal only. Integrate art for rough living issue and set it to medium importance. Ensure Tunneler meme always has the MiningYield_High precept.
** Fix 5234: Pawns can build turrets when prohibited by precepts.
* [[Version/1.3.3076|1.3.3076]] - Tree connection pawns have a 25% boost to [[Pruning Speed]]. Added temperature tough issue and precept.
** Fix: High life meme ideos generate with a warning about conflicting apparel.
* [[Version/1.3.3080|1.3.3080]] - Fixed Immunity Drive. Was previously targeting wrong stat and inoperative. Add a new ideoligion setup interface which allows playing like classic RimWorld, using presets, or fully customizing. Change harmful aging thought minimum age from 20 to 25. Added temperature precept icon.
* [[Version/1.3.3087|1.3.3087]] - Fix: Nutrient paste does not produce ate meat or ate non meat thoughts.
* [[Version/1.3.3101|1.3.3101]] - Fluid ideoligion system added. Reduce production specialist crafting speed buffs from +70% to +50%. Increase impact of 'lost role' thought from {{--|5}} to {{--|15}}. Pawns now recover from [[#Melee specialist|berserk trance]] on being downed.
** Fix: There are some duplicate ideoligion icons.
** Fix: Tree lovers don't care about harvesting / chopping down cocoa trees. Individualist meme description changed from ''A community's role is to serve each individual.'' changed to ''Each person is a free individual with the right to their own ideas and decisions. Nobody should be made to conform.'' Collectivist meme description changed from ''A person's role is to serve the community.'' changed to ''Each person is part of a greater whole. People should work to play their part and help the group.''
* [[Version/1.3.3117|1.3.3117]] -
** Fix: Sunlamp does not trigger blinding light for Darkness pawns.
** Improved viability of multi-ideo colonies. Pawns of pawns of any ideo can now spectate any ritual, even if it's not of their own ideo.
** Gaining, changing, or removing a role now requires a simple ritual.
** Added a precept related to Darkness meme that gives believers a positive thought during an eclipse.
* [[Version/1.3.3159|1.3.3159]] - Precept name length is now limited.
* [[Version/1.3.3200|1.3.3200]] - Pawns can now install pre-built furniture even if it is incompatible with their ideoligion.
** Fix: Special characters on named precepts can break UI.
* [[Version/1.3.3287|1.3.3287]] - A thin faint box is now drawn around ideoligion preset selectables, precept and meme boxes for aesthetic reasons. Reworked eclipse precept artwork. Remove the 'no recent animal slaughter' negative thought from the rancher meme, along with all associated code and content. This particular thought was too limiting for players and not worth having. Previously inflicted a {{--|3}} mood.
** Fix: Classic mode ideoligions don't start with some classic precepts.
** Fix: Ideoligion info available on ritual begin dialog in classic mode. Meme "Flesh Purity" no longer forces the anti-biosculpting precept.
* [[Version/1.3.3326|1.3.3326]] - Display incompatible issue and precept names instead of just precept names in reformation confirmation dialog.
** Fix: Reforming a fluid ideo lists some precepts as "incompatible" when they actually aren’t.
** Fix: Ability gizmos are still available for roles that have been removed via reformation.
* [[Version/1.3.3387|1.3.3387]] - Fix: Not all precepts are added to memes during fluid ideoligion development. "No slaves in colony" thought does not apply at "Very low" expectations or below.
* [[Version/1.4.3523|1.4.3523]] -
**Fix: Berserker trance makes pawn guilty even though they cannot attack allies.
** Fix: High Life harvest yield for Drug Use: Essential precept doesn't work. Randomizing precepts no longer brings up a confirmation dialog if the user has not edited precepts.
* [[Version/1.4.3555|1.4.3555]] - [[Biotech DLC]] cross integration. Added mechanoid labor, child labor, growth vats, and bloodfeeders precepts. Added bloodfeeding meme. Added a new category of precept: Preferred xenotypes.
** Fix: Pilgrims coming to venerate a relic cause charity believers to get unhappy regardless of outcome. Yttakin factions no longer get desired apparel precepts, because they’re uncomfortable in all clothes.
* [[Version/1.4.3557|1.4.3557]] - Assign a fallback ideo{{Check Tag|Detail Needed}} to non-baby colonists during load that don't have an ideo set.
** Fix: "Child not in growth vat" thought appears for dead children.
** Fix: Banishing colonists doesn't recalculate faction ideoligions.
* [[Version/1.4.3563|1.4.3563]] - Fix: Animals specialist role mentions boosting animal-related abilities of nearby allies, which is false. "''A special ideoligious status focusing on animals to the exclusion of all else. This specialized role gives increased taming and training efficiency, and the ability to boost the animals-related abilities of nearby allies. Holders of this role will refuse to perform some non-animals-related tasks.''" -> ''"A special ideoligious status focusing on animals to the exclusion of all else. This specialized role gives increased taming and training efficiency. Holders of this role will refuse to perform some non-animals-related tasks."''
* [[Version/1.4.3613|1.4.3613]] - Fix: Randomize symbols doesn't update member noun in ideology's description.
** Fix: Pawn auto-uses age reversal after changing from Transhumanist to Non-Transhumanist ideoligion.
* [[Version/1.6.4543|1.6.4543]] - Allowed the trader's guild faction to generate more variety in their ideoligion.

<gallery>
Precept Eclipse OLD.png|Eclipse Precept icon prior to 1.3.3287
</gallery>

[[Category:Game mechanics]]

Modding Tutorials/Biomes

2026-01-27T19:47:41Z

Halicade: Fishing correction

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as different places that a biome is taken into consideration.

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a <code>workerClass</code> defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can appear on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can appear on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[Caravan#Foraging|foraged]] per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage[[Odyssey]] {{OdysseyIcon}}.
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
If this is false and the tile you are in is not a mixed biome, total plant population is based on the whole map rather than a 20 cell radius. Defauilts to true.
|-
| <source lang="xml">
<wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
Cave plants will count towards the total amount of plants on the tile. Defaults to false.
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
<MCP_MyCustomPlant MayRequire="username.CustomPlantMod">0.3</MCP_MyCustomPlant>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on an plants properties. Duplicates are not allowed between the two. Plants that appear due to pollution appear in this list as well.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
<MCA_MyCustomAnimal MayRequire="username.CustomAnimalMod">0.3</MCP_MyCustomanimal>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on an animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused field that is located on Ocean and Lake biomes.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world maps tile. Defaults to true. Note that this tile can still be polluted while on the map tile or by sending a drop-pod of wastepacks to the area.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animals will not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
If false, When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen. If a category is not present, no fish from that category will appear. Despite there being a <code>1</code> to indicate chance, this field is not utilized.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via the BiomeDefs <code>generatesNaturally</code>, and the BiomeWorkers <code>CanPlaceOnLayer</code>, it's score is calculated from the individual biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

=== Biome Generation ===

There is no right or wrong way to create the score for biomes. If you look at biome workers, many of them will use different formula or logic to appear on the map. Here is an example used from the mod [https://github.com/Halicade/GuldenBiome/blob/master/Source/BiomeWorker.cs| Gulden Biome (Continued)].

<source lang="cs">
// We are subclassing the temperate forest biome worker
public class BiomeWorker_GuldenForest : BiomeWorker_TemperateForest
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to completely overwrite the parent biome.
// That's why we only want tiles with an elevation between 500 and 800.
if (tile.elevation is <= 500 or >= 800) {
return 0;
}

// Get what the score is of the parent biome, temperate forest
float score = base.GetScore(biome, tile, planetTile);
// If that score is 0 or less we don't want this biome there.
if (score <= 0) {
return 0;
}

// We add 1.5 so that it is higher than the temperate forest.
// We don't want this number too large, otherwise it will overwrite other biomes.
return score + 1.5f;
}
}
</source>

== About Terrain modifiers ==

There are many terrain modifiers like <code>lakeBeachTerrain</code> and <code>gravelTerrain</code>. These are used by MapGenUtility to get the appropriate terrain at a specific cell. These can change depending on if you have a [[Landmarks#Mixed_biome|mixed biome]]{{OdysseyIcon}} or a <code>tileMutatorDef</code> that overrides a terrain such as <code>overrideLakeBeachTerrain</code>. Note that not every terrain modifier has an equivalent override. Some specific terrain may be hardcoded.

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>. Additionally, you are not able to set their pollution appearance rate or coastal appearance rate through their properties field either.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.
Some incidents have <code>sallowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact on gameplay.

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

[[Category:Modding tutorials]]

Modding Tutorials/Biomes

2026-01-25T17:01:01Z

Halicade: corrections, better wording

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as different places that a biome is taken into consideration.

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a <code>workerClass</code> defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can appear on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can appear on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[Caravan#Foraging|foraged]] per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage[[Odyssey]] {{OdysseyIcon}}.
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
If this is false and the tile you are in is not a mixed biome, total plant population is based on the whole map rather than a 20 cell radius. Defauilts to true.
|-
| <source lang="xml">
<wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
Cave plants will count towards the total amount of plants on the tile. Defaults to false.
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
<MCP_MyCustomPlant MayRequire="username.CustomPlantMod">0.3</MCP_MyCustomPlant>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on an plants properties. Duplicates are not allowed between the two. Plants that appear due to pollution appear in this list as well.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
<MCA_MyCustomAnimal MayRequire="username.CustomAnimalMod">0.3</MCP_MyCustomanimal>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on an animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused field that is located on Ocean and Lake biomes.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world maps tile. Defaults to true. Note that this tile can still be polluted while on the map tile or by sending a drop-pod of wastepacks to the area.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animals will not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
If false, When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen. If a category is not present, no fish from that category will appear.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via the BiomeDefs <code>generatesNaturally</code>, and the BiomeWorkers <code>CanPlaceOnLayer</code>, it's score is calculated from the individual biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

=== Biome Generation ===

There is no right or wrong way to create the score for biomes. If you look at biome workers, many of them will use different formula or logic to appear on the map. Here is an example used from the mod [https://github.com/Halicade/GuldenBiome/blob/master/Source/BiomeWorker.cs| Gulden Biome (Continued)].

<source lang="cs">
// We are subclassing the temperate forest biome worker
public class BiomeWorker_GuldenForest : BiomeWorker_TemperateForest
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to completely overwrite the parent biome.
// That's why we only want tiles with an elevation between 500 and 800.
if (tile.elevation is <= 500 or >= 800) {
return 0;
}

// Get what the score is of the parent biome, temperate forest
float score = base.GetScore(biome, tile, planetTile);
// If that score is 0 or less we don't want this biome there.
if (score <= 0) {
return 0;
}

// We add 1.5 so that it is higher than the temperate forest.
// We don't want this number too large, otherwise it will overwrite other biomes.
return score + 1.5f;
}
}
</source>

== About Terrain modifiers ==

There are many terrain modifiers like <code>lakeBeachTerrain</code> and <code>gravelTerrain</code>. These are used by MapGenUtility to get the appropriate terrain at a specific cell. These can change depending on if you have a [[Landmarks#Mixed_biome|mixed biome]]{{OdysseyIcon}} or a <code>tileMutatorDef</code> that overrides a terrain such as <code>overrideLakeBeachTerrain</code>. Note that not every terrain modifier has an equivalent override. Some specific terrain may be hardcoded.

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>. Additionally, you are not able to set their pollution appearance rate or coastal appearance rate through their properties field either.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.
Some incidents have <code>sallowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact on gameplay.

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

[[Category:Modding tutorials]]

Modding Tutorials/Biomes

2026-01-12T02:59:17Z

Halicade: A couple additions. Filled in some todos.

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as different places that a biome is taken into consideration.

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a <code>workerClass</code> defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can appear on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can appear on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[Caravan#Foraging|foraged]] per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage[[Odyssey]] {{OdysseyIcon}}.
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
If this is false and the tile you are in is not a mixed biome, total plant population is based on the whole map rather than a 20 cell radius. Defauilts to true.
|-
| <source lang="xml">
<wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
Cave plants will count towards the total amount of plants on the tile. Defaults to false.
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on a wild plants properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on a wild animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused field that is located on Ocean and Lake biomes.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world maps tile. Defaults to true. Note that this tile can still be polluted while on the map tile or by sending a drop-pod of wastepacks to the area.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animals will not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
If false, When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via the BiomeDefs <code>generatesNaturally</code>, and the BiomeWorkers <code>CanPlaceOnLayer</code>, it's score is calculated from the individual biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

=== Biome Generation ===

There is no right or wrong way to create the score for biomes. If you look at biome workers, many of them will use different formula or logic to appear on the map. Here is an example used from the mod [https://github.com/Halicade/GuldenBiome/blob/master/Source/BiomeWorker.cs| Gulden Biome (Continued)].

<source lang="cs">
// We are subclassing the temperate forest biome worker
public class BiomeWorker_GuldenForest : BiomeWorker_TemperateForest
{
public override float GetScore(BiomeDef biome, Tile tile, PlanetTile planetTile) {
// We don't want to completely overwrite the parent biome.
// That's why we only want tiles with an elevation between 500 and 800.
if (tile.elevation is <= 500 or >= 800) {
return 0;
}

// Get what the score is of the parent biome, temperate forest
float score = base.GetScore(biome, tile, planetTile);
// If that score is 0 or less we don't want this biome there.
if (score <= 0) {
return 0;
}

// We add 1.5 so that it is higher than the temperate forest.
// We don't want this number too large, otherwise it will overwrite other biomes.
return score + 1.5f;
}
}
</source>

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. You are not able to set Their pollution appearance rate or coastal appearance rate through their properties either. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.
Some incidents have <code>sallowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact on gameplay.

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s, as well as [[Landmarks| landmarks]] in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

[[Category:Modding tutorials]]

Modding Tutorials/Biomes

2026-01-11T00:50:56Z

Halicade: Initial upload

{{DISPLAYTITLE:Biomes}}

{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This is a basic overview of biomes and their creation. As well as

== <code>BiomeDef</code> ==

Biomes are defined in XML using <code>BiomeDef</code> [[Modding_Tutorials/Defs|Defs]]. As with all Defs, looking at the vanilla examples is a great way to get a feel for how the system is used.
In order to generate a biome on the world map, biomes also require a workerClass defined in code. See [[Modding_Tutorials/Setting_up_a_solution|Setting up a solution]] to get started.

=== Fields ===

The following are valid fields in <code>BiomeDef</code>. Not all fields are necessary, look at vanilla BiomeDefs for examples.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML Example !! Description
|-
| <source lang="xml">
<workerClass>MyCustomBiome.BiomeWorker_CustomForest</workerClass>
</source>
| class="TutorialCodeTable-description" |
A reference to code that defines where your biome will spawn on the world map. In Rimworld, these start with <code>BiomeWorker</code>
|-
| <source lang="xml">
<implemented>true</true>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Defaults to true. Likely this is used for debugging/development purposes
|-
| <source lang="xml">
<generatesNaturally>true</generatesNaturally>
</source>
| class="TutorialCodeTable-description" |
Determines if the biome gets generated from <code>WorldGenStep_Terrain</code>. Requires <code>implemented</code> to be true. Defaults to true.
|-
| <source lang="xml">
<canBuildBase>true</canBuildBase>
</source>
| class="TutorialCodeTable-description" |
Determines if a player or npc faction can be generated here. Defaults to true.
|-
| <source lang="xml">
<settlementSelectionWeight>0.75</settlementSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
How likely a settlement can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<allowRoads>true</allowRoads>
</source>
| class="TutorialCodeTable-description" |
Whether roads can spawn on this biome. Note that unless both this and <code>allowRivers</code> are false, roads will still display visually. Defaults to true.
|-
| <source lang="xml">
<allowRivers>true</allowRivers>
</source>
| class="TutorialCodeTable-description" |
Whether rivers can spawn on this biome. Note that unless both this and <code>allowRoads</code> are false, rivers will still display visually. Defaults to true.
|-
| <source lang="xml">
<animalDensity>3.5</animalDensity>
</source>
| class="TutorialCodeTable-description" |
How much animals will spawn on your biome. Higher numbers lead to an increase in animals.
|-
| <source lang="xml">
<plantDensity>0.7</plantDensity>
</source>
| class="TutorialCodeTable-description" |
How many plants will spawn on your biome. Higher numbers lead to an increase in plants.
|-
| <source lang="xml">
<allowFarmingCamps>true</allowFarmingCamps>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) Allow farming camps to spawn. Defaults to true.
|-
| <source lang="xml">
<campSelectionWeight>0.65<campSelectionWeight>
</source>
| class="TutorialCodeTable-description" |
([[Ideology]] {{IdeologyIcon}} Only) How likely a camp can spawn on the selected tile. This is a value from 0-1. Defaults to 1
|-
| <source lang="xml">
<pollutionOffset>0.2<pollutionOffset>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) This will be the biomes initial pollution. This can be increased during the world creation screen.
|-
| <source lang="xml">
<impassable>false</impassable>
</source>
| class="TutorialCodeTable-description" |
Whether the biome can be passed via caravan.
|-
| <source lang="xml">
<hasVirtualPlants>true</hasVirtualPlants>
</source>
| class="TutorialCodeTable-description" |
Determines if animals are allowed to graze on this tile while caravanning. Defauilts to true.
|-
| <source lang="xml">
<forageability>0.75<forageability>
</source>
| class="TutorialCodeTable-description" |
A multiplier of nutrition [[Caravan#Foraging|foraged]] per day. Requires a <code>foragedFood</code> defined. This is also used for animals that can forage[[Odyssey]] {{OdysseyIcon}}.
|-
| <source lang="xml">
<foragedFood>RawBerries</foragedFood>
</source>
| class="TutorialCodeTable-description" |
Food that will be retrieved.
|-
| <source lang="xml">
<wildPlantsCareAboutLocalFertility>false</wildPlantsCareAboutLocalFertility>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<wildPlantsAreCavePlants>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<wildPlantRegrowDays>13</wildPlantRegrowDays>
</source>
| class="TutorialCodeTable-description" |
A wild plant has a chance to regrow after a set number of days. Defaults to 25.
|-
| <source lang="xml">
<movementDifficulty>1.25</movementDifficulty>
</source>
| class="TutorialCodeTable-description" |
The base movement difficulty for a caravan to travel across the tile.
|-
| <source lang="xml">
<baseWeatherCommonalities>
<Clear>18</Clear>
<Fog>1</Fog>
<Rain>2</Rain>
<DryThunderstorm>1</DryThunderstorm>
<RainyThunderstorm>1</RainyThunderstorm>
<FoggyRain>1</FoggyRain>
<SnowGentle>4</SnowGentle>
<SnowHard>4</SnowHard>
<GrayPall MayRequire="Ludeon.RimWorld.Anomaly">1</GrayPall>
<Overcast MayRequire="Ludeon.RimWorld.Odyssey">2</Overcast>
</baseWeatherCommonalities>
</source>
| class="TutorialCodeTable-description" |
What weather events can occur and how often they can occur. Note that multiple other variables are taken into effect with weather
|-
| <source lang="xml">
<terrainsByFertility>
<li>
<terrain>Soil</terrain>
<min>-999</min>
<max>0.87</max>
</li>
<li>
<terrain>SoilRich</terrain>
<min>0.87</min>
<max>999</max>
</li>
</terrainsByFertility>
</source>
| class="TutorialCodeTable-description" |
The terrain that will appear based on fertility values generated by the genSteps <code>ElevationFertility</code> and <code>MutatorPostElevationFertility</code>. Will default to regular soil if a value is omitted.
|-
| <source lang="xml">
<terrainPatchMakers>
<li>
<perlinFrequency>0.04</perlinFrequency>
<thresholds>
<li>
<terrain>MarshyTerrain</terrain>
<min>0.7</min>
<max>999</max>
</li>
</thresholds>
</li>
</terrainPatchMakers>
</source>
| class="TutorialCodeTable-description" |
Terrain generated through perlin noise. This can be used for patches of highly fertile soil, marshes, ponds, or other variable land. For a visual representation, you can use the [[Development_mode|Dev mode]] command <code>Map noise visualizer</code>.
|-
| <source lang="xml">
<soundsAmbient>
<li>Ambient_NightInsects_Standard</li>
</soundsAmbient>
</source>
| class="TutorialCodeTable-description" |
Sounds that will play when zoomed in on the map.
|-
| <source lang="xml">
<wildPlants>
<Plant_TallGrass>3.2</Plant_TallGrass>
<Plant_Chokevine>0.8</Plant_Chokevine>
<Plant_Bush>0.2</Plant_Bush>
<Plant_Witchwood MayRequire="Ludeon.RimWorld.Biotech">1.0</Plant_Witchwood>
<Plant_Reeds MayRequire="Ludeon.RimWorld.Odyssey">1</Plant_Reeds>
<Plant_LilyPad MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_LilyPad>
<Plant_Bulrush MayRequire="Ludeon.RimWorld.Odyssey">0.2</Plant_Bulrush>
</wildPlants>
</source>
| class="TutorialCodeTable-description" |
What plants can spawn in the wild for this biome. Based on weight. These can also be included on a wild plants properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<wildAnimals>
<Donkey>0.34</Donkey>
<GuineaPig>0.48</GuineaPig>
<Yak>0.05</Yak>
<Bison>0.06</Bison>
<Crow MayRequire="Ludeon.RimWorld.Odyssey">0.6</Crow>
<Bluebird MayRequire="Ludeon.RimWorld.Odyssey">0.6</Bluebird>
<Quail MayRequire="Ludeon.RimWorld.Odyssey">0.6</Quail>
</wildAnimals>
</source>
| class="TutorialCodeTable-description" |
What animals can spawn in the biome based on weight. These can also be included on a wild animals race properties. Duplicates are not allowed between the two.
|-
| <source lang="xml">
<pollutionWildAnimals>
<Toxalope MayRequire="Ludeon.RimWorld.Biotech">0.3</Toxalope>
<WasteRat MayRequire="Ludeon.RimWorld.Biotech">0.4</WasteRat>
<Rat>1</Rat>
<Raccoon>0.5</Raccoon>
</pollutionWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Biotech]] {{BiotechIcon}} Only) Animals defined in this field will only spawn if there is pollution on the map. The chance of these animals spawning is based on a curve with a 10% chance at 25% pollution, 90% chance at 75% pollution and 100% at 100% pollution
|-
| <source lang="xml">
<coastalWildAnimals>
<SeaLion MayRequire="Ludeon.RimWorld.Odyssey">0.1</SeaLion>
<Seal MayRequire="Ludeon.RimWorld.Odyssey">0.1</Seal>
</coastalWildAnimals>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Animals defined here will spawn if the tile has the <code>Coast</code> <code>TileMutatorDef</code>. A coast requires a tile neighboring an ocean tile.
|-
| <source lang="xml">
<diseaseMtbDays>50</diseaseMtbDays>
</source>
| class="TutorialCodeTable-description" |
The mean time between a disease incident occurring. Possible diseases are chosen from <code>diseases</code>.
|-
| <source lang="xml">
<diseases>
<li>
<diseaseInc>Disease_Flu</diseaseInc>
<commonality>120</commonality>
</li>
<li>
<diseaseInc>Disease_Plague</diseaseInc>
<commonality>80</commonality>
</li>
</diseases>
</source>
| class="TutorialCodeTable-description" |
Possible diseases that can occur. One will be chosen at random by weight
|-
| <source lang="xml">
<allowedPackAnimals>
<li>Muffalo</li>
<li>Alpaca</li>
</allowedPackAnimals>
</source>
| class="TutorialCodeTable-description" |
Pack animals that can appear from caravan traders.
|-
| <source lang="xml">
<hasBedrock>true</hasBedrock>
</source>
| class="TutorialCodeTable-description" |
If a tile can be [[Deep_drill|deep drilled]] for materials. Defaults to true. Also prevents the [[Ground-penetrating_scanner|Ground-penetrating scanner]] from working on this tile.
|-
| <source lang="xml">
<isExtremeBiome>true</isExtremeBiome>
</source>
| class="TutorialCodeTable-description" |
Prevents spawning of Special trees. Defaults to false.
|-
| <source lang="xml">
<isWaterBiome>false</isWaterBiome>
</source>
| class="TutorialCodeTable-description" |
Unused.
|-
| <source lang="xml">
<allowPollution>true</allowPollution>
</source>
| class="TutorialCodeTable-description" |
Pollution can appear on the world map tile. Defaults to true.
|-
| <source lang="xml">
<wildAnimalsCanWanderInto>true</wildAnimalsCanWanderInto>
</source>
| class="TutorialCodeTable-description" |
If false, animalswill not appear when using the draw animals [[Anomaly]] Ritual. Defaults to true.
|-
| <source lang="xml">
<noAmbientWind>false</noAmbientWind>
</source>
| class="TutorialCodeTable-description" |
When the camera is zoomed out, you will hear wind effects.
|-
| <source lang="xml">
<inVacuum>false</inVacuum>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Tiles from this map will have no oxygen. [[Wind_turbine|Wind turbines]] will be unable to function.
|-
| <source lang="xml">
<disableSkyLighting>false</disableSkyLighting>
</source>
| class="TutorialCodeTable-description" |
Enables Sky Lighting. This is from weather events as well as day/night time.
|-
| <source lang="xml">
<disableShadows>false</disableShadows>
</source>
| class="TutorialCodeTable-description" |
Shadows from buildings and structures will not be displayed.
|-
| <source lang="xml">
<canExitMap>true</canExitMap>
</source>
| class="TutorialCodeTable-description" |
Determines if pawns are able to leave the map through caravan or other means. Defaults to True.
|-
| <source lang="xml">
<onlyAllowWhitelistedArrivalModes>false</onlyAllowWhitelistedArrivalModes>
</source>
| class="TutorialCodeTable-description" |
Only allow arrival modes for pawns as specified in their <code>PawnsArrivalModeDef</code>
|-
| <source lang="xml">
<isBackgroundBiome>false</isBackgroundBiome>
</source>
| class="TutorialCodeTable-description" |
Rotates coastal landmarks in the correct orientation when needed. Used for Ocean and Lake biomes.
|-
| <source lang="xml">
<wildAnimalScariaChance>0.3</wildAnimalScariaChance>
</source>
| class="TutorialCodeTable-description" |
The chance that a wild animal spawned will have scaria. Defaults to 0.
|-
| <source lang="xml">
<geyserCountFactor>0.75</geyserCountFactor>
</source>
| class="TutorialCodeTable-description" |
Multiplies the amount of Steam Geysers that can appear on the map. Defaults to 1
|-
| <source lang="xml">
<constantOutdoorTemperature>10</constantOutdoorTemperature>
</source>
| class="TutorialCodeTable-description" |
A set temperature for a map. Measured in Celsius.
|-
| <source lang="xml">
<coastalBeachTerrain>Mud</coastalBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating beach. Defaults to sand.
|-
| <source lang="xml">
<lakeBeachTerrain>Ice</lakeBeachTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating a lake or beach. Defaults to sand.
|-
| <source lang="xml">
<riverbankTerrain>Marsh</riverbankTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used for the sides of a river. Requires a <code>riverbankSizeRange</code> defined. Defaults to RiverBank.
|-
| <source lang="xml">
<riverbankSizeRange>
</source>
| class="TutorialCodeTable-description" |
Size of a riverbank that can appear alongside a river.
|-
| <source lang="xml">
<mudTerrain>MossyTerrain</mudTerrain>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Defines what terrain should be used when generating a Wetlands Tile mutator. Defaults to Mud.
|-
| <source lang="xml">
<noGravel>false</noGravel>
</source>
| class="TutorialCodeTable-description" |
If Gravel (Stony soil) should be generated.
|-
| <source lang="xml">
<gravelTerrain>Ice</gravelTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating gravel. Defaults to Stony Soil. Requires <code>noGravel</code> to be false.
|-
| <source lang="xml">
<waterShallowTerrain>SoilRich<waterShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating shallow water for <code>TileMutatorDef</code>s. Defaults to shallow water.
|-
| <source lang="xml">
<waterDeepTerrain>WaterOceanDeep</waterDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain to use when generating deep water for <code>TileMutatorDef</code>s. Defaults to deep water.
|-
| <source lang="xml">
<oceanShallowTerrain>MossyTerrain</oceanShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow ocean water for <code>TileMutatorDef</code>s. Defaults to shallow ocean Water
|-
| <source lang="xml">
<oceanDeepTerrain>Mud</oceanDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating Deep ocean water for <code>TileMutatorDef</code>s. Defaults to deep ocean water
|-
| <source lang="xml">
<waterMovingShallowTerrain>Mud</waterMovingShallowTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating shallow moving water for <code>TileMutatorDef</code>s. Defaults to shallow moving water
|-
| <source lang="xml">
<waterMovingChestDeepTerrain>Sand</waterMovingChestDeepTerrain>
</source>
| class="TutorialCodeTable-description" |
Defines what terrain should be used when generating deep moving water for <code>TileMutatorDef</code>s. Defaults to chest-deep moving water
|-
| <source lang="xml">
<biomeMapConditions>
<li>SolarFlare</li>
<biomeMapConditions>
</source>
| class="TutorialCodeTable-description" |
A list of permanent <code>GameConditionDef</code> that can occur on the map.
|-
| <source lang="xml">
<extraGenSteps>
<li>MNCS_CheeseChunks</li>
<li>MNCS_MoonHives</li>
<li>MNCS_FixPlayerStartSpot</li>
</extraGenSteps>
</source>
| class="TutorialCodeTable-description" |
Extra <code>GenStepDef</code> that can occur on this biomes maps.
|-
| <source lang="xml">
<preventGenSteps>
<li>RockChunks</li>
<li>CaveHives</li>
</preventGenSteps>
</source>
| class="TutorialCodeTable-description" |
These <code>GenStepDef</code> will not occur on this biomes maps.
|-
| <source lang="xml">
<extraRockTypes>
<li>SolidIce</li>
</extraRockTypes>
</source>
| class="TutorialCodeTable-description" |
Provided that the rock is defined as <code>biomeSpecific</code>, these rocks will be able to appear on the selected biome naturally
|-
| <source lang="xml">
<forceRockTypes>
<li>Sandstone</li>
</forceRockTypes>
</source>
| class="TutorialCodeTable-description" |
Only rocks defined in this field will appear. This is a 100% rate meaning no variation on the biome.
|-
| <source lang="xml">
<maxFishPopulation>500</maxFishPopulation>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) The maximum amount of fish a body of water is able to have. Defaults to 0.
|-
| <source lang="xml">
<fishTypes>
<freshwater_Common>
<Fish_Bass MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bass>
</freshwater_Common>
<freshwater_Uncommon>
<Fish_Catfish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Catfish>
</freshwater_Uncommon>
<saltwater_Common>
<Fish_Bluefish MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Bluefish>
</saltwater_Common>
<saltwater_Uncommon>
<Fish_Marlin MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Marlin>
<Fish_Flounder MayRequire="Ludeon.RimWorld.Odyssey">1</Fish_Flounder>
</saltwater_Uncommon>
<rareCatchesSetMaker
MayRequire="Ludeon.RimWorld.Odyssey">RareFishingCatches_Temperate</rareCatchesSetMaker>
</fishTypes>
</source>
| class="TutorialCodeTable-description" |
([[Odyssey]] {{OdysseyIcon}} Only) Fish that can appear in bodies of water. If multiple fish are in a list, one is randomly chosen.
|-
| <source lang="xml">
<layerWhitelist>
<li>MP_MyCustomPlanetLayer</li>
</layerWhitelist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is allowed to occur in. If this is set it will only appear on the specified layers
|-
| <source lang="xml">
<layerBlacklist>
<li>Surface</li>
</layerBlacklist>
</source>
| class="TutorialCodeTable-description" |
<code>PlanetLayerDef</code> this biome is not allowed to occur in. If this is set it will not appear in on the specified layers
|-
| <source lang="xml">
<settleWarning>This biome is very dangerous.</settleWarning>
</source>
| class="TutorialCodeTable-description" |
A warning that can appear when trying to settle on a tile of that biome.
|-
| <source lang="xml">
<fogOfWarColor>(249,145,104)</fogOfWarColor>
</source>
| class="TutorialCodeTable-description" |
The color of Fog of war. Fogged/undiscovered locations on your map. Default is null and this field is not necessary to fill in. Normal fog of war color is (77, 69, 66).
|-
| <source lang="xml">
<orbitalDebris>
</source>
| class="TutorialCodeTable-description" |
TODO
|-
| <source lang="xml">
<texture>World/Biomes/MNCS_SurfaceSwiss</texture>
</source>
| class="TutorialCodeTable-description" |
The texture that will be displayed on the world map. Vanilla uses a 512x512 texture.
|-
|}
</div>

== Determining Biome ==

Biome calculation is done during world generations <code>WorldGenStep_Terrain</code>. Each tile is calculated individually. After verifying the biome can be placed via <code>generatesNaturally</code>, it's score is calculated from the biome workers <code>GetScore</code>. The biome with the highest score will be placed on that specific tile.

== Places That Use Biomes ==

In addition to the fields required for biomes, some feilds require knowledge of the biome to trigger specific events or occurences. In these cases a [[Modding_Tutorials/PatchOperations|patch operation]] will be necessary

=== Animals and plants ===

Animals and plants can also set where they spawn in their raceProperties and plantProperties respectively. Duplicates are not allowed between the biome and properties list. You are not able to set Their pollution appearance rate or coastal appearance rate through their properties either. Either method is acceptable for appearance rates. However, if you are creating a biome, it might be more sensible to place the appearances in the <code>BiomeDef</code>.

=== <code>IncidentDef</code>s ===

<code>Ambush</code>, <code>ManhunterAmbush</code>, <code>CaravanMeeting</code>, and <code>CaravanDemand</code> requires a biome listed in their <code>mtbDaysByBiome</code> to be considered a valid map to have their incidents occur.
Some incidents have <code>sallowedBiomes</code> or <code>disallowedBiomes</code>. [[Events#Beavers!|Alphabeavers]] for example can only appear in the Tundra or Arid Shrubland.

=== <code>FeatureDef</code>s ===

<code>FeatureDef</code>s generate names that can appear alongside landforms on the world map. These are things like "Barra Sea", "Bat Cheek Flats", and "Gorar Desert". Some <code>FeatureDef</code>s have <code>rootBiome</code> and <code>acceptableBiome</code>. For example, the <code>Desert</code> FeatureDef has <code>Desert</code> and <code>ExtremeDesert</code> as <code>rootBiomes</code> meaning at least one of these are required for an area to be given this name. <code>acceptableBiomes</code> are adjacent biomes that can also fulfill the qualifications for the Desert Feature. This is purely for visual and does not have impact

=== <code>TileMutatorDef</code>s ===
Most <code>TileMutatorDef</code>s, as well as [[Landmarks| landmarks]] in Odyssey will not be active on a biome unless they are patched into the TileMutatorDefs <code>biomeWhitelist</code>. You can also restrict certain biomes using the <code>biomeBlacklist</code>. [[Modding_Tutorials/Mod_Folder_Structure#LoadFolders.xml_.28Optional.29|LoadFolders]] is recommended here.

Modding Tutorials/Testing mods

2025-12-07T13:18:32Z

Halicade: Updated publisher plus link

{{DISPLAYTITLE:Testing Mods}}
{{BackToTutorials}}

{{:Modding_Tutorials/Under_Review}}

This page contains tips and tricks for debugging and testing mod content.

=Development Mode=

''Main Article: [[Development mode]]

Usually referred to as just "dev mode", enabling this option gives you a large number of tools to help test both the vanilla game as well as mod content.

To enable dev mode:

# Start RimWorld
# Go to Options in the Main Menu
# Under Gameplay, check the "Development Mode" box

Development mode will remain on until explicitly turned off, even if you close and reopen the game.

=Debugging=

RimWorld runs on Unity, which uses a modified fork of the Mono runtime. As of RimWorld 1.6 (Odyssey), the current versions are:

* Unity 2022.3.35 (https://unity.com/releases/editor/whats-new/2022.3.35f1)
* Mono (https://github.com/Unity-Technologies/mono/tree/unity-2022.3-mbe)

If you are using [[Modding_Tutorials/Recommended_software|Rider]], the easiest way to set up debugging for custom assemblies is to use Gareth's RimWorld plugin: https://plugins.jetbrains.com/plugin/21583-rimworld-development-environment

If you are not using Rider or do not want to use the plugin, there are instructions for setting up Doorstop manually here: https://github.com/pardeike/Rimworld-Doorstop

=Tips=

The following are specific tips for testing various types of mod content:

==Weapons and Apparel==

You can spawn weapons and apparel by using the "Spawn weapon" and "Spawn apparel" dev mode debug commands, respectively.

There are also debug output commands for showing the chance of spawning any given weapon or apparel piece, to help diagnose whether your tags are correctly configured.

==Pawns==

You can test custom pawns by using the "Spawn pawn" dev mode command. This will list out all PawnKindDefs in the game.

==Incidents==

You can use the Incident dev mode commands to test various incidents, including raids.

==Jobs==

"Toggle job logging" and "Draw pawn debug" can be helpful for diagnosing pawn AI.

==Lords==

Lords are group AI controllers used by everything from trade caravans to raiding parties.

* View settings -> Draw Duties (for seeing what each pawn does)
* View settings -> Draw Lords (for seeing what the Lord does)
* View settings -> Log Lord Toil Transitions (for reading what transitions happen)

=Quicktest=

When dev mode is enabled, there will be a Quicktest option on the Main Menu that instantly loads into a Crashlanded map with all default options.

You can also have the game load instantly into a Quicktest map on load by using the <code>-quicktest</code> command line argument:

<source>
C:/Path/To/Game/RimWorld.exe -quicktest
</source>

On Mac:

<source>
/Users/Username/Library/Application\ Support/Steam/SteamApps/common/RimWorld/RimWorldMac.app/Contents/MacOS/RimWorldMac -quicktest
</source>

You can make a shortcut to the game with this command line argument.

Alternatively, if you have a save file named <code>autostart.rws</code>, then game will load that on start.

=Save Data=

You can override the save data folder using the <code>-savedatafolder</code> command line argument. This is useful if you want to install the game on a USB drive so you can plug and play it from anywhere:

<source>
C:/Path/To/Game/RimWorld.exe -savedatafolder=C:/Path/To/The/Folder
</source>

You can also use relative file paths:

<source>
-savedatafolder=SaveData
</source>

Be sure the game is running with permission to modify the folder; it may not work properly if you run the game under default permissions on its own install folder.

You can combine the -savedatafolder with the -quicktest argument for a clean modding environment.

=Mod Tools=

* [https://github.com/NightmareCorporation/PublisherPlusMultiVersionFork PublisherPlus] ([https://steamcommunity.com/sharedfiles/filedetails/?id=3183156228 Steam Workshop]) Originally created by Jaxe, forked by NightmareCorporation - gives you more options when uploading a mod to Steam Workshop, including excluding files or folders from the upload.

[[Category:Modding tutorials]]

Modding Tutorials/Plague Gun

2025-08-12T01:15:36Z

Halicade: /* Required Items */ Removing outdated/older recommendations

This is a tutorial for taking an item [[mod]] from conception all the way to completion, touching on most systems involved in RimWorld modding and explaining each step.

== Introduction ==

In this tutorial we will be using most of the tools available to a Rimworld [[Modding|modder]] to create a custom weapon, known as the Plague Gun.

This weapon will, when its shots hit a living target, have a chance to apply the [[Plague]] hediff ("health difference") to that target.

To do this, we will create XML ThingDefs for the gun and projectile, create a C# assembly which determines what happens when the projectile hits a target, and link that behavior back to the XML.

This tutorial will assume a basic familiarity with XML and C# syntax. It should be simple enough to follow if you're only a beginner.

If you have no XML or C# experience, there are good tutorials for XML [https://www.w3schools.com/xml/ here] and C# [https://www.learncs.org/ here].

=== The Completed Mod ===
For a working example, check out [https://github.com/dninemfive/PlagueGun this GitHub repo].

== Required Items ==

Make sure to have the following installed, at least one per row:

{| class="wikitable"
|-
| [https://code.visualstudio.com/ VSCode] || A text editor that allows you to edit XML files and use "Find in Files" for referencing.
|-
| [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community] || Use this or any other C# compiler to turn scripts into .dll files that RimWorld can use.
|-
| [https://github.com/icsharpcode/ILSpy/releases ILSpy]|| This is for referencing the game's decompiled C# scripts.
|}

For more detailed recommendations, see [[Modding Tutorials/Recommended software|here]].

== XML Stage ==

In this stage we will set up the mod and create XML files which add our things to the database.

# Locate your RimWorld folder.
#* On Steam, you can find it by right-clicking the game in your games list > Properties > Local Files > Browse Local Files...
#** By default, it will be located at <code>C:\Program Files (x86)\Steam\steamapps\common\RimWorld</code> if you bought it through Steam on Windows.
#* If you bought the DRM-free version, it will be located wherever you unzipped it.
#* On GOG, you can find it by right-clicking the game in your games list > Manage Installation > Show Folder
#** By default it will be located at <code>C:\Program Files (x86)\GOG Galaxy\Games\RimWorld</code> if you bought it through GOG on Windows.
# Create a <code>Mods</code> folder (if it doesn't already exist).
 <nowiki />RimWorld>Mods>PlagueGun
#* Go into the Mods folder.
#* Make a new folder with our mod's title: '''PlagueGun'''
# Inside '''PlagueGun''', make an '''About''' folder.
 <nowiki />RimWorld>Mods>PlagueGun>About
# Inside the '''About''' folder, make a new text file and rename it About.xml.
 <nowiki />RimWorld>Mods>PlagueGun>About>About.xml
#* You will need a good text editor to make a proper XML file -- see [[#Required Items|required items]]. I always make a .txt file first and change it to .xml. If you can't rename your file's type, make sure you have filetypes visible in your operating system's file view settings.
#* [[About.xml]] is the file that shows your mod in the mod list inside the RimWorld game. It is also used when creating a Workshop upload for Steam.
#* At the top of an XML file, always include this for RimWorld. It basically just gives the game some info about how to read the file. <source lang = "xml"><?xml version="1.0" encoding="utf-8"?></source> ''Note: the'' version '' tag should always be "1.0". It has no relation with the current RimWorld version.''
#* Then add the MetaData tags for the Workshop and in-game Mod list.<source lang ="xml"><ModMetaData>
<name>Test Mod - Plague Gun</name> 
<author>YourNameHere</author>
<packageId>YourNameHere.PlagueGun</packageId> 
<supportedVersions> 
<li>1.1</li>
</supportedVersions>
<description>This mod adds a plague gun, a weapon that has a chance to give your enemies the plague.\n\nFor version 1.1.</description>
</ModMetaData>
</source>
#* Save the file.
# Add a Preview.png or Preview.jpeg to your '''About''' folder.
 <nowiki />RimWorld>Mods>PlagueGun>About>Preview.png
#* This lets users see what your mod looks like in the RimWorld mod list or on the Steam Workshop.
#* The conventional dimensions to fit the preview image on Steam are 640x360. The image must be smaller than 1mb.
#* Example: [[File:Preview.png]]
# Make a '''Defs''' folder in your Mod's directory.
 <nowiki />RimWorld>Mods>PlagueGun>Defs
#* RimWorld will read your XML files in any subdirectory of '''Defs'''. You can name your directories however you like under that folder. Defs>StrangeNewAlienGuns>MyGuns.xml will work. For the purposes of this tutorial, however, we will use the RimWorld standard structure.
#* What are Defs? Main article: [[Modding Tutorials/XML Defs|Defs]]
#** RimWorld uses things called Defs (short for "definitions") like blueprints for in-game objects. Instead of using hidden C# code, RimWorld will look up an XML Def and copy it to the game world. This makes things easier for us, the modders. Everything from characters, animals, floors, damages, buildings, and even diseases in RimWorld use Defs. We're going to make Defs for our Plague Gun and Plague Bullet.
# Make a new '''ThingDefs''' folder in your '''Defs''' folder.
 <nowiki />RimWorld>Mods>PlagueGun>Defs>ThingDefs
# Make a new text file in your '''ThingDefs''' folder, and change it to RangedWeapon_PlagueGun.xml.
 <nowiki />RimWorld>Mods>PlagueGun>Defs>ThingDefs>RangedWeapon_PlagueGun.xml
#* This file will contain the blueprints (ThingDefs) for our new gun and bullets.
#* Next we will fill out our XML file by copying an existing revolver's ThingDef and a revolver bullet ThingDef.
#* In RimWorld, it is often best to use the XML attribute <code>ParentName="BaseBullet"</code> when making a bullet, because it will copy XML code from a pre-existing BaseBullet ThingDef, which can save us time and key taps. Main article: [[Modding Tutorials/XML file structure#Inheritance|Inheritance]]
# First, add our favourite line to the top.<source lang = "xml"><?xml version="1.0" encoding="utf-8"?></source>
# Add the <code><Defs></code> opening and closing tags to the XML to hold our new code.<source lang = "xml>
<?xml version="1.0" encoding="utf-8"?>
<Defs>

</Defs>
</source>
# Use your text editor. Use its "Find in Files" function to reference and copy Bullet_Revolver to your XML file.
#* Find in Files is one of my most-used functions. In Notepad++, if you press CTRL+SHIFT+F, you can go to the Find in Files screen. From there, you can enter a phrase to search for, and then you can enter the file path to search through. This makes it wildly easier to search for examples in RimWorld's Core. RimWorld holds copies of all of its weapons, items, buildings, etc. inside the Mods/Core directory.
#* So, start by using Find in Files... and find this: <code>defName>Bullet_Revolver</code>
#* When you find Bullet_Revolver, copy from its beginning <code><ThingDef></code> all the way until its closing <code></ThingDef></code> tag into your XML File.
# Use your text editor's "Find in Files" function to reference and copy Gun_Revolver to your XML file.
#* Typically, Gun_Revolver is right below Bullet_Revolver in XML, so hopefully this will be easy to find and copy.
#* Again, copy the ThingDef block to your new XML file.
# Change the defName, labels, and other stats of Bullet_Revolver and Revolver in your XML file to make them unique.
#* '''A word on defNames:''' <code>defName</code>s are how the game references defs anywhere they're used in XML, since they're unique. When telling your plague gun to fire plague bullets, for instance, set its <code>defaultProjectile</code> to your projectile's defName, like so:<source lang ="xml"><defaultProjectile>TST_Bullet_PlagueGun</defaultProjectile></source>
#* '''TIP:''' Use prefixes to avoid conflicting with other mods. RimWorld will overwrite any def with <code><defName>Tobacco</defName></code>, for instance, if it finds another with the same defName. If two modders use different prefixes, however, e.g. <code><defName>VGP_Tobacco</defName></code> and <code><defName>ROM_Tobacco</defName></code>, no conflict will occur, and both mods can co-exist. This tutorial uses TST_ for its example prefix. Main article: [[Modding_Tutorials/Compatibility|Compatibility]]
#* By contrast, labels, descriptions, and other non-defName tags can generally be non-unique without a risk of conflicts, except perhaps confusion for the end user.

<big>'''If all you were interested in is making a gun mod, you are done.'''</big> You'll of course want to edit values like the damage it does, and [[Modding_Tutorials/Testing_mods|test your mod]]. You'll also want to change the <code>texturePath</code> to your unique art, and whatever else.

=== Completed Example ===

''Note'': The example is up-to-date for [[Version|1.3]] and will likely be outdated in the future. The above steps should always be relevant.
<source lang ="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>
<ThingDef ParentName="BaseBullet">
<defName>TST_Bullet_PlagueGun</defName>
<label>plague bullet</label>
<graphicData>
<texPath>Things/Projectile/Bullet_Small</texPath>
<graphicClass>Graphic_Single</graphicClass>
</graphicData>
<projectile>
<damageDef>Bullet</damageDef>
<damageAmountBase>12</damageAmountBase>
<stoppingPower>1</stoppingPower>
<speed>55</speed>
</projectile>
</ThingDef>

<ThingDef ParentName="BaseHumanMakeableGun">
<defName>TST_Gun_PlagueGun</defName>
<label>plague gun</label>
<description>A curious weapon notable for its horrible health effects.</description>
<graphicData>
<texPath>Things/Item/Equipment/WeaponRanged/Revolver</texPath>
<graphicClass>Graphic_Single</graphicClass>
</graphicData>
<uiIconScale>1.4</uiIconScale>
<soundInteract>Interact_Revolver</soundInteract>
<thingSetMakerTags><li>RewardStandardQualitySuper</li></thingSetMakerTags>
<statBases>
<WorkToMake>4000</WorkToMake>
<Mass>1.4</Mass>
<AccuracyTouch>0.80</AccuracyTouch>
<AccuracyShort>0.75</AccuracyShort>
<AccuracyMedium>0.45</AccuracyMedium>
<AccuracyLong>0.35</AccuracyLong>
<RangedWeapon_Cooldown>1.6</RangedWeapon_Cooldown>
</statBases>
<weaponTags>
<li>SimpleGun</li>
<li>Revolver</li>
</weaponTags>
<weaponClasses>
<li>RangedLight</li>
</weaponClasses>
<costList>
<Steel>30</Steel>
<ComponentIndustrial>2</ComponentIndustrial>
</costList>
<recipeMaker>
<skillRequirements>
<Crafting>3</Crafting>
</skillRequirements>
</recipeMaker>
<verbs>
<li>
<verbClass>Verb_Shoot</verbClass>
<hasStandardCommand>true</hasStandardCommand>
<defaultProjectile>TST_Bullet_PlagueGun</defaultProjectile>
<warmupTime>0.3</warmupTime>
<range>25.9</range>
<soundCast>Shot_Revolver</soundCast>
<soundCastTail>GunTail_Light</soundCastTail>
<muzzleFlashScale>9</muzzleFlashScale>
</li>
</verbs>
<tools>
<li>
<label>grip</label>
<capacities>
<li>Blunt</li>
</capacities>
<power>9</power>
<cooldownTime>2</cooldownTime>
</li>
<li>
<label>barrel</label>
<capacities>
<li>Blunt</li>
<li>Poke</li>
</capacities>
<power>9</power>
<cooldownTime>2</cooldownTime>
</li>
</tools>
</ThingDef>
</Defs>
</source>

== C# Workspace Setup ==
{{Main|Modding Tutorials/Setting up a solution}}

Next, we will set up a workspace to write C# code, which is a little bit more involved than just using a text editor.

# Open your compiler of choice for C#.
#* This tutorial will assume you're using Visual Studio Community Edition, a free Windows-based compiler for C# code.
# Make a new Visual C# Class Library .NET Framework project. Name it PlagueGun. Make its directory RimWorld>Mods>PlagueGun>Source
#* File → New → Project → Class Library (.NET Framework).
#* Don't get this confused with "Class Library (.NET Standard)" or "Class Library (.NET Core)"!
# Go into the project properties.
#* Project → PlagueGun Properties.
# In that window, change the Target Framework version to .NET Framework 4.7.2
#* Forgetting to do this will cause lots of errors.
#* Select Yes when it asks you if you're sure to change the framework.
# While still in Properties, go to the '''Build''' tab.
# Change the output path to be RimWorld\Mods\PlagueGun\Assemblies
#* All .dll files will go into this directory when we "build" our code library.
# In that same window, click the Advanced... button.
# Change Debugging Information to none.
#* This prevents a simple error that occurs when RimWorld doesn't know what to do with the debug .pdb files.
# In Solution Explorer. Go into Properties and edit AssemblyInfo.cs. Change the name of your assembly and assembly file version number as you like.
#* This doesn't have to all be the same as your namespace, but it doesn't hurt to be consistent.
# In the main option bar at the top of the visual studio (File, Edit, View...), click Project, and click Add Reference.
# Click Browse at the bottom right corner of the window and go to RimWorld\RimWorldWin64_Data\Managed
# Add references to Assembly-CSharp.dll, UnityEngine.dll, and UnityEngine.CoreModule.dll.
#* In 1.1 the Unity DLLs were split up and are no longer all contained in the same module.
#* For our purposes we only need UnityEngine.CoreModule.dll, as it contains some code we will use later.
#* In general, it's also a good idea to add UnityEngine.dll, which allows Visual Studio to tell you which modules you're missing if you get related errors.
# In the Solution Explorer (typically on the right side of the application), look at the references drop down list.
# Select Assembly-CSharp. Check the Properties section (usually under Solution Explorer). Make sure the properties section has Copy Local set to FALSE.
# Do this (Copy Local to FALSE) for UnityEngine and UnityEngine.CoreModule as well.
#* By doing this, we prevent the project from causing one million hash conflicts by copying the entire game's code twice!

Now the workspace setup is complete and we can add C# code to RimWorld.

'''Note:''' Exact folder names might differ between installs. The naming scheme differs slightly between the DRM-free and Steam version of the mod.

== C# Coding ==

Now let's start writing the code we'll need to add custom behavior to our projectiles.

=== Getting Started ===
# Open Class1.cs in the sidebar, usually on the right in Visual Studio.
# Right-click and rename the .cs file to your liking.
# Add these lines to the top this file (and every .cs file you make from now on for modding RimWorld).<source lang ="csharp">
using RimWorld;
using Verse;
</source>
#* These tell the code you're working with RimWorld. Without these, our code will not be able to understand references to RimWorld code.
# Add a namespace line. By default, this is your project name. Take note - you will need this to connect to XML later.<source lang="csharp">
namespace TST_PlagueGun
{
}
</source>
#* '''Note:''' ''Using a prefix on the namespace is not required, but it's good for consistency and in the rare case they may overlap - such as when multiple people follow the same tutorial to learn how to mod.''

=== Connecting XML and C#, Part 1 ===
{{Main|Modding Tutorials/DefModExtension}}

# First, let's add a way to read XML data into your assembly.
# Rename public class Class1 to ModExtension_PlagueBullet and make it inherit DefModExtension. As a reminder, inheritance looks like this:<source lang="csharp">
public class ModExtension_PlagueBullet : DefModExtension
{
}
</source>
#* '''Note:''' Renaming things in an IDE like Visual Studio is best done by pressing F2 or right-clicking the item/name. Doing it like that will change all occurrences of that thing, so everything that references your namespace or Class1 will now use the new name.
# Add the following fields in ModExtension_PlagueBullet:<source lang="csharp">
public float addHediffChance = 0.05f;
public HediffDef hediffToAdd;
</source>
#* Here, we're giving the field addHediffChance a default value, which means it doesn't need to be set explicitly in XML.
#* '''Note:''' Standard modding practice is to give fields exposed to XML camelCase names, for consistency with vanilla XML.
# Now let's add the XML which connects to this ModExtension. In your TST_Bullet_PlagueGun def, add the following lines: <source lang="XML">
<modExtensions>
<li Class="TST_PlagueGun.ModExtension_PlagueBullet">
<addHediffChance>0.05</addHediffChance>
<hediffToAdd>Plague</hediffToAdd>
</li>
</modExtensions>
</source>
#* '''Note:''' Note the XML tags match the names of the fields in the C# class. This allows the XML to provide data to the program. When the mod is loaded, the XML will be read, and used to fill in the corresponding fields.
#* Additionally, take care to note you can set the value of addHediffChance to any valid floating point number and it will be reflected in-game. The value given in C# is only the default value if unset.

=== Writing the Projectile ===
# Let's make the actual projectile. For this tutorial, we're going to make a new projectile that checks for impact and adds a Hediff (health differential - poison, toxins, implants, anything).
# First, create a new .cs file by right-clicking the PlagueGun part of the Solution Explorer and selecting Add > New Item.
#* '''Note:''' in C#, you can have multiple class definitions in a single file. We're just making a new file for organizational purposes.
# Make your new class inherit the Bullet class (a child of the Projectile class), so the game will treat your new projectile like a bullet and not throw (fun) errors. <source lang="csharp">
public class Projectile_PlagueBullet : Bullet
</source>
# First, let's connect our new projectile to the relevant ModExtension: <source lang="csharp">
public ModExtension_PlagueBullet Props => def.GetModExtension<ModExtension_PlagueBullet>();
</source>
#* This line is a Property, basically a method which doesn't take any arguments, and can generally speaking be treated as a variable. See [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/properties this article] for more details.
# Now, let's start the actual core code of this mod. Let's begin by overriding the Impact method on the base Bullet class, like so: <source lang="csharp">
protected override void Impact(Thing hitThing, bool blockedByShield = false)
</source>
#* The <code>override</code> keyword tells the compiler that we're replacing the functionality of the <code>Impact</code> method from the <code>Bullet</code> class we're inheriting from.
# First, let's call the base version of this method so we don't need to rewrite all the logic about damaging a pawn - we only care about adding the hediff ''after'' damage occurs. <source lang="csharp">
base.Impact(hitThing, blockedByShield);
</source>
# Next, we check to make sure the ModExtension was properly loaded, that we hit something, and that what we hit was a [[Pawns|Pawn]].<source lang="csharp">
if (Props != null && hitThing != null && hitThing is Pawn hitPawn)
</source>
#* '''Note:''' Null checking is a very important skill, especially for Rimworld modding. If you ever get a <code>NullReferenceException</code>, check to make sure you're correctly handling null values.
#* Also, note that we initialize a <code>Pawn</code> version of the <code>hitThing</code> while checking its type; we'll use this later. This statement ''also'' null-checks this new variable, in case you were wondering.
# Now that we know we hit a pawn, we generate a random number to see whether to apply the hediff.<source lang="csharp">
float rand = Rand.Value;
if (rand <= Props.addHediffChance)
</source>
#* <code>Rand</code> is the base game's randomness generation class. <code>Value</code> grabs the next random number between 0 and 1 and updates the class.
# If a hediff is applied, we want to alert the player, so we create a message in the top-left of the screen.<source lang="csharp">
Messages.Message("TST_PlagueBullet_SuccessMessage".Translate(
this.launcher.Label, hitPawn.Label
), MessageTypeDefOf.NeutralEvent);
</source>
# Before adding the hediff, we need to check if the pawn already has it, so we get the hediff from the pawn, if it exists.<source lang="csharp">
Hediff plagueOnPawn = hitPawn.health?.hediffSet?.GetFirstHediffOfDef(Props.hediffToAdd);
</source>
#* '''Note:''' The <code>?.</code> is called the [https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/operators/member-access-operators#null-conditional-operators--and- null conditional operator]. It's basically an in-line null check; if the hit pawn's health tracker (<code>health</code>) or hediff set (<code>hediffSet</code>) are null it sets <code>plagueOnPawn</code> to null instead of throwing an error.
# Now we finally add the hediff. If the pawn already has the plague we just increase its severity; otherwise, we create and add a new hediff with a random severity.<source lang="csharp">
float randomSeverity = Rand.Range(0.15f, 0.30f);
if (plagueOnPawn != null)
{
plagueOnPawn.Severity += randomSeverity;
}
else
{
Hediff hediff = HediffMaker.MakeHediff(Props.hediffToAdd, hitPawn);
hediff.Severity = randomSeverity;
hitPawn.health.AddHediff(hediff);
}</source>

==== Whew. ====
Let's take a break and recap for a second. If you've followed the projectile section so far, this is the code you should have in your new .cs file:<source lang="csharp">
using Verse;
using RimWorld;

namespace TST_PlagueGun
{
public class Projectile_PlagueBullet : Bullet
{
public ModExtension_PlagueBullet Props => base.def.GetModExtension<ModExtension_PlagueBullet>();

protected override void Impact(Thing hitThing, bool blockedByShield = false)
{
base.Impact(hitThing, blockedByShield);
if (Props != null && hitThing != null && hitThing is Pawn hitPawn)
{
float rand = Rand.Value;
if (rand <= Props.addHediffChance)
{
Messages.Message("TST_PlagueBullet_SuccessMessage".Translate(
this.launcher.Label, hitPawn.Label
), MessageTypeDefOf.NeutralEvent);
Hediff plagueOnPawn = hitPawn.health?.hediffSet?.GetFirstHediffOfDef(Props.hediffToAdd);
float randomSeverity = Rand.Range(0.15f, 0.30f);
if (plagueOnPawn != null)
{
plagueOnPawn.Severity += randomSeverity;
}
else
{
Hediff hediff = HediffMaker.MakeHediff(Props.hediffToAdd, hitPawn);
hediff.Severity = randomSeverity;
hitPawn.health.AddHediff(hediff);
}
}
}
}
}
}
</source>
Don't worry, we're almost finished. In fact, if you compile right now the gun ''will'' work - there just won't be any feedback if the shooter misses. This might be desirable, but let's add some feedback anyway.

Well, that's a little bit of a lie. You'd also need to add the <code><thingClass></code> node to the XML, given below.

We want to add an <code>else</code> block to our <code>if (rand <= Props.addHediffChance))</code> statement. This is where keeping track of curly braces comes in; Visual Studio should draw vertical lines between the correct curlies. Add this:<source lang="csharp">
else
{
MoteMaker.ThrowText(hitThing.PositionHeld.ToVector3(), hitThing.MapHeld, "TST_PlagueBullet_FailureMote".Translate(Props.addHediffChance), 12f);
}
</source>
* This throws a mote (particle effect, essentially), with text stating that the plague was not applied, at the target's position.
* Fun fact: the <code>.ToVector3()</code> call is the entire reason we needed to reference UnityEngine and UnityEngine.CoreModule.

=== Connecting XML and C#, Part 2 ===
Finally, we need to make sure our projectile's def tells the game to use our new Projectile_PlagueBullet class instead of Bullet.<source lang="xml">
<thingClass>TST_PlagueGun.Projectile_PlagueBullet</thingClass>
</source>

We're done! Your final Projectile_PlagueBullet class should look like this:<source lang="csharp">
using Verse;
using RimWorld;

namespace TST_PlagueGun
{
public class Projectile_PlagueBullet : Bullet
{
public ModExtension_PlagueBullet Props => base.def.GetModExtension<ModExtension_PlagueBullet>();

protected override void Impact(Thing hitThing, bool blockedByShield = false)
{
base.Impact(hitThing, blockedByShield);
if (Props != null && hitThing != null && hitThing is Pawn hitPawn)
{
float rand = Rand.Value;
if (rand <= Props.addHediffChance)
{
Messages.Message("TST_PlagueBullet_SuccessMessage".Translate(
this.launcher.Label, hitPawn.Label
), MessageTypeDefOf.NeutralEvent);
Hediff plagueOnPawn = hitPawn.health?.hediffSet?.GetFirstHediffOfDef(Props.hediffToAdd);
float randomSeverity = Rand.Range(0.15f, 0.30f);
if (plagueOnPawn != null)
{
plagueOnPawn.Severity += randomSeverity;
}
else
{
Hediff hediff = HediffMaker.MakeHediff(Props.hediffToAdd, hitPawn);
hediff.Severity = randomSeverity;
hitPawn.health.AddHediff(hediff);
}
}
else
{
MoteMaker.ThrowText(hitThing.PositionHeld.ToVector3(), hitThing.MapHeld, "TST_PlagueBullet_FailureMote".Translate(Props.addHediffChance), 12f);
}
}
}
}
}</source>

Just compile and test your work; the plague will be properly applied and everything.

'''Note:''' Code you write on your own should not look like this - for one thing, it should be well-commented so that others (even if it's just you in the future) know exactly what you're trying to do and how you're doing it. The code [https://github.com/dninemfive/PlagueGun/blob/master/PlagueGun/Projectile_PlagueBullet.cs in the repo] is probably over-commented and designed for a general audience but I recommend reviewing it.

== Localization ==
...well, almost. If you did test the gun just now, you'll have seen that the text was all distorted, using special characters which looked like the normal ones instead of text you expected. This is because of the use of <code>.Translate()</code> on keys which do not have translations in the language database. We just need to add those, and we'll be all set!

# First, create a bunch of folders, starting in the root of your mod folder:
 <nowiki />Languages>English>Keyed
# Next, create a new file called PlagueGun_Keys.xml, with our favorite header.<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
</source>
# This will be really quick. Add the opening and closing <code><LanguageData></code> tags:<source lang="xml">
<LanguageData>
</LanguageData>
</source>
# And, finally, add translations for the two keys used in the projectile class.<source lang="xml">
<TST_PlagueBullet_FailureMote>Failure: {0} chance</TST_PlagueBullet_FailureMote>
<TST_PlagueBullet_SuccessMessage>{0} infected {1} with the plague!</TST_PlagueBullet_SuccessMessage>
</source>
#* The <code>{0}</code> and <code>{1}</code> in these keys will be replaced with the first and second arguments, respectively, of the <code>.Translate()</code> calls. For reference:<source lang="csharp">
// successful hit message
"TST_PlagueBullet_SuccessMessage".Translate(this.launcher.Label, hitPawn.Label)
// unsuccessful hit mote
"TST_PlagueBullet_FailureMote".Translate(Props.addHediffChance)
</source>
#* If you give <code>.Translate()</code> more arguments, you can use <code>{2}</code>, <code>{3}</code>, &c.
#* Note that, since you only passed one argument to the failure message, <code>{1}</code> would not be replaced with anything.
# Your PlagueGun_Keys.xml file should look like this:<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<LanguageData>
<TST_PlagueBullet_FailureMote>Failure: {0} chance</TST_PlagueBullet_FailureMote>
<TST_PlagueBullet_SuccessMessage>{0} infected {1} with the plague!</TST_PlagueBullet_SuccessMessage>
</LanguageData>
</source>

== Next Steps ==
This concludes this tutorial. Congratulations on making it this far; you now have a solid understanding of XML and C# modding, and of connecting these two. There's a lot more to learn, especially on the C# end, so make sure to practice. If you have any questions don't hesitate to hit up the [https://discord.gg/UTaMDWc Discord]#mod-development or the [https://ludeon.com/forums/index.php?board=14.0 forums] for help.

As for this mod, you might want to add custom textures or sounds. For your next, you might want to try messing around with [[Modding Tutorials/Harmony|Harmony]] or see other [[Modding Tutorials|tutorials]] for inspiration.

== See also ==
* [[Modding Tutorials/Setting up a solution|Setting up a solution]]
* [[Modding Tutorials/Distribution|Distribution]]
* [[Modding Tutorials/Harmony|Harmony]]
* [[Modding_Tutorials/Mod_folder_structure#The_Languages_folder|Language support]]

== History ==
* This tutorial is a rewrite of the original by Jecrell (see also original forum {{LudeonThread|33219}})

[[Category: Modding tutorials]]
[[Category: Modding]]

Modding Tutorials/RimWorld 1.6 Mod Updates

2025-06-13T01:31:04Z

Halicade: /* Misc */ targetparams change

{{DISPLAYTITLE:RimWorld 1.6 Mod Updates}}

{{BackToTutorials}}

'''NOTICE''': This is a repository of information for mod developers updating their mods to RimWorld 1.6. '''THERE MAY BE ODYSSEY DLC SPOILERS HERE.'''

For questions and clarifications, please come visit us at the #mod-development channel on the [https://discord.gg/rimworld RimWorld Discord server].

== General Tips ==

If you are updating a mod between RimWorld versions for the first time:

# Update your supportedVersions in your About.xml
# Consider using [[Modding_Tutorials/Mod_Folder_Structure|LoadFolders]] to freeze your previous version content.
# Try to recompile your assemblies. Address any issues that come up.
# Try to load your mod. Work the error list top to bottom.
# Check your mod functionality. This is a great time to create a functionality checklist for future updates if you haven't made one already!
# Check back after further patches. Updates and additional content may be released in post-release patches for months to come, don't assume that mods never break once updated!

== RimWorld 1.6 Base Game Changes ==

Official Changelog: [https://docs.google.com/document/d/e/2PACX-1vRCjqVtPQDFGu4POiKTUd_8o3U2Asdhx99SOvcgU66ABdYtk3Cgndd53yJ6BC4tZX530pp_m6lf4Z9P/pub Official Google Doc] - describes all base game changes in RimWorld 1.6.

Official Modder Primer: [https://docs.google.com/document/d/e/2PACX-1vRKE9u5ZW_zG45pxzwNvy4sxvozDeqtxlxpac5jwenOeW6liQCPgmPl9bIbtcMuqL1NPIDHOLFg64M_/pub Official Google Doc] - technical document intended for modders.

=== Designators ===

* As part of the new vanilla designator shapes system, the virtual DraggableDimensions property has been replaced with DrawStyleCategory, which returns a DrawStyleCategoryDef. You can use one of the several vanilla presets or create your own Def to determine what kinds of shapes can be drawn with your designator.

=== Buildings ===

* <code><placingDraggableDimensions></code> has been changed to <code><drawStyleCategory></code> to utilize the new vanilla designator shapes system. This is a DrawStyleCategoryDef.
* <code><soundAmbient></code> has been removed in 1.6 in favor of a new ThingComp. The following is from the Toxifier Generator:
<source>
<li Class="CompProperties_AmbientSound">
<sound>Toxifier_Working</sound>
<disabledOnUnpowered>true</disabledOnUnpowered>
</li>
</source>

=== Pawns ===

* <code><wildness></code> is no longer a field on RaceProperties, but is now a StatDef that goes in a race's <code><statBases></code>. Note that as a StatDef, it is now capitalized as well (<code><Wildness></code>).

=== Hediffs ===

* <code><causesNeed></code> has been removed. For drugs specifically, you should now use <code><chemicalNeed></code> on the HediffDef root, or for non-drug needs you can use the <code><enablesNeeds></code> list in HediffStage.
* <code><disablesNeeds></code> has been moved to HediffStage as well.

=== Terrains ===

* <code><holdSnow></code> has been renamed to <code><holdSnowOrSand></code>.

=== Plants ===

* <code><hideAtSnowDepth></code> has been renamed to <code><hideAtSnowOrSandDepth></code>.

=== Scenarios ===

* There is a new <code>ScenarioBase</code> abstract base for ScenarioDefs. You should inherit from this in order to inherit some new fields that deal with the map layering system; omitting them will cause errors on load.

=== Misc ===

* ActiveDropPodInfo has been renamed to ActiveTransporterInfo - potentially used by Odyssey shuttles now?
* The targetParams <code><canTargetMutants></code> has been renamed to <code><canTargetSubhumans></code>.

== Visual Studio and Burst ==

If you've decompiled the dll, exported all code to .cs files, and opened that in Visual Studio and are getting constant crashes and hangs:

Edit the file Properties/AssemblyInfo.cs and delete all the lines with "`BurstCompiler`". It's not like you're re-compiling it, so these are not needed anyway.

== Odyssey DLC Compatibility ==

The following features appear to be DLC-locked. Note that this information has been gathered via datamining and may not reflect the final state of the game at release, nor is it necessarily comprehensive:

* Gravships
* Transport Shuttles
* Landmarks, Tile Mutators, and several new GenSteps
* Space, Asteroid Quests, Oxygen, Vacuum
* Aggressive Habitat Animals (needs clarification)
* Coastal Animals (needs clarification)
* Fishing
* Mixed Biome Maps
* Extended animal capabilities: Foraging, Targeted Attack, Sentience
* New Weather: Droughts, Frozen Water, Floods, Sandstorms
* Plant Cultivation (needs clarification)
* New Questgivers: Traders, Beggars, Books, Orbital Scanners (?)
* Substructure (needs clarification)
* New Precepts: Fishing, Space, Colony Moving

Modding Tutorials/RimWorld 1.6 Mod Updates

2025-06-12T14:53:00Z

Halicade: Added plant section, Added new hideAtSnowOrSandDepth

{{DISPLAYTITLE:RimWorld 1.6 Mod Updates}}

{{BackToTutorials}}

'''NOTICE''': This is a repository of information for mod developers updating their mods to RimWorld 1.6. '''THERE MAY BE ODYSSEY DLC SPOILERS HERE.'''

For questions and clarifications, please come visit us at the #mod-development channel on the [https://discord.gg/rimworld RimWorld Discord server].

== General Tips ==

If you are updating a mod between RimWorld versions for the first time:

# Update your supportedVersions in your About.xml
# Consider using [[Modding_Tutorials/Mod_Folder_Structure|LoadFolders]] to freeze your previous version content.
# Try to recompile your assemblies. Address any issues that come up.
# Try to load your mod. Work the error list top to bottom.
# Check your mod functionality. This is a great time to create a functionality checklist for future updates if you haven't made one already!
# Check back after further patches. Updates and additional content may be released in post-release patches for months to come, don't assume that mods never break once updated!

== RimWorld 1.6 Base Game Changes ==

Official Changelog: [https://docs.google.com/document/d/e/2PACX-1vRCjqVtPQDFGu4POiKTUd_8o3U2Asdhx99SOvcgU66ABdYtk3Cgndd53yJ6BC4tZX530pp_m6lf4Z9P/pub Official Google Doc] - describes all base game changes in RimWorld 1.6.

Official Modder Primer: [https://docs.google.com/document/d/e/2PACX-1vRKE9u5ZW_zG45pxzwNvy4sxvozDeqtxlxpac5jwenOeW6liQCPgmPl9bIbtcMuqL1NPIDHOLFg64M_/pub Official Google Doc] - technical document intended for modders.

=== Buildings ===

* <code><placingDraggableDimensions></code> has been changed to <code><drawStyleCategory></code> to utilize the new vanilla designator shapes system. This is a DrawStyleCategoryDef.
* <code><soundAmbient></code> has been removed in 1.6 in favor of a new ThingComp. The following is from the Toxifier Generator:
<source>
<li Class="CompProperties_AmbientSound">
<sound>Toxifier_Working</sound>
<disabledOnUnpowered>true</disabledOnUnpowered>
</li>
</source>

=== Pawns ===

* <code><wildness></code> is no longer a field on RaceProperties, but is now a StatDef that goes in a race's <code><statBases></code>. Note that as a StatDef, it is now capitalized as well (<code><Wildness></code>).

=== Hediffs ===

* <code><causesNeed></code> has been removed. For drugs specifically, you should now use <code><chemicalNeed></code> on the HediffDef root, or for non-drug needs you can use the <code><enablesNeeds></code> list in HediffStage.
* <code><disablesNeeds></code> has been moved to HediffStage as well.

=== Terrains ===

* <code><holdSnow></code> has been renamed to <code><holdSnowOrSand></code>.

=== Plants ===

* <code><hideAtSnowDepth></code> has been renamed to <code><hideAtSnowOrSandDepth></code>.

=== Scenarios ===

* There is a new <code>ScenarioBase</code> abstract base for ScenarioDefs. You should inherit from this in order to inherit some new fields that deal with the map layering system; omitting them will cause errors on load.

== Visual Studio and Burst ==

If you've decompiled the dll, exported all code to .cs files, and opened that in Visual Studio and are getting constant crashes and hangs:

Edit the file Properties/AssemblyInfo.cs and delete all the lines with "`BurstCompiler`". It's not like you're re-compiling it, so these are not needed anyway.

== Odyssey DLC Compatibility ==

The following features appear to be DLC-locked. Note that this information has been gathered via datamining and may not reflect the final state of the game at release, nor is it necessarily comprehensive:

* Gravships
* Transport Shuttles
* Landmarks, Tile Mutators, and several new GenSteps
* Space, Asteroid Quests, Oxygen, Vacuum
* Aggressive Habitat Animals (needs clarification)
* Coastal Animals (needs clarification)
* Fishing
* Mixed Biome Maps
* Extended animal capabilities: Foraging, Targeted Attack, Sentience
* New Weather: Droughts, Frozen Water, Floods, Sandstorms
* Plant Cultivation (needs clarification)
* New Questgivers: Traders, Beggars, Books, Orbital Scanners (?)
* Substructure (needs clarification)
* New Precepts: Fishing, Space, Colony Moving

Modding Tutorials/Setting up a solution

2025-05-11T00:43:22Z

Halicade: Missing word

{{BackToTutorials}}
{{Credit|[[User:Alistaire|Alistaire]]}} 

In this tutorial you will learn how to set up a solution, along with instructions on setting the output directory and files for more convenient building right into the Assemblies folder.

=Requirements=

* The manual option in this tutorial requires you to have [[Modding_Tutorials/Mod_folder_structure#The Source and Assemblies folders|set up a Source and Assemblies folder]] (the Visual Studio automatic option sets this up for you).
* You will want to have an IDE installed: [[Modding Tutorials/Recommended software#IDE's|Recommended IDE's]]. 

=Setting up a solution=
Setting up can be different for different IDE's. Feel free to add '''''complete''''' instructions for your IDE of choice.

===Visual Studio Community 2022===
''NOTE: Visual Studio 2022 is a rather heavy application (2-3 GB for basic functionality) but works out of the box. It is strongly recommended if you are on Windows and have a PC that can handle it. This tutorial is similar for other versions of Visual Studio.''

==== Option 1 (Manual Method):====
# Create a new class library project
## Once loaded, go to File -> New -> Project...
## Type "Class Library (.NET Framework)" in the search bar, and select the C# option. [[File:ClassLibrary.png|200px|thumb|right|Installing the .NET framework]]
## Enter your project name.
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## Enter a solution name (optionally, tick "Place solution and project in the same directory")
## Make sure Framework is ".NET Framework 4.7.2"
# In your project, set target framework and various other properties
## In your Solution Explorer (the panel usually located on the right), right click your project -> Properties (or expand your project and double click "Properties" with the wrench icon)
## ''Optional'': Under Application, change your Assembly and Namespace names to anything of your choice
## Go to Build -> Advanced... and set "Debugging information" to none
## Leave Advanced..., and set the Output Path to "..\..\Assemblies\" (Or wherever the Assemblies folder is)
# Add references to RimWorld code
## Expand your project in Solution Explorer. Then right click "References" -> Add Reference...
## Click Browse...
## Navigate towards <pre>RimWorldInstallPath/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Add"
## Click "OK" to close the Reference Manager.
## Right-click on both Assembly-CSharp.dll and UnityEngine.dll and set Copy Local to False (Properties pane).

====Option 2 (Using Nuget):====
This option uses [https://www.nuget.org/packages/Krafs.Rimworld.Ref Krafs Rimworld Reference Package] it is less involved than using reference assemblies and is the recommended method.
#Follow the above up till ''Add references to RimWorld code''
#From the Tools menu, select NuGet Package Manager -> Package Manager Settings.
##In the Settings dialog, under Package Management, change the ''Default package management format'' to '''PackageReference'''.
##Click OK to close the dialog.
#Open Nuget Manager and type ''Rimworld''
#Add Krafs Rimworld Reference
You can now continue as if you added the assemblies. Doing this makes your project portable, because RimRef can be downloaded by anyone and used from anywhere, unlike Rimworld's assemblies which can't be distributed.

====Option 3 (Using Rimworld Dotnet Template):====
This option uses [https://github.com/Zeta-of-the-rim/Rimwold-Dotnet-Template Rimworld Dotnet Template] it allows faster creation of mod files including Xml folders

After installing the template.
#Open your mod folder
#create a new folder for your mod (It is best to use the name you want for your mod)
#Open a command prompt in that folder
#type ''dotnet new RimMod'' (This will create a new mod with the name you specified)
#Open the About folder and edit the About.xml file
#Open the .sln file in your preferred IDE
#Add the rimworld assemblies using your preferred method

While this method is faster, it is still good to know how to do it manually.

====Option 4 (Using Cookiecutter):====
This option uses the [https://ludeon.com/forums/index.php?topic=39038.0 Rimworld Mod Development Cookiecutter] tool.
'''Note: despite being automatic and potentially taking away some of the tedium away, the environment it sets up is very particular and this tool is currently not recommended for newcomers.'''
''As of Jan 2019, the cookiecutter is set up for Windows development. Linux/Mac people can still use it, but they will have a few errors to clean up.''
# Open Visual Studio
# Once loaded, go to File -> New -> From Cookiecutter...
# Search for ''rimworld''
# Double-click ''cookiecutter-rimworld-mod-development''
# Change the Template Options:
## ''Create To'' => ''Your/Rimworld/Mod/Directory''
## ''mod_name''
## ''namespace_name'' (don't change if unsure)
## ''author'' => ''your steam username''
## ''target_version'' => current RW version (can leave blank for most up-to-date)
## ''in_game_description'' (not required, can change later in About-Release.xml)
## ''url'' (can leave blank for link to your Steam Workshop profile)
# Click "Create and Open Folder"

===Sharpdevelop===
'''Caution:''' Sharpdevelop (or #develop) does NOT CURRENTLY allow for C# 6.0+ syntax without plugins and does NOT ALLOW for C# 7.0+ syntax at all. For your average project this does not matter, however some existing projects are already built entirely upon C# 6.0+ syntax which can not be compiled anymore in Sharpdevelop. Visual Studio does not have these issues and should be your go-to for compiling large projects such as Combat Extended.

# Create a new class library project in your [[Modding Tutorials/Recommended software#IDE.27s|IDE of choice]];
## Go to File -> New -> Solution;
## Go to C# or .NET -> Library or Class Library (NOT portable);
## Enter a project name (solution name automatically updated);
## Choose a location, preferably: <pre>(RimWorldInstallFolder)/Mods/(YourModName)/Source</pre>
## ''Optional'': Untick "Create a directory for solution"/"Create a project within the solution directory",
# In your project, add references to Assembly-CSharp.dll and UnityEngine.dll:
## In your IDE project file browser, right-click the "References" folder and "Add reference";
## Choose the ".NET Assembly Browser" tab and "Browse...";
## Navigate towards <pre>RimWorld******/RimWorld******_Data/Managed</pre> and select files: <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre>
## Click "Open" then "OK";
## In the References folder, right-click Assembly-CSharp -> Properties and change "Local copy" to False. Do the same for UnityEngine,
# In your project properties, change the target framework to .NET 4.7.2:
## In your IDE project file browser, right-click "(YourSolutionName)";
## Choose Properties;
## Go to the "Compiling" tab, "Output", "Target framework", "Change" and choose ".NET Framework 4.7.2",
# In your project properties, change the build events so only a single file is built:
## Go to the "Compiling" tab, "Output", "Debug info" and choose "No debug information";
## Right-click your .cs files -> Properties and change "Copy to output" (If you haven't resized the properties bar, this will be truncated to "Copy to out") to Never,
# In your project properties, fix the output location to put the DLL in the Assemblies folder:
## Go to the "Compiling" tab, "Output", "Output path" and change the output path to "..\..\Assemblies\". 

===Linux===

On Linux it is possible to develop using .NET packages provided by Microsoft:
# [https://dotnet.microsoft.com/download Install .NET by following the provided instructions.]
# If you use IDE, use it to build (no further details, not tested).
# It is possible to build from CLI using a .csproj file. Find a mod that has description pointing to its GitHub sources and copy from there ([https://github.com/llunak/rimworld-dietfiltersinstorage/blob/master/Source/DietFiltersInStorage.csproj example here]), or use another way to create a .csproj file.
# For building use a command like the following (substitute the proper .csproj file, change Release to Debug for a debug build): <pre>dotnet build <project file>.csproj /property:Configuration=Release</pre>
# If you get errors, possibly the .csproj is Windows-specific and needs to be edited:
## You may need to fix paths (point them to .dll files in RimWorld/RimWorld*_Data/Managed, but it is generally better to use NuGet as described above in Option 2, as that is platform-independent).
## See other setups above for other settings (those IDEs write those settings to the .csproj files).

Note that .NET Framework from Microsoft is Windows-only, and some .csproj files do not build without it. Generally it seems those using Windows-specific paths are affected, while those platform-independent work fine. Either use Mono (see below), or use one that works. The example .csproj file linked above can usually be used as a drop-in replacement, with only properties in the first PropertyGroup needing adjustment. If you really want or need it, you can get .NET Framework from Mono, by additionally doing these steps:
# Install Mono (refer to your distribution's instructions);
# Change the build command to the following (4.7.2 is the .NET version from the .csproj file): <pre>FrameworkPathOverride=$(dirname $(which mono))/../lib/mono/4.7.2-api/ dotnet build <project file>.csproj /property:Configuration=Release</pre>

===Xamarin/MonoDevelop===
The setup is similar as the one above. A few special points to address:
# Mono 4.X isn't backward compatible so you may need to install an older 3.X version of Mono in order to compile against .NET4.7.2 dlls.
# Make sure you uncheck "Use MSBuild build engine (recommended for this project type)" under project > options > build > general (You might find this by right-clicking on your project - not solution - name and selecting options)
# Changing the framework to 4.7.2 can be found (for Linux anyway) in the same place.

More detailed installation instructions for Linux can be found [https://blog.rubenwardy.com/2016/07/21/rimworld-setup-monodevelop/ here] and [https://spdskatr.github.io/RWModdingResources/mono-arch here]. Note that as of now (2021) these may be outdated, so if it doesn't work, you can try the steps described in the Mono section.

===Rider (good for Mac)===
JetBrains Rider is a great cross-platform C# IDE. Previously a paid product (with exceptions), it now offers a community license, making it free for non-commercial use.

# Open Rider and click New Solution in the welcome dialog.
## Click Class Library under .NET on the left. The option may take a second to show up.
## Under Solution Name (and Project Name), enter the name of your mod.
## Set the Solution Directory to [your mod folder]/Source.
## Optionally check "put solution and project in the same directory." This is probably a good idea.
## Change Framework to .Net Framework 4.7.2. If you're on Windows and 4.7.2 does not show up as an option, you will have to install the "4.7.2 Dev Pack" from [https://dotnet.microsoft.com/en-us/download/visual-studio-sdks Microsoft.]
## Click Create.
# In the left side bar, expand your solution, right click your project (mod name with "C#" icon) and click Properties.
## In the Properties window, select Configurations > Debug on the left and uncheck Debug Symbols.
## For both configurations, change the Output Path to ../../Assemblies.
## Click OK.
# Expand your project, right click References and click Add Reference.
## Click Add From.
## Browse to the folder with the RimWorld DLLs
### DLL Location for Mac: "/Users/[username]/Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Contents/Resources/Data/Managed
### For Win10: "\Program Files (x86)\Steam\steamapps\common\RimWorld\RimWorldWin64_Data\Managed"
## Select both Assembly-CSharp.dll and UnityEngine.dll and click OK.
## Expand Assemblies under References. For both of the assemblies that you just added:
### Right click the assembly and click Properties.
### Uncheck "Copy Local" (you may need to scroll down) and click OK.

You're done! Note that Rider has a built-in decompiler—to view the source of a RimWorld class or method, just right-click its name and click Go To > Definition.

===.NET Framework via Commmandline===
If you are on Windows and for some reason you don't want to use Visual Studio, you can also use the C# compiler that comes with the .NET Framework from within the terminal.

# Install the [https://dotnet.microsoft.com .NET Framework].
# (Optional) Adding the compiler to PATH.
## Search for "env" -> Edit system environment variables -> click on "Environment Variables" -> Edit the Path of the user variables -> Add the folder of csc.exe (Usually C:\Windows\Microsoft.NET\Framework\vX.X.XXXXX).
# Find <pre>Assembly-CSharp.dll
UnityEngine.CoreModule.dll</pre> in your game files(Usualy at: C:\Program Files (x86)\Steam\steamapps\common\RimWorld\RimWorldWin64_Data\Managed\).
# Open a terminal and cd to the location of your .cs file.
# Compile your .cs file (If you skipped adding csc.exe to path, replace it with its full filepath in the following command).
## It should look something like this:<pre>csc.exe /t:library /r:"C:\Program Files (x86)\Steam\steamapps\common\RimWorld\RimWorldWin64_Data\Managed\Assembly-CSharp.dll","C:\Program Files (x86)\Steam\steamapps\common\RimWorld\RimWorldWin64_Data\Managed\UnityEngine.CoreModule.dll" MyMod.cs</pre>
## The command is structured where:<pre>csc.exe</pre> is the compiler(or the whole filepath), and:<pre>/r:"...","..."</pre> is the filepath of both gamefiles from step 3, and:<pre>MyMod.cs</pre> is your C# source code.
# Explanation:
## the /t flag sets it to be a .dll file.
## the /r flag references the game files(Not the decompiled source code, the game files).

===Visual Studio Code via Dev Container===
{{Recode|section=1|reason=Section commented out due to unknown, unvalidated source. Ideally a full guide for VCS needs to be written}}


=Common issues=
* Can't find the option to target .NET Framework 4.7.2? It may require additional installation steps. In Visual Studio, Tools => Get Tools and features => Individual Components => Select ''.NET Framework 4.7.2 development tools'' (or google installation instructions). Also make sure your project is a ''Class Library (.NET '''Framework''')''. Not .NET Core or .NET Standard.

=See also=
* [[Modding Tutorials/Writing custom code|Writing custom code]] continues on setting up your solution. 

[[Category:Modding tutorials]]

Modding Tutorials/Compatibility

2025-03-02T03:03:19Z

Halicade: /* Defensive patching */ Removing outdated patch method to prevent its usage. PatchOperationConditional should be used

{{BackToTutorials}}
{{Stub}}
 
As the pool of mods gets bigger and the game's development stabilises, compatibility between mods becomes more and more important. Prior to Alpha 17, compatibility was often an afterthought, or technically unfeasible. Since then, with the advent of tools like xpath-based [[Modding Tutorials/PatchOperations| PatchOperations]] and [[Modding Tutorials/Harmony| Harmony]], there is no technical excuse for mod conflicts. With these two tools, all mods can co-exist and alter anything in their respective domain without interfering with the operation of other mods. All that is required is at least one, but preferably two modders willing to cooperate.

=Mod conflicts=
Two or more mods can alter the same thing. If both adhere to best practices, this can happen with minimal or no issues. The most common cause of XML mod conflicts is [[Modding_Tutorials/XML_file_structure#Inheritance| overwriting (abstract) bases]], overwriting Defs wholesale and [[Modding Tutorials/Harmony| destructive prefixes]]. Note that while two mods can both change the same thing, we can't really speak of a conflict until unintended or undesired behaviour arises.

=Avoiding mod conflicts=

* Don't overwrite abstract bases. You can use [https://github.com/RimWorld-CCL-Reborn/AllYourBase this tool] to easily find mods which don't adhere to best practices.
* Stay in scope. Do your patching defensively.
* Don't overwrite vanilla's Defs unless you absolutely have to. If you just want to change just a few values, use [[Modding Tutorials/PatchOperations| xpath]].
* In C#, keep in mind that things can and will be null. Even more so when dealing with other mods: sometimes mods have to be creative with their solutions (and other times their creator just plain has no idea what they're doing).

==Defensive patching==
Modders should keep in mind that there are more mods than just theirs and Core. Users run with dozens, if not hundreds of mods. Always try to limit your scope so your alterations only apply to those things you intend to change.

===XML===
When adding something (like a stackLimit to Thoughts, or comps to ThingsWithComps), keep in mind you're likely not the first. Here is an example of a defensive xpath:

<source lang="XML">


<Operation Class="PatchOperationConditional">
<xpath>/Defs/WorldObjectDef[defName="Caravan"]/comps</xpath>
<nomatch Class="PatchOperationAdd">
<xpath>/Defs/WorldObjectDef[defName="Caravan"]</xpath>
<value>
<comps>
<li>
<compClass>MyNamespace.MyComp</compClass>
</li>
</comps>
</value>
</nomatch>
<match Class="PatchOperationAdd">
<xpath>/Defs/WorldObjectDef[defName="Caravan"]/comps</xpath>
<value>
<li>
<compClass>MyNamespace.MyComp</compClass>
</li>
</value>
</match>
</Operation>
</source>

===C#===
C# compatibility issues generally fall into these categories: 
* Destructive prefixes
::These should be avoided if at all possible. In a lot of cases, you can substitute with a postfix instead. You can also limit the impact of your destructive prefix by staying in scope as much as possible. It's entirely feasible to check for a def, type, comp, whatever, and determine if you should really return false in all cases.
* Null references
::You're probably not doing enough null-checking. Null is a valid value for a lot of things in RimWorld.
* Weird interactions
::These have to be handled on a case by case basis.

==Mod load order==
If one mod wants to make [[Muffalo]]s green and another wants to make them red, one of them is going to win. The general understanding of mod load order is that "mods on the bottom win and overwrite mods on top".

As with most things, the truth is a bit more fine-grained. It's true that if "Core, Mod 1, Mod 2, Mod 3" is the load order, and it's true that the last mod in the load order "wins", but the actual load order is a bit different.

# XML
# xpath
# C#

The game first loads all XML (defs, mostly) from Core, Mod 1, Mod 2, Mod 3
Then it applies all xpath patches from Mod 1, Mod 2, Mod 3
Then it loads the C# from Mod 1, Mod 2, Mod 3

Core doesn't use xpath or load any C#, so they're not in that list. The C# for RimWorld is already loaded by that point, roughly speaking.
So if Mod 3 overwrites something in XML, but Mod 2 overwrites it in xpath and Mod 1 overwrites it in C#, it's Mod 1 that wins -- even though Mod 3 and Mod 2 come after it in the load order.

There are a few things that matter with load order:
- Does the mod require a different mod? Examples of that are mods that require HugsLib, Proper Shotguns, Turret Extensions, Alien Races, JecsTools, whatever. If you are missing a dependency, you'll notice: You get a nice red error saying something like
Could not find type named TurretExtensions.CompProperties_Upgradable from node <A lot of XML> and missing a dependency like that will put the entire game in a corrupted and unplayable state.

[[Category:Modding tutorials]]

Modding Tutorials/Basic Plant

2025-01-15T02:04:34Z

Halicade: Updating supported version number

{{DISPLAYTITLE:Basic Plant}}
{{BackToTutorials}}

This is a basic RimWorld mod tutorial for the purpose of creating a custom plant. We will also use the plant matter gathered from this custom plant in a later tutorial.

== Goals ==
In this tutorial you will:

* Create [[Modding_Tutorials/ThingDef|ThingDef]]s for a '''new plant''': theragold, a genetically modified cultivar of marigolds with both nutritional and medicinal benefits
* Learn how to use '''XML inheritance''' to share data between multiple [[Modding_Tutorials/ThingDef|ThingDef]]s
* Assign '''custom mature and immature plant textures''' to your new plant
* '''Add your new plant to existing vanilla and modded biomes'''
* Create a [[Modding_Tutorials/ThingDef|ThingDef]] for a '''new raw food''' item
* Create a new [[Modding_Tutorials/RecipeDef|RecipeDef]] to '''craft herbal medicine''' using this new item

== Recommended Reading ==
* [[Modding_Tutorials/Mod_Folder_Structure|Mod Folder Structure]]
* [[Modding_Tutorials/XML_Defs|Defs]]
* [[Modding_Tutorials/MayRequire|MayRequire]]

== Sample Repository ==
[[File:ExamplePlant.png|none|border|link=https://github.com/Aelanna/ExamplePlant]]
A working implementation of this mod can be found [https://github.com/Aelanna/ExamplePlant in this GitHub repository]. You can use it to compare against your work or as a basis for modification!

== Folder Setup ==

First, you will want to create the files and folders necessary for this mod:

<source>
Mods
└ MyModFolder
├ About
│ ├ About.xml
│ └ Preview.png
├ Defs
│ ├ RecipeDefs
│ │ └ ExampleRecipe_Theragold.xml
│ ├ ThingDefs_Items
│ │ └ ExampleItem_Theragold.xml
│ └ ThingDefs_Plants
│ └ ExamplePlant_Theragold.xml
└ Textures
└ ExampleMod
├ ImmatureTheragold
│ └ ImmatureTheragold_a.png
├ Theragold
│ └ Theragold_a.png
└ RawTheragold.png
</source>

Please check out the [[Modding_Tutorials/Mod_Folder_Structure|mod folder structure guide]] for more information about individual folders.

=== About.xml ===

Your <code>About.xml</code> is used to identify your mod to RimWorld; please see [[Modding_Tutorials/About.xml|the About.xml reference page]] for more information. Be sure to replace "AuthorName" with your own name:

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<ModMetaData>




<packageId>AuthorName.ExamplePlant</packageId>


<name>Example Plant</name>


<author>AuthorName</author>



<modVersion>1.0</modVersion>




<supportedVersions>
<li>1.5</li>
</supportedVersions>


<description>This is an example melee weapon mod made for the RimWorld Wiki.</description>

</ModMetaData>
</source>

=== Sample Assets ===

You can use these as the example textures:

<div class="TwoColumnCollapsibleLayout">
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Mature Plant Texture</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:ExamplePlant_Theragold.png|none]]
</div>
</div>
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Immature Plant Texture</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:ExamplePlant_ImmatureTheragold.png|none]]
</div>
</div>
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Raw Food Item Texture</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:ExamplePlant_RawTheragold.png|none]]
</div>
</div>
</div>

== Instructions ==

=== 1. Create plant ThingDefs ===

Our first step is to create the XML that represents our new plant. Whenever possible, this is best accomplished by copying vanilla [[Modding_Tutorials/ThingDef|ThingDef]]s and modifying them; in this case we will use the three Defs that constitute the vanilla [[healroot]] as our starting point, as it is the most similar existing plant to what we want to create. The XML for healroot can be found in <code>Data/Core/Defs/ThingDefs_Plants/Plants_Cultivated_Farm.xml</code> and <code>Data/Core/Defs/ThingDefs_Plants/Plants_Wild_General.xml</code>.

In our own <code>ExamplePlant_Theragold.xml</code>, we'll have the following three ThingDefs:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>



<ThingDef ParentName="PlantBase" Name="TheragoldBase" Abstract="True">

</ThingDef>



<ThingDef ParentName="TheragoldBase">
<defName>ExamplePlant_Theragold</defName>
<label>theragold</label>

</ThingDef>



<ThingDef ParentName="TheragoldBase">
<defName>ExamplePlant_TheragoldWild</defName>
<label>wild theragold</label>

</ThingDef>

</Defs>
</source>

=== 2. Modify our copied ThingDefs ===

In order to differentiate our plant from healroot, we'll make the following changes:

==== <code>TheragoldBase</code> ====

By specifying <code>Abstract="True"</code> as an attribute, our base ThingDef will not actually be loaded on its own, however its fields will be inherited by ThingDefs that specify its <code>Name</code> as a parent via <code>ParentName="TheragoldBase"</code>. This will allow us to share field values between two or more ThingDefs without copying each one.

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<graphicData>
<texPath>ExampleMod/Theragold</texPath>
<graphicClass>Graphic_Random</graphicClass>
</graphicData>
</source>
| class="TutorialCodeTable-description" |
This defines the default mature graphic for our new plant. Graphic_Random is a graphicClass that must be pointed at a folder; this is used by most vanilla plants and allows you to have multiple textures for more visual variety.

In the specific case of plants, the texture will also be horizontally flipped at random for additional variety.
|-
| <source lang="xml">
<selectable>true</selectable>
</source>
| class="TutorialCodeTable-description" |
By default, plants that inherit from <code>PlantBase</code> are not selectable. This should be overridden if colonists can meaningfully interact with it in any way; the only vanilla plants that are not selectable are completely non-interactible plants such as grasses, shrubs, and anima and gauranlen grass.
|-
| <source lang="xml">
<plant>
<immatureGraphicPath>ExampleMod/ImmatureTheragold</immatureGraphicPath>
<growDays>8</growDays>
<dieIfLeafless>false</dieIfLeafless>
<harvestWork>400</harvestWork>
<harvestTag>Standard</harvestTag>
<harvestedThingDef>ExamplePlant_RawTheragold</harvestedThingDef>
<harvestYield>8</harvestYield>
<topWindExposure>0.1</topWindExposure>
<visualSizeRange>0.3~1.0</visualSizeRange>
<wildOrder>2</wildOrder>
<allowAutoCut>false</allowAutoCut>
</plant>
</source>
| class="TutorialCodeTable-description" |
The <code>plant</code> tag contains many properties and settings related to plants in RimWorld. The ones we specifically add or change here are the following:

<code>immatureGraphicPath</code> sets the texture used for this planet when it is immature (it cannot be harvested yet). This uses the same <code>graphicClass</code> as the main graphic data.

<code>growDays</code> represents the amount of time in whole days that it takes for this plant to mature. Note that since plants rest at night, the actual number of in-game days required will be longer than specified; this value will be used for the wild variant of our plant and we will override it for the cultivated version.

<code>harvestedThingDef</code> is the item that will be created when this plant is harvested. We will define it in a later step.

<code>harvestYield</code> is the amount of the <code>harvestedThingDef</code> that will be created when this plant is harvested. Note that the final yield will be affected by the pawn's Plant skill and stats.
|-
|}
</div>

==== <code>ExamplePlant_Theragold</code> ====

This will represent the cultivated variant of our new plant. We will start with the vanilla <code>Plant_Healroot</code> and modify the following:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<ThingDef ParentName="TheragoldBase">
</source>
| class="TutorialCodeTable-description" |
We will use our new custom abstract base instead of <code>HealrootBase</code> as the parent for this ThingDef.
|-
| <source lang="xml">
<defName>ExamplePlant_Theragold</defName>
</source>
| class="TutorialCodeTable-description" |
The <code>defName</code> of a ThingDef is its identity and must be globally unique across all mods and official content. It is strongly recommended that it is prefixed with a project or mod name, so in this case we will use "ExamplePlant_" as our prefix.
|-
| <source lang="xml">
<label>theragold</label>
</source>
| class="TutorialCodeTable-description" |
A ThingDef's label is its in-game name. Unless it is a proper name, it should be in lowercase so that it can be injected naturally into sentences that use it. RimWorld will automatically capitalize it as necessary if used in titles or as the start of a sentence.
|-
| <source lang="xml">
<description>Engineered by a long-forgotten glitterworld, theragolds are a genetically modified cultivar of marigolds intended for seeding on terraformed garden worlds. While not particularly efficient at either, theragolds can be eaten for nutrition or processed into various medicinal products. Its hardiness and relative ease of cultivation makes it a valuable secondary crop for frontier colonies.\n\nThis secondary cultivar of theragold is faster-growing but less hardy, and intended for cultivation by frontier colonies.</description>
</source>
| class="TutorialCodeTable-description" |
This is the full description of our plant as shown in the full stat card when being inspected.
|-
| <source lang="xml">
<plant>
<growDays>5</growDays>
<sowWork>250</sowWork>
<sowMinSkill>6</sowMinSkill>
<sowTags>
<li>Ground</li>
<li>Hydroponic</li>
</sowTags>
<purpose>Food</purpose>
</plant>
</source>
| class="TutorialCodeTable-description" |
We will add or override the following fields in our <code>plant</code> properties:

<code>growDays</code> for the cultivated variant is much shorter at 5 days. This is slower than rice but faster than potatoes, corn, or healroot. Factored in with its yield, this makes our new plant significantly less nutrition-efficient than any of the three core food crops.

<code>sowWork</code> is slightly more involved than the 170 for core food crops.

<code>sowMinSkill</code> of 6 is higher than any vanilla food crop but lower than healroot, which requires 8.

<code>sowTags</code> determine where this plant can be sown. Our new plant can be sown in the Ground or in Hydroponics, but cannot be down in Decorative locations such as flower pots.

<code>purpose</code> Unlike healroot, the primary immediate use for our plant is food.
|-
|}
</div>

==== <code>ExamplePlant_TheragoldWild</code> ====

This will represent the wild variant of our new plant. We will start with the vanilla <code>Plant_HealrootWild</code> and modify the following:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<ThingDef ParentName="TheragoldBase">
</source>
| class="TutorialCodeTable-description" |
We will use our new custom abstract base instead of <code>HealrootBase</code> as the parent for this ThingDef.
|-
| <source lang="xml">
<defName>ExamplePlant_TheragoldWild</defName>
</source>
| class="TutorialCodeTable-description" |
The <code>defName</code> of a ThingDef is its identity and must be globally unique across all mods and official content. It is strongly recommended that it is prefixed with a project or mod name, so in this case we will use "ExamplePlant_" as our prefix.
|-
| <source lang="xml">
<label>wild theragold</label>
</source>
| class="TutorialCodeTable-description" |
A ThingDef's label is its in-game name. Unless it is a proper name, it should be in lowercase so that it can be injected naturally into sentences that use it. RimWorld will automatically capitalize it as necessary if used in titles or as the start of a sentence.
|-
| <source lang="xml">
<description>Engineered by a long-forgotten glitterworld, theragolds are a genetically modified cultivar of marigolds intended for seeding on terraformed garden worlds. While not particularly efficient at either, theragolds can be eaten for nutrition or processed into various medicinal products. Its hardiness and relative ease of cultivation makes it a valuable secondary crop for frontier colonies.\n\nThis original cultivar of theragold is hardier but slower-growing than the modified variant intended for human cultivation and can be found growing wild in a variety of biomes.</description>
</source>
| class="TutorialCodeTable-description" |
This is the full description of our plant as shown in the full stat card when being inspected.
|-
| <source lang="xml">
<neverMultiSelect>false</neverMultiSelect>
</source>
| class="TutorialCodeTable-description" |
By default, plants will not be selected when the player band-box selects regions of the map. We want to override this behavior as wild theragold is both edible and has medicinal value.
|-
| <source lang="xml">
<plant>
<wildClusterRadius>4</wildClusterRadius>
<wildClusterWeight>80</wildClusterWeight>

<wildBiomes>


<TemperateForest>0.05</TemperateForest>
<TemperateSwamp>0.05</TemperateSwamp>
<BorealForest>0.16</BorealForest>
<Tundra>0.05</Tundra>
<ColdBog>0.05</ColdBog>




<AB_FeraliskInfestedJungle MayRequire="sarg.alphabiomes">0.05</AB_FeraliskInfestedJungle>

<AB_IdyllicMeadows MayRequire="sarg.alphabiomes">0.05</AB_IdyllicMeadows>


<ZBiome_AlpineMeadow MayRequire="zylle.MoreVanillaBiomes">0.05</ZBiome_AlpineMeadow>

<ZBiome_CloudForest MayRequire="zylle.MoreVanillaBiomes">0.05</ZBiome_CloudForest>

<ZBiome_DesertOasis MayRequire="zylle.MoreVanillaBiomes">0.05</ZBiome_DesertOasis>

<ZBiome_Grasslands MayRequire="zylle.MoreVanillaBiomes">0.05</ZBiome_Grasslands>

<ZBiome_Marsh MayRequire="zylle.MoreVanillaBiomes">0.05</ZBiome_Marsh>


<BiomesIslands_BorealIsland MayRequire="BiomesTeam.BiomesIslands">0.16</BiomesIslands_BorealIsland>

<BiomesIslands_TemperateIsland MayRequire="BiomesTeam.BiomesIslands">0.05</BiomesIslands_TemperateIsland>

<BiomesIslands_TemperateArchipelago MayRequire="BiomesTeam.BiomesIslands">0.05</BiomesIslands_TemperateArchipelago>

<BiomesIslands_TropicalIsland MayRequire="BiomesTeam.BiomesIslands">0.05</BiomesIslands_TropicalIsland>

<BiomesIslands_TropicalArchipelago MayRequire="BiomesTeam.BiomesIslands">0.05</BiomesIslands_TropicalArchipelago>

<BiomesIslands_TundraIsland MayRequire="BiomesTeam.BiomesIslands">0.05</BiomesIslands_TundraIsland>

<BiomesIslands_TundraArchipelago MayRequire="BiomesTeam.BiomesIslands">0.05</BiomesIslands_TundraArchipelago>

<BMT_ChromaticOasis MayRequire="BiomesTeam.Oasis">0.2</BMT_ChromaticOasis>

</wildBiomes>
</plant>
</source>
| class="TutorialCodeTable-description" |
<code>wildBiomes</code> is the only critical addition here for the wild variant of our plant. This determines the biomes in which our plant can naturally spawn, as well as the ecosystem weight within those biomes, which we will match to the weight of healroot. While this can also be accomplished by using [[Modding_Tutorials/PatchOperations|PatchOperations]], using the <code>wildBiomes</code> tag is far easier.

In addition to vanilla biomes, we also have optional compatibility entries for several popular biome mods. These examples use [[Modding_Tutorials/MayRequire|MayRequire]] to safely disable themselves if the specified mod is not loaded, and have been listed here with their authors' permission.

Note that this is not an exhaustive list of either vanilla biomes nor the modded biomes in their respective mods; these are the ones that our plant should plausibly appear in and individual choices are subject to creative liberty.
|-
|}
</div>

=== 3. Create a raw food ThingDef ===

Now, we will create a new ThingDef to represent the raw food item harvested from our new plant. As before, we can and should copy an existing vanilla ThingDef as a starting point; in this case, we can copy <code>RawRice</code>, <code>RawPotatoes</code>, or <code>RawCorn</code> from <code>Data/Core/Defs/ThingDefs_Items/Items_Resource_RawPlant.xml</code>:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>


<ThingDef ParentName="PlantFoodRawBase">

</ThingDef>

</Defs>
</source>

==== Modifying the ThingDef ====

This will represent the wild variant of our new plant. We will start with the vanilla <code>Plant_HealrootWild</code> and modify the following:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<defName>ExamplePlant_RawTheragold</defName>
</source>
| class="TutorialCodeTable-description" |
The <code>defName</code> of a ThingDef is its identity and must be globally unique across all mods and official content. It is strongly recommended that it is prefixed with a project or mod name, so in this case we will use "ExamplePlant_" as our prefix.
|-
| <source lang="xml">
<label>theragold flowers</label>
</source>
| class="TutorialCodeTable-description" |
A ThingDef's label is its in-game name. Unless it is a proper name, it should be in lowercase so that it can be injected naturally into sentences that use it. RimWorld will automatically capitalize it as necessary if used in titles or as the start of a sentence.
|-
| <source lang="xml">
<description>Raw theragold flowers. This can be cooked into meals or crafted into various medicinal products.</description>
</source>
| class="TutorialCodeTable-description" |
This is the full description of our item as shown in the full stat card when being inspected.
|-
| <source lang="xml">
<graphicData>
<texPath>ExampleMod/RawTheragold</texPath>
</graphicData>
</source>
| class="TutorialCodeTable-description" |
This is the texture we will use for our food item. Note that <code>PlantFoodRawBase</code> uses <code>Graphic_Single</code>, so we will point the <code>texPath</code> directly at the texture instead of at a folder.
|-
| <source lang="xml">
<comps>
<li Class="CompProperties_Rottable">
<daysToRotStart>30</daysToRotStart>
<rotDestroys>true</rotDestroys>
</li>
</comps>
</source>
| class="TutorialCodeTable-description" |
Our <daysToRotStart> will be set to 30, which will make it rot slower than raw fruits and vegetables, but faster than grains such as rice or corn.
|-
|}
</div>

=== 4. Create a medicine RecipeDef ===

Finally, we will create a new RecipeDef that will allow us to craft herbal medicine from raw matter harvested from our custom plant. Since there is no direct vanilla analogue to this recipe, we will be created it from scratch, starting in our <code>ExampleRecipe_Theragold.xml</code> file:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>


<RecipeDef>

</RecipeDef>

</Defs>
</source>

==== Filling in the RecipeDef ====

This will represent the wild variant of our new plant. We will start with the vanilla <code>Plant_HealrootWild</code> and modify the following:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<defName>ExamplePlant_Make_MedicineHerbal</defName>
</source>
| class="TutorialCodeTable-description" |
In addition to our mod prefix, vanilla naming convention -- including those for auto-generated crafting recipes -- is to prefix "Make_" onto the defName of the final product, so we will maintain the same general naming general convention to inform the nature of our custom RecipeDef.
|-
| <source lang="xml">
<label>make herbal medicine from theragold</label>
</source>
| class="TutorialCodeTable-description" |
For RecipeDefs, its label is what is shown in the Add Bill list for workbenches, so qualifying it with the primary ingredient can help differentiate it from other potential recipes for the same product.
|-
| <source lang="xml">
<description>Make herbal medicine from theragold flowers.</description>
</source>
| class="TutorialCodeTable-description" |
This is the full description of our recipe as shown in the full bill interface.
|-
| <source lang="xml">
<jobString>Making herbal medicine from theragold flowers.</jobString>
</source>
| class="TutorialCodeTable-description" |
This string is shown in a pawn's inspect pane when it is performing work on this recipe.
|-
| <source lang="xml">
<effectWorking>Cook</effectWorking>
</source>
| class="TutorialCodeTable-description" |
This specifies an EffecterDef that should be used while this recipe is being worked on. We will use the same one used for cooking meals.
|-
| <source lang="xml">
<soundWorking>Recipe_CookMeal</soundWorking>
</source>
| class="TutorialCodeTable-description" |
This specifies a SoundDef that should be sustained while this recipe is being worked on. We will also use the same sound effect used for cooking meals here.
|-
| <source lang="xml">
<workSkill>Cooking</workSkill>
</source>
| class="TutorialCodeTable-description" |
This specifies the primary skill associated with this recipe. This is the skill that will gain experience points when work is done on this recipe, as well as being the filtering skill used in the bill interface.
|-
| <source lang="xml">
<workAmount>300</workAmount>
</source>
| class="TutorialCodeTable-description" |
300 work matches the amount of work required for vanilla simple meals, and equates to approximately 5s of time at 100% work speed.
|-
| <source lang="xml">
<workSpeedStat>GeneralLaborSpeed</workSpeedStat>
</source>
| class="TutorialCodeTable-description" |
This is the StatDef used to determine how quickly a pawn performs the work required to complete this recipe.
|-
| <source lang="xml">
<recipeUsers>
<li>CraftingSpot</li>
<li>DrugLab</li>
</recipeUsers>
</source>
| class="TutorialCodeTable-description" |
Specifies the workbenches that this recipe can be performed at via their <code>defName</code>s. In our case, we want our recipe to be usable at both the vanilla crafting spot and drug lab.

Note that you can also accomplish this by using a [[Modding_Tutorials/PatchOperations|PatchOperation]] on the targeted workbenches, but this is usually the easier way to introduce a new recipe, especially if you are not targeting your own workbenches.
|-
| <source lang="xml">
<ingredients>
<li>
<filter>
<thingDefs>
<li>ExamplePlant_RawTheragold</li>
</thingDefs>
</filter>
<count>12</count>
</li>
</ingredients>
</source>
| class="TutorialCodeTable-description" |
The <code>ingredients</code> tag specifies the materials that will be consumed in the process of using this recipe. A full exploration of all possible ingredient options is outside the scope of this tutorial; in our case, we simply want to use 12 theragold flowers for each recipe instance.
|-
| <source lang="xml">
<fixedIngredientFilter>
<thingDefs>
<li>ExamplePlant_RawTheragold</li>
</thingDefs>
</fixedIngredientFilter>
</source>
| class="TutorialCodeTable-description" |
The <code>fixedIngredientFilter</code> specifies all possible ThingDefs that can be used to fulfill the ingredient requirements for this recipe. As with the ingredients list, an exploration of all possible filter options is outside the scope of this tutorial and in our case the only ingredient we will need is the aforementioned theragold flowers.
|-
| <source lang="xml">
<products>
<MedicineHerbal>1</MedicineHerbal>
</products>
</source>
| class="TutorialCodeTable-description" |
This specifies the items that should be produced by this recipe. Our goal is to produce a single herbal medicine for each instance of this recipe being performed.
|-
| <source lang="xml">
<skillRequirements>
<Crafting>2</Crafting>
</skillRequirements>
</source>
| class="TutorialCodeTable-description" |
Finally, we will put a low requirement of 2 Crafting skill needed to perform this recipe. Note that this entire tag can be omitted if you do not want a skill requirement at all.
|-
|}
</div>

=== 5. Done! ===

Your first plant is complete! Boot up RimWorld and you should be able to see and enable the "Example Plant" mod in your mod manager. You can then start a new game on an appropriate biome, use [[Development mode|dev mode tools]] to spawn the plant directly, or sow it in a growing zone with a sufficiently skilled colonist. Be sure to also check out the crafting recipe on the appropriate workbenches!

If you get any errors, be sure to check out the [[Modding_Tutorials/Troubleshooting|troubleshooting guide]] or join us on the '''#mod-development''' channel on the [https://discord.gg/rimworld RimWorld Discord server].

[[Category:Modding]]
[[Category:Modding tutorials]]

Modding Tutorials/Basic Ranged Weapon

2025-01-15T02:04:00Z

Halicade: Updating supported version number

{{DISPLAYTITLE:Basic Ranged Weapon}}
{{BackToTutorials}}

This is a basic RimWorld mod tutorial for the purpose of creating a simple ranged weapon using only XML. Be sure to check out the [[Modding_Tutorials/Basic_Melee_Weapon|basic melee weapon tutorial]] as well.

== Goals ==
* Create a new '''saw launcher''' item, a ranged weapon
* Give it a '''custom projectile''' with a '''custom damage type'''
* Give it '''custom melee and ranged sound effects'''

== Recommended Reading ==
* [[Modding_Tutorials/Mod_folder_structure|Mod Folder Structure]]
* [[Modding_Tutorials/XML_Defs|Defs]]
* [[Modding_Tutorials/ThingDef|ThingDef]]
* [[Modding_Tutorials/Basic_Melee_Weapon|Tutorial: Basic Melee Weapon]]

== Sample Repository ==
[[File:ExampleRangedWeapon.png|none|border|link=https://github.com/Aelanna/ExampleRangedWeapon]]
A working implementation of this mod can be found [https://github.com/Aelanna/ExampleRangedWeapon in this GitHub repository]. You can use it to compare against your work or as a basis for modification!

== Folder Setup ==

First, you will want to create the files and folders necessary for this mod:

<source>
Mods
└ MyModFolder
├ About
│ ├ About.xml
│ └ Preview.png
├ Defs
│ ├ DamageDefs
│ │ └ ExampleDamage_Ranged.xml
│ ├ SoundDefs
│ │ └ ExampleSounds_RangedWeapon.xml
│ └ ThingDefs
│ └ ExampleWeapons_Ranged.xml
├ Sounds
│ └ ExampleMod
│ ├ Example_SawLaunch.ogg
│ └ Example_SawMelee.ogg
└ Textures
└ ExampleMod
├ Example_SawBlade.png
└ Example_SawLauncher.png
</source>

Please check out the [[Modding_Tutorials/Mod_folder_structure|mod folder structure guide]] for more information about individual folders.

=== About.xml ===

Your <code>About.xml</code> is used to identify your mod to RimWorld; please see [[Modding_Tutorials/About.xml|the About.xml reference page]] for more information. Be sure to replace "AuthorName" with your own name:

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<ModMetaData>




<packageId>AuthorName.ExampleRangedWeapon</packageId>


<name>Example Ranged Weapon</name>


<author>AuthorName</author>




<supportedVersions>
<li>1.5</li>
</supportedVersions>


<description>This is an example ranged weapon mod made for the RimWorld Wiki.</description>

</ModMetaData>
</source>

=== Sample Assets ===

You can use these as the example assets:

<div class="TwoColumnCollapsibleLayout">
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Ranged Sound Effect</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:Example_SawLaunch.ogg|none]] ([[:File:Example_SawLaunch.ogg|link]])
</div>
</div>
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Melee Sound Effect</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:Example_SawMelee.ogg|none]] ([[:File:Example_SawMelee.ogg|link]])
</div>
</div>
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Projectile Texture</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:Example_SawBlade.png|none]]
</div>
</div>
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Weapon Texture</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:Example_SawLauncher.png|none]]
</div>
</div>
</div>

== Instructions ==

=== 1. Create the weapon ThingDef ===

Our first step is to create the XML that represents our new weapon. Whenever possible, this is best accomplished by first copying a vanilla [[Modding_Tutorials/ThingDef|ThingDef]] and modifying it; in this case we will use the vanilla [[pump shotgun]] as our starting point, as it is the most similar existing weapon to what we want to create. The XML for the pump shotgun can be found in <code>Data/Core/Defs/ThingDefs_Misc/Weapons/RangedIndustrial.xml</code>.

In our own <code>ExampleWeapons_Ranged.xml</code>, we'll add the following content:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>


<ThingDef ParentName="BaseHumanMakeableGun">

</ThingDef>

</Defs>
</source>

=== 2. Modify the weapon ThingDef ===

In order to differentiate our weapon from the vanilla pump shotgun, we'll make the following changes:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<defName>ExampleGun_SawLauncher</defName>
</source>
| class="TutorialCodeTable-description" |
The <code>defName</code> of a ThingDef is its identity and must be globally unique across all mods and official content. It is strongly recommended that it is prefixed with a project or mod name, so in this case we will use "ExampleGun_" as our prefix.
|-
| <source lang="xml">
<label>saw launcher</label>
</source>
| class="TutorialCodeTable-description" |
A ThingDef's label is its in-game name. Unless it is a proper name, it should be in lowercase so that it can be injected naturally into sentences that use it. RimWorld will automatically capitalize it as necessary if used in titles or as the start of a sentence.
|-
| <source lang="xml">
<description>A heavy industrial circular saw used for both construction and demolition.\n\nSome madman has modified this tool to allow its blades to be shot out at high velocity, rendering it a short-ranged but devastating weapon.</description>
</source>
| class="TutorialCodeTable-description" |
A ThingDef's description is used when inspecting the item's details.
|-
| <source lang="xml">
<graphicData>
<texPath>ExampleMod/Example_SawLauncher</texPath>
<graphicClass>Graphic_Single</graphicClass>
</graphicData>
</source>
| class="TutorialCodeTable-description" |
This is where define the texture of our weapon. Similar to how defNames must be unique across all mods, the <code>texPath</code> of our texture must be unique across all mods if we want to avoid an asset collision. We will use the folder <code>ExampleMod</code> as our "namespace".

For ranged weapons such as our saw launcher, the texture defined in our <code><graphicData></code> will be used for both items on the ground as well as the equipped weapon texture. The texture of the fired projectiles will be defined in a separate <code>ThingDef</code>.
|-
| <source lang="xml">
<costList>
<Steel>80</Steel>
<ComponentIndustrial>4</ComponentIndustrial>
</costList>
</source>
| class="TutorialCodeTable-description" |
Since our saw launcher is a more complex tool than the pump shotgun with more functionality, we will have it cost 80 [[steel]] and 4 [[components].
|-
| <source lang="xml">
<statBases>
<WorkToMake>15000</WorkToMake>
<Mass>9.9</Mass>
<AccuracyTouch>0.85</AccuracyTouch>
<AccuracyShort>0.80</AccuracyShort>
<AccuracyMedium>0.70</AccuracyMedium>
<AccuracyLong>0.56</AccuracyLong>
<RangedWeapon_Cooldown>1.8</RangedWeapon_Cooldown>
</statBases>
</source>
| class="TutorialCodeTable-description" |
Our saw launcher requires more time to craft than a pump shotgun, weighs far more, has lower accuracy at range, and has a longer recovery cooldown duration.
|-
| <source lang="xml">
<equippedStatOffsets>
<ConstructionSpeed>0.10</ConstructionSpeed>
</equippedStatOffsets>
</source>
| class="TutorialCodeTable-description" |
While there is no <code>StatDef</code> that specifically affects deconstruction speed, <code>ConstructionSpeed</code> does affect the speed at which colonists deconstruct buildings and is appropriate enough to justify our use of it. Our saw launcher will grant a 10% construction speed bonus to its wielder.
|-
| <source lang="xml">
<verbs>
<li>
<verbClass>Verb_Shoot</verbClass>
<hasStandardCommand>true</hasStandardCommand>
<defaultProjectile>ExampleBullet_SawBlade</defaultProjectile>
<warmupTime>1.2</warmupTime>
<range>12.9</range>
<soundCast>ExampleWeapon_SawLauncher</soundCast>
<soundCastTail>GunTail_Heavy</soundCastTail>
<muzzleFlashScale>0</muzzleFlashScale>
</li>
</verbs>
</source>
| class="TutorialCodeTable-description" |
The <code>verbs</code> list defines the ranged attacks available for a weapon. Here we will specifically modify the <code>defaultProjectile</code> to use a custom projectile that we will define later, increase the <code>warmupTime</code> to represent the awkwardness of its use as a weapon, lower its <code>range</code> to <code>12.9</code> to match the chain shotgun, change the <code>soundCast</code> to use a custom <code>SoundDef</code>, and reduce the <code>muzzleFlashScale</code> to 0.
|-
| <source lang="xml">
<tools>
<li>
<label>handle</label>
<capacities>
<li>Blunt</li>
</capacities>
<power>9</power>
<cooldownTime>2</cooldownTime>
</li>
<li>
<label>blade</label>
<capacities>
<li>Demolish</li>
</capacities>
<power>13</power>
<cooldownTime>2</cooldownTime>
<soundMeleeHit>ExampleWeapon_SawLauncherMelee</soundMeleeHit>
<soundMeleeMiss>ExampleWeapon_SawLauncher</soundMeleeMiss>
</li>
</tools>
</source>
| class="TutorialCodeTable-description" |
To better model our saw launcher's primary use as a demolition tool, we will change the <code>barrel</code> tool from the pump shotgun into a <code>blade</code> tool that utilizes the <code>Demolish</code> capacity to perform building-destroying attacks similar to a [[breach axe]]. Our saw will have a higher power but far slower cooldown, giving it a lower overall damage output that better suits its overall versatility.

Also note that we set custom <code>SoundDef</code> references for <code>soundMeleeHit</code> and <code>soundMeleeMiss</code>. We will create these two <code>SoundDef</code> entries in a later step.
|-
| <source lang="xml">
<recipeMaker>
<skillRequirements>
<Crafting>5</Crafting>
</skillRequirements>
<displayPriority>436</displayPriority>
</recipeMaker>
</source>
| class="TutorialCodeTable-description" |
Our saw launcher will have the same Crafting skill requirement as the pump shotgun, and we will place it just after the [[chain shotgun]] in the crafting recipe list.
|-
|}
</div>

=== 4. Create and modify the projectile ThingDef ===

Now we need to create the <code>ThingDef</code> that defines our weapon's projectile. Similarly to the weapon itself, we will copy the pump shotgun's <code>Bullet_Shotgun</code> projectile, which is immediately after the weapon's <code>ThingDef</code> in the same file:

<source lang="xml">

<ThingDef ParentName="BaseBullet">

</ThingDef>
</source>

Now, we will modify the following:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<defName>ExampleBullet_SawBlade</defName>
</source>
| class="TutorialCodeTable-description" |
Since the projectile itself is a <code>ThingDef</code> as well, it must similarly have a globally-unique <code>defName</code>. We must also make sure that we match our <code>defName</code> in the <code>verbs</code> of our weapon.
|-
| <source lang="xml">
<label>saw blade</label>
</source>
| class="TutorialCodeTable-description" |
While the <code>label</code> of our projectile is not shown in the weapon's stat card, it is visible if the player hovers over it with their mouse while it is in flight and the game is paused.
|-
| <source lang="xml">
<graphicData>
<texPath>ExampleMod/Example_SawBlade</texPath>
<graphicClass>Graphic_Single</graphicClass>
</graphicData>
</source>
| class="TutorialCodeTable-description" |
In the <code>graphicData</code> for our projectile, we will specify the texture used for the projectile in flight.
|-
| <source lang="xml">
<projectile>
<damageDef>ExampleDamage_Saw</damageDef>
<damageAmountBase>25</damageAmountBase>
<stoppingPower>1.5</stoppingPower>
<armorPenetrationBase>0.19</armorPenetrationBase>
<speed>55</speed>
</projectile>
</source>
| class="TutorialCodeTable-description" |
Here we will specify the various values related to the damage dealt by this projectile upon impact. We will be using a custom <code>damageDef</code>, and we want our saw blade to deal higher base damage and slightly higher armor penetration, while having much lower stopping power.
|-
|}
</div>

=== 5. Create and modify a DamageDef ===

Next, we need to create a custom <code>DamageDef</code> for our custom projectile, because none of our vanilla options are entirely accurate or appropriate for our use case. Unlike our previous two <code>ThingDef</code> entries, we will create this one entirely from scratch since it will be relatively simple. We will start by creating the following in our <code>ExampleDamage_Ranged.xml</code> file:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>


<DamageDef ParentName="Arrow">



</DamageDef>

</Defs>
</source>

The reason we want to use <code>Arrow</code> as our parent is because the vanilla <code>Arrow</code> damage type already does most of what we want: it is a ranged damage type for purposes of shield belt penetration, it inflicts <code>Cut</code> injuries, and it is opposed by <code>Sharp</code> armor. This means we only have to add the following overrides to customize our new damage type:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<defName>ExampleDamage_Saw</defName>
</source>
| class="TutorialCodeTable-description" |
As always, we need to ensure our <code>defName</code> is unique amongst all <code>DamageDef</code> entries, so we will prefix it with "ExampleDamage_".
|-
| <source lang="xml">
<label>saw</label>
</source>
| class="TutorialCodeTable-description" |
This label will be seen in the damage breakdown for our weapon and projectile stat cards. All the usual recommendations for <code>label</code> fields apply here as well.
|-
| <source lang="xml">
<deathMessage>{0} has been sliced to death by a saw blade.</deathMessage>
</source>
| class="TutorialCodeTable-description" |
Our <code>deathMessage</code> is the text that will be shown in the combat log when a pawn is killed by our <code>DamageDef</code>. The <code>{0}</code> is an ''injection'' and will be replaced by the name of the pawn by RimWorld's grammar resolver system.
|-
|}
</div>

=== 6. Create custom SoundDefs ===

We're almost done! The last thing we need to do is to create the two custom <code>SoundDef</code> entries so our new weapon can have a unique melee and ranged attack sound effect. We will start by creating two <code>SoundDef</code> entries in our <code>ExampleSounds_RangedWeapon.xml</code> file:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>


<SoundDef>
<defName>ExampleWeapon_SawLauncher</defName>



</SoundDef>


<SoundDef>
<defName>ExampleWeapon_SawLauncherMelee</defName>



</SoundDef>

</Defs>
</source>

==== <code>ExampleWeapon_SawLauncher</code> ====

The following tags go into our <code>ExampleWeapon_SawLauncher</code> <code>SoundDef</code>:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<context>MapOnly</context>
</source>
| class="TutorialCodeTable-description" |
Setting <code>context</code> to <code>MapOnly</code> specifies that our sound effect should only play while the player's focus is on a regular map such as a settlement or quest map, and will stop playing if the player switches to the [[Menus#World|world map]].
|-
| <source lang="xml">
<subSounds>
<li>
<grains>
<li Class="AudioGrain_Clip">
<clipPath>ExampleMod/Example_SawLaunch</clipPath>
</li>
</grains>
<volumeRange>40~45</volumeRange>
<pitchRange>0.8940217~1.084783</pitchRange>
</li>
</subSounds>
</source>
| class="TutorialCodeTable-description" |
This is the meat of our <code>SoundDef</code>:

The <code>grains</code> list in our <code>SoundDef</code> determines the actual sound files that should be associated with it.

<code>volumeRange</code> determines the volume level at which our sound should play, which will be randomly within this range every time it is played. The exact volume range of each sound effect is not always the same, as different sound files may have different baseline volume levels; you may have to adjust this value based on whether it feels too quiet or loud in your testing.

<code>pitchRange</code> is used to randomize the exact pitch of the sound by pitch-shifting within the specified range each time it is played. This can give more perceived variation to your sounds, which helps to ensure that it does not sound repetitive.
|-
|}
</div>

==== <code>ExampleWeapon_SawLauncherMelee</code> ====

The following tags go into our <code>ExampleWeapon_SawLauncherMelee</code> <code>SoundDef</code>:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<context>MapOnly</context>
</source>
| class="TutorialCodeTable-description" |
As with the previous entry, we want this sound to only play on regular maps as well.
|-
| <source lang="xml">
<subSounds>
<li>
<grains>
<li Class="AudioGrain_Clip">
<clipPath>ExampleMod/Example_SawMelee</clipPath>
</li>
</grains>
<volumeRange>45~50</volumeRange>
<pitchRange>0.8940217~1.084783</pitchRange>
</li>
</subSounds>
</source>
| class="TutorialCodeTable-description" |
Our melee sound effect will be very similar to our ranged sound effect, but we will use a different grain clip and adjust the volume slightly higher, as the melee sound should be more impactful.
|-
|}
</div>

=== 7. Done! ===

Your first ranged weapon is complete! Boot up RimWorld and you should be able to see and enable the "Example Ranged Weapon" mod in your mod manager. You can then use [[Development mode|dev mode tools]] to spawn the weapon directly, or craft it at a [[Machining table|machining table]].

If you get any errors, be sure to check out the [[Modding_Tutorials/Troubleshooting|troubleshooting guide]] or join us on the '''#mod-development''' channel on the [https://discord.gg/rimworld RimWorld Discord server].

[[Category:Modding]]
[[Category:Modding tutorials]]

Modding Tutorials/Basic Melee Weapon

2025-01-15T02:03:25Z

Halicade: Updating version number

{{DISPLAYTITLE:Basic Melee Weapon}}
{{BackToTutorials}}

This is a basic RimWorld mod tutorial for the purpose of creating a simple melee weapon.

== Goals ==
* Create a new '''machete''' item, a simple melee weapon
* Give it a '''custom texture''' with a '''color mask'''
* Give it a simple '''stat bonus'''

== Recommended Reading ==
* [[Modding_Tutorials/Mod_folder_structure|Mod Folder Structure]]
* [[Modding_Tutorials/XML_Defs|Defs]]
* [[Modding_Tutorials/ThingDef|ThingDef]]

== Sample Repository ==
[[File:ExampleMeleeWeapon.png|none|border|link=https://github.com/Aelanna/ExampleMeleeWeapon]]
A working implementation of this mod can be found [https://github.com/Aelanna/ExampleMeleeWeapon in this GitHub repository]. You can use it to compare against your work or as a basis for modification!

== Folder Setup ==

First, you will want to create the files and folders necessary for this mod:

<source>
Mods
└ MyModFolder
├ About
│ ├ About.xml
│ └ Preview.png
├ Defs
│ └ ThingDefs
│ └ ExampleWeapons_Melee.xml
└ Textures
└ ExampleMod
├ ExampleWeapon_Machete.png
└ ExampleWeapon_Machete_m.png
</source>

Please check out the [[Modding_Tutorials/Mod_folder_structure|mod folder structure guide]] for more information about individual folders.

=== About.xml ===

Your <code>About.xml</code> is used to identify your mod to RimWorld; please see [[Modding_Tutorials/About.xml|the About.xml reference page]] for more information. Be sure to replace "AuthorName" with your own name:

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<ModMetaData>




<packageId>AuthorName.ExampleMeleeWeapon</packageId>


<name>Example Melee Weapon</name>


<author>AuthorName</author>




<supportedVersions>
<li>1.5</li>
</supportedVersions>


<description>This is an example melee weapon mod made for the RimWorld Wiki.</description>

</ModMetaData>
</source>

=== Sample Assets ===

You can use these as the example textures:

<div class="TwoColumnCollapsibleLayout">
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Weapon Texture</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:ExampleWeapon Machete.png|none]]
</div>
</div>
<div class="TwoColumnCollapsibleLayout-section">
<div class="TwoColumnCollapsibleLayout-subtitle">Texture Mask</div>
<div class="TwoColumnCollapsibleLayout-text">
[[File:ExampleWeapon Machete_m.png|none]]
</div>
</div>
</div>

== Instructions ==

=== 1. Create a ThingDef ===

Our first step is to create the XML that represents our new weapon. Whenever possible, this is best accomplished by first copying a vanilla [[Modding_Tutorials/ThingDef|ThingDef]] and modifying it; in this case we will use the vanilla [[gladius]] as our starting point, as it is the most similar existing weapon to what we want to create. The XML for the gladius can be found in <code>Data/Core/Defs/ThingDefs_Misc/Weapons/MeleeMedieval.xml</code>.

In our own <code>ExampleWeapons_Melee.xml</code>, we'll have the following content:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<Defs>


<ThingDef ParentName="BaseMeleeWeapon_Sharp_Quality">

</ThingDef>

</Defs>
</source>

=== 2. Modify the copied ThingDef ===

In order to differentiate our weapon from the vanilla gladius, we'll make the following changes:

<div class="TutorialTableWrapper">
{| class="TutorialCodeTable"
! XML !! Description
|-
| <source lang="xml">
<defName>ExampleMeleeWeapon_Machete</defName>
</source>
| class="TutorialCodeTable-description" |
The <code>defName</code> of a ThingDef is its identity and must be globally unique across all mods and official content. It is strongly recommended that it is prefixed with a project or mod name, so in this case we will use "ExampleMeleeWeapon_" as our prefix.
|-
| <source lang="xml">
<label>machete</label>
</source>
| class="TutorialCodeTable-description" |
A ThingDef's label is its in-game name. Unless it is a proper name, it should be in lowercase so that it can be injected naturally into sentences that use it. RimWorld will automatically capitalize it as necessary if used in titles or as the start of a sentence.
|-
| <source lang="xml">
<description>A broad blade meant for cutting vegetation in overgrown environments, machetes can be used as a broad-bladed combat knife in a pinch.</description>
</source>
| class="TutorialCodeTable-description" |
A ThingDef's description is used when inspecting the item's details.
|-
| <source lang="xml">
<graphicData>
<texPath>ExampleMod/ExampleWeapon_Machete</texPath>
<graphicClass>Graphic_Single</graphicClass>
<shaderType>CutoutComplex</shaderType>
</graphicData>
</source>
| class="TutorialCodeTable-description" |
This is where define the texture of our weapon, as well as some basic rendering settings. Similar to how defNames must be unique across all mods, the <code>texPath</code> of our texture must be unique across all mods if we want to avoid an asset collision. We will use the folder <code>ExampleMod</code> as our "namespace".

For melee weapons such as our machete, the texture defined in our <code><graphicData></code> will be used for both items on the ground as well as the equipped weapon texture. Since we want our weapon to only be colored by its materials on the blade and not have its grip color changed, we will be using a second image as a Texture Mask. This will require us to use <code>CutoutComplex</code> as our <code><shaderType></code>, so we will specify that here as well.
|-
| <source lang="xml">
<costStuffCount>40</costStuffCount>
</source>
| class="TutorialCodeTable-description" |
Since our machete is a more primitive tool than the gladius with a simple single-edged blade, we will have it cost 40 "stuff" instead of 50 like the gladius.

"Stuff" in RimWorld refers to the material it is made out of; just like the gladius, ours will be able to be made out of both Woody and Metallic stuff.
|-
| <source lang="xml">
<statBases>
<WorkToMake>10000</WorkToMake>
<Mass>0.75</Mass>
</statBases>
</source>
| class="TutorialCodeTable-description" |
Similarly, our machete is easier to make at only 10,000 work units instead of 12,000 and is lighter at 0.75kg instead of 0.85kg.
|-
| <source lang="xml">
<equippedStatOffsets>
<PlantWorkSpeed>0.10</PlantWorkSpeed>
</equippedStatOffsets>
</source>
| class="TutorialCodeTable-description" |
Historically, while machetes have been used as weapons, they are first and foremost a tool used for cutting plants and clearing overgrown vegetation. As such, we want our machete to increase the plant cutting speed of the pawn that wields it by 10%.
|-
| <source lang="xml">
<relicChance>1</relicChance>
</source>
| class="TutorialCodeTable-description" |
Unlike the gladius or longsword, machetes are generally not intended to be used as weapons and thus should not be used as often for an ideoligion's relics.
|-
| <source lang="xml">
<tools>
<li>
<label>handle</label>
<capacities>
<li>Blunt</li>
</capacities>
<power>9</power>
<cooldownTime>2</cooldownTime>
</li>
<li>
<label>point</label>
<capacities>
<li>Stab</li>
</capacities>
<power>14</power>
<cooldownTime>2</cooldownTime>
</li>
<li>
<label>edge</label>
<capacities>
<li>Cut</li>
</capacities>
<power>14</power>
<cooldownTime>2</cooldownTime>
</li>
</tools>
</source>
| class="TutorialCodeTable-description" |
A weapon's <code><tools></code> determines the types of [[Combat|melee attacks]] that can be made with it. Our machete should not be as effective as a gladius in combat, so we will reduce the power of its <code>point</code> and <code>edge</code> attacks from 16 to 14. The <code>handle</code> tool's power remains the same, as it is a secondary attack.
|-
| <source lang="xml">
<recipeMaker>
<researchPrerequisite>Smithing</researchPrerequisite>
<skillRequirements>
<Crafting>2</Crafting>
</skillRequirements>
<displayPriority>409</displayPriority>
</recipeMaker>
</source>
| class="TutorialCodeTable-description" |
Our machete is easier to craft than a gladius, and will only require a Crafting skill of 2 to make. We also want our machete to appear above the gladius in recipe lists, so we will change its <code><displayPriority></code> from 410 to 409.
|-
|}
</div>

=== 3. Done! ===

Your first melee weapon is complete! Boot up RimWorld and you should be able to see and enable the "Example Melee Weapon" mod in your mod manager. You can then use [[Development mode|dev mode tools]] to spawn the weapon directly, or craft it at an [[Electric_smithy|electric]] or [[Fueled_smithy|fueled smithy]].

If you get any errors, be sure to check out the [[Modding_Tutorials/Troubleshooting|troubleshooting guide]] or join us on the '''#mod-development''' channel on the [https://discord.gg/rimworld RimWorld Discord server].

[[Category:Modding]]
[[Category:Modding tutorials]]

Modding Tutorials

2025-01-14T03:04:31Z

Halicade: /* Uploading to Steam Workshop */

{| align=center
| {{Mods_Nav}}
|}
<hr>

This is the hub page for tutorials, guides, and reference materials for creating mods for RimWorld. If you are looking for instructions on how to use RimWorld, please check out the general [[Modding]] hub.

As RimWorld does not have a formal modding API, nearly all of the information here has been gathered and maintained by the modding community.

'''NEW: [[Modding_Tutorials/RimWorld_1.5_Mod_Updates|RimWorld 1.5 Mod_Updates]]''' - A work-in-progress list of changes datamined by the modding community in the current unstable version of RimWorld 1.5. '''THERE MAY BE ANOMALY SPOILERS, YOU HAVE BEEN WARNED.'''

-----

==About RimWorld==
RimWorld is a multi-platform game written on Unity 2019.4. However, the Unity Editor is not used for creating mods unless you are creating new shaders.

* [[Modding_Tutorials/Recommended_software|Recommended Software]] - Editors and other useful software for mod development
* [[Modding_Tutorials/Mod_Folder_Structure|Mod Folder Structure]] - Explore the basic folder structure of a mod
** [[Modding_Tutorials/About.xml|About.xml]] - About.xml identifies and describes your mod to RimWorld so that it can be loaded properly
* [[Modding_Tutorials/Defs|Defs]] - XML Definitions are used to define and configure content in a way that does not require compiling code
** [[Modding_Tutorials/MayRequire|MayRequire]] - MayRequire and MayRequireAnyOf are used to conditionally load Defs and list entries based on whether a DLC or other mod is loaded
* [[Modding_Tutorials/Localization|Localization]] - Define text strings used for translations and word lists used in name and text generation
* [[Modding_Tutorials/PatchOperations|PatchOperations]] - PatchOperations are used to modify XML Defs without overwriting them directly
* [[Modding_Tutorials/Sounds|Sounds]] - (Needs Rewriting) Adding sound files for mods
* [[Modding_Tutorials/Textures|Textures]] - How to create and add textures to mods

===XML Tutorials===

The following are step-by-step tutorials for creating basic content mods.

Basic Tutorials:
* [[Modding_Tutorials/Basic_Melee_Weapon|Basic Melee Weapon]] - How to create a basic melee weapon with a texture mask
* [[Modding_Tutorials/Basic_Ranged_Weapon|Basic Ranged Weapon]] - How to create a basic ranged weapon with custom sound effects
* [[Modding_Tutorials/Basic_Plant|Basic Plant]] - How to create a custom plant with both a cultivated and wild variant
* Custom Animal (Upcoming)
* Simple Building (Upcoming)
* Custom Workbench (Upcoming)
* Custom Drug (Upcoming)

Advanced Tutorials:
* Custom Faction (Upcoming)
* Custom Culture (Upcoming)
* Custom Trader Type (Upcoming)

===C# Guides===

C# is used to create and define custom game behaviors

* [[Modding_Tutorials/Decompiling source code|Decompiling Source Code]] - How to set up and use a decompiler to read vanilla game code
* [[Modding_Tutorials/Setting up a solution|Setting up a Solution]] - How to set up a solution for compiling a custom mod assembly
* [[Modding_Tutorials/Application_Startup|Application Startup]] - Describes the application startup process and the order in which game data is loaded
* Custom Consumable (Upcoming)
* Custom Overlays (Upcoming)

===Slightly Outdated===

* [[Modding_Tutorials/Plague_Gun_(1.1)|Plague Gun]] - This tutorial was created for RimWorld 1.0 but updated for 1.4. While the exact content is obsolete as you can now accomplish the same result with purely vanilla XML, it is still useful as a crash course for end-to-end mod creation and is here until newer tutorials can replace it.

===Uploading to Steam Workshop===
* You can upload your mod to Steam Workshop by enabling Development Mode from your game Options and then using the Upload option under the Advanced button in the vanilla mod manager.
* Note that in order to upload to Steam Workshop, you must own the game on Steam Workshop. Owning RimWorld on GOG or Epic will not work.
* Your Preview.png should be a 640x360 or 1280x720 PNG and '''must''' be under 1MB. If it is too large, then your upload will be rejected with <code>Error : Limit Exceeded</code>
* If you get a <code>OnItemSubmitted Fail</code> error, make sure you close any programs that are targeting items in your mods folder. This can also mean that Steam Workshop is having some technical issues at the moment. If it keeps occurring, then the only thing to do is to wait a few hours for it to clear up.
* Steam mod descriptions don't use markdown, they use a variant of BBCode. Please check out the [https://steamcommunity.com/comment/Guide/formattinghelp Steam text formatting guide].

-----

'''Note:''' All of the above tutorials have been cleaned up and reviewed by the #mod-development team on the [https://discord.gg/rimworld RimWorld Discord] in cooperation with RimWorld Wiki staff editors. Please let us know before creating, adding, or making any major edits to the vetted tutorials and guides section!

==Outdated / Under Review==

The following tutorials are either out of date or in need of a rewrite. The information in them might be useful but may not be up to standard; please be aware of any potential inaccuracies until they can be addressed.

* [[Modding Tutorials/First Steps|First Steps and Some Links]]
* [[Modding Tutorials/Essence| Essence of Modding]]
* [[Modding Troubleshooting Tips and Guides]]
* [[Modding Tutorials/Testing mods|Testing Mods]]
** [[Modding Tutorials/Testing mods#Development mode|Development Mode]]
* [[Modding Tutorials/Sounds|Adding and Testing Sounds]]
* [[Modding Tutorials/Assets|Decompiling Texture/Sound Assets]]
* [[Modding Tutorials/Compatibility|Compatibility]]
* [[Modding_Tutorials/Distribution|Distribution]]
* [[Modding_Tutorials/Modifying defs|Modifying Defs]]
* [[Modding_Tutorials/Troubleshooting|Troubleshooting mods]]

(Redundant, need to be reviewed and consolidated or removed)
* [[Modding_Tutorials/Getting_started_with_mods|Getting Started With XML]]
* [[Modding_Tutorials/Xml_Adding_Weapons_Traits_Research|Adding a New Weapon, Trait and Research to the game]]
* [[Modding_Tutorials/Xml_Patches|Making Patches using Xml]]

===XML tutorials===

* [[Modding Tutorials/XML file structure|XML File Structure]]
* [[Modding Tutorials/XML Defs|Introduction to XML Defs]]
** [[Modding Tutorials/Compatibility with defs|XML Def Compatibility]]
** [[Modding Tutorials/ThingDef|ThingDef explained]]
** [[Modding Tutorials/Weapons Guns|Weapons_Guns.xml explained]]. Slightly dated.

===C# tutorials===
* [[Modding_Tutorials/Hello World|Hello World]]
* [[Modding_Tutorials/Writing custom code|Writing Custom Code]]
* [[Modding Tutorials/Linking XML and C#|Linking XML and C#]]
* [[Modding_Tutorials/Harmony|Alter Code at Runtime with Harmony]] - this is a best practice for modifying game code, replacing C# code injection to reduce Mod Conflicts
* [[Modding_Tutorials/Modifying classes|Adding fields and methods to classes]]
* [[Modding Tutorials/ModSettings|Mod settings]] - Add settings to your mod
* [[Modding Tutorials/DefModExtension|Def mod extensions]] - Add (custom) fields to Defs
* [[Modding Tutorials/Custom Comp Classes|Custom Comp Classes]] - A quick overview of what types of Comps there are, and what they're suited for.
* [[Modding_Tutorials/ThingComp|ThingComp]] - Learn all there is to know about ThingComps.
* [[Modding Tutorials/GameComponent|Components]] - GameComponents, WorldComponents, and MapComponents
* [[Modding_Tutorials/Def classes|Introduction to Def Classes]]
* [[Modding_Tutorials/Compatibility_with_DLLs|Using Harmony to optionally patch other mods for the sake of compatibility]]
* [[Modding Tutorials/TweakValue|TweakValues]] - Change values on the fly (handy for quick iteration!)
* [[Modding Tutorials/ExposeData|ExposeData]] - Save stuff
* [[Modding Tutorials/BigAssListOfUsefulClasses|The big ass list of useful classes]] - A non-exhaustive list of classes you'll use most
* [[Modding Tutorials/GrammarResolver|Grammar Resolver]] - PAWN_objective, PAWN_possessive? Find out what it all means here.
* [https://github.com/Mehni/ExampleJob/wiki ExampleJob] - Mehni's top to bottom breakdown of Jobs.
* [[Modding_Tutorials/ConfigErrors|Config Errors]] - Provide configuration issues to the user on startup.
* [[Modding Tutorials/DebugActions|Debug Actions]] - Call methods from the debug menu
* [https://www.arp242.net/rimworld-mod-linux.html Getting started with RimWorld modding on Linux]

===Art Tutorials===
* [https://spdskatr.github.io/RWModdingResources/artstyle Artstyle] - Officially unofficial guide to RimWorld's Artstyle
* [https://www.reddit.com/r/RimWorld/comments/5tn1pi/rimworldstyle_sprite_tutorials/ Ekksu's guide to creating RimWorld animals]
* [https://steamcommunity.com/sharedfiles/filedetails/?id=1114369188 ChickenPlucker's guide to creating apparel]
* [https://github.com/seraphile/rimshare/wiki/Colouring-in-Images Seraphile's guide to masks]

===Under Construction===

These are currently unfinished and need to be cleaned up or removed

* [[Modding Tutorials/Quests]]
* [[Modding Tutorials/Troubleshooting/Finding Exceptions]]

===Dangerously Outdated===

* [[RimWorld 1.3: XML Mod Creation]]
* [[Modding Tutorials/Assembly Modding Example|Assembly Modding]]
* [[Plague Gun (1.1)|The Plague Gun]] tutorial originally by Jecrell, updated to 1.1+.
* [[Modding Tutorials/Xenotype template]] originally by Ryflamer

* [[Modding Tutorials/Smelter]]
* [[Modding Tutorials/Items]]
* [[Modding Tutorials/Furniture]]

==External Links==
* [https://github.com/roxxploxx/RimWorldModGuide/wiki Roxxploxx's set of modding tutorials]
* [https://spdskatr.github.io/RWModdingResources/ RimWorld Modding Resources - A hub for guides, modders, practical tips]

[[Category:Modding]]
[[Category:Modding tutorials]]