Skip to content
juanosarg edited this page Nov 7, 2022 · 33 revisions

Welcome to the Vanilla Expanded Framework wiki!

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.

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

  • VFE Core: defines code shared by the Vanilla Factions Expanded series of mods
  • Item Processor: defines code for buildings that take 1 to 3 items as input and produce an output
  • Multi Verb Combat Framework - MVCF: allows use of attack verbs on races, hediffs, equipment and more
  • Animal Behaviours: defines code to add new behaviours to animals
  • Genes: defines code to add new behaviours to the genetics system added by the Biotech DLC
  • Apparel: defines code handling apparel
  • Cuisine: defines code for cooking, brewing, plants and fishing mods
  • Furniture: defines code shared by the Vanilla Furniture Expanded series of mods
  • Plants: defines code shared by the Vanilla Plants Expanded series of mods
  • 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.
  • PipeSystem: defines code used to create custom pipes net

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.

VFE Core

General Comp classes

General DefModExtensions

Item Processor

PipeSystem

Custom Structure Generation

Multi Verb Combat Framework - MVCF

Animal Behaviours

Genes

Apparel

Cuisine

Furniture

Plants

Deprecated

Clone this wiki locally