Customizer Material Framework

For players:

This mod doesn't offer new features, it's a library for mod developers to simplify creation of new materials for the Customizer. You don't need to install it manually, SMM will install it automatically when needed. ___

For developers:

If your mod adds a new Customizer material for walls, foundations or roofs this mod will help integrate it with vanilla and other modded materials that register themselves with this mod. By default your material can paint only vanilla walls/foundations/roofs and can not paint other modded materials, you have to update your mod to support other mods. This framework makes it so that any mod that uses it will be cross-compatible with others and no updates are required when a new material mod is released (as long as it uses this framework too).

You don't have to overhaul your mod in order to utilize this framework. You only need to add one method call to your Game Instance Module and your material will play nicely with any other modded material using this framework.

If everyone adopts this framework, it will be easier to support each other's mods. I encourage you to update your mod to include it.

If you're just starting to create a new material mod for walls, foundations or roofs, then this framework can also make it easier for you by automating a tedious step of filling the material map with references to every buildable of every other material. ___

How to use it:

1. Add this mod as a dependency in config

1. Your material's map (FGFactoryCustomizationDescriptorMaterial class) must contain entries for the default material of that type (FICSIT Orange Walls, FICSIT Default Foundations, FICSIT Default Roofs).

Other vanilla materials' entries may be missing, they will be added by this mod. Having them is not a problem but also there's no benefit in that (they will be re-added to the map anyways).

1. In your Game Instance Module in Post Initialization event:

• Use node Game Instance Module Manager > Find Module to retrieve the instance module of this mod by its reference CustomizerMaterialFramework
• Call its method RegisterWallMaterial, RegisterFoundationMaterial or RegisterRoofMaterial for each of your materials (if adding more than one). Pass it FGFactoryCustomizationDescriptorMaterial class of your material.
• Optionally, also pass it your CBG_... schematics and it will inject them into appropriate vanilla schematics to ensure that unlocks in the AWESOME Shop work. You can leave those pins empty if you handle unlocking of your recipes yourself.

___

Example mod:

You can study my Painted Metal Roof Material mod as an example for how to utilize this framework: https://ficsit.app/mod/SGPaintedMetalRoof