Home - Vanilla-Expanded/VanillaExpandedFramework GitHub Wiki

Welcome to the Vanilla Expanded Framework wiki!

REWORKING THIS AT THE MOMENT!

The Vanilla Expanded Framework is a code library that adds some shared behaviours for several of the Vanilla Expanded series of mods. We have tried to document everything and to make it as modular as possible, so you can use it as a dependency in your own mods and access all these extra behaviours.

1.6 has brought a plethora of exciting changes for the Framework, making it more performant, more accessible and overall better than it ever was. We have created a short list of the changes here, so previous users can properly update their mods.

Right now, the Vanilla Expanded Framework has all these sub-libraries, which will be explained in detail in this Wiki:

Framework Core:

  • Abilities
  • Aesthetic scaling
  • Animal Behaviours: defines code to add new behaviours to animals
  • Apparels: defines code handling apparel
  • Buildings: defines code to modify the behaviour of buildings
  • Cooking: defines code for cooking, brewing, plants and fishing mods
  • Factions: defines code to tweak factions present in the world
  • Genes: defines code to add new behaviours to the genetics system added by the Biotech DLC
  • Global: code that is global or generic to the Framework, such as Toggleable patches
  • Graphics: defines code to modify the graphics of things in the game
  • Hediffs: defines code to modify Hediffs
  • Maps: defines code to modify the way maps work
  • Memes: defines code to add new behaviours to the ideoligion system added by the Ideology DLC
  • OptionalFeatures
  • Pawns: defines code that modified traits, thoughts and other pawn-related stuff
  • Planet: defines code modifying the behaviour of the world
  • Plants: defines code modifying the behaviour of plants
  • Sounds
  • Storyteller
  • Things
  • Weapons
  • Weathers

Multi Verb Combat Framework

Custom Structure Generation

  • Custom Structure Generation - KCSG: defines code used to generate custom structures. Can be used to generate quest sites, faction bases, biomes specific structures and world objects.

Pipe System

  • PipeSystem: defines code used to create custom pipes net

Legacy, removed systems, and how to swap from them:

How do I use the framework itself?

First of all, you'll need to add the framework as a dependency. You do this by adding this to your mod's about.xml file:

<modDependencies>
  <li>
    <packageId>OskarPotocki.VanillaFactionsExpanded.Core</packageId>
    <displayName>Vanilla Expanded Framework</displayName>
    <steamWorkshopUrl>https://steamcommunity.com/workshop/filedetails/?id=2023507013</steamWorkshopUrl>
    <downloadUrl>https://github.com/Vanilla-Expanded/VanillaExpandedFramework</downloadUrl>
  </li>
</modDependencies>

It is also recommended that you add in Steam this framework mod to your list of Required Items.

Then, you'll need to link the classes you want to use from your mod's XML code. Each class has a different way to use them, so we have divided this wiki into different pages explaining how to use most of them.

⚠️ **GitHub.com Fallback** ⚠️