SOD CustomStateInjector Miami
SOD.CustomStateInjector.Miami is a plugin that allows the addition of custom states and their generation processes through attributes for automatic execution.
About this mod Author’s original text
SODCustomStateInjectorMiami
CustomStateInjector.Miami (CSI Miami for short) is a plugin designed to allow the injection of custom generation steps during Shadows of Doubt map generation process. It uses attributes for ease of use.
Table of Contents
- Installation
- Usage
- Creating Custom States
- Generating Custom States
- Contributing
- License
Installation
- Download and install BepInEx, if not already installed.
- Place the SOD.CustomStateInjector.Miami.dll into the BepInEx/plugins folder of your game directory.
Usage
To use the plugin in your code, you must call it in your Plugin.Load() function like so
using SODCustomStateInjectorMiami;
using SODCustomStateInjectorMiami.Attributes;
namespace YourNamespace;
[BepInPlugin("com.yourname.yourplugin", "Your Plugin Name", "1.0.0")]
[BepInDependency("Cukeds.CustomStateInjector.Miami")] // Recommended
public class Plugin
{
public override void Load()
{
CustomStateInjector.InjectStates();
}
}
Creating Custom States
To create a custom state, define a class and annotate it with the CustomStateAttribute. The attribute requires two parameters:
- stepName: The name of the custom state.
- afterStepName: The name of the state after which the custom state should be executed. It can be either a regular step or a custom step
Single Step Example:
[CustomState("generateClubs", "generateCompanies")]
public static class CustomStateGenerator
{
[GenerateState("generateClubs")]
public static void GenerateClubs()
{
Plugin.Log.LogInfo("Generating clubs...");
}
}
Multiple Step Example
[CustomState("generateClubs", "generateCompanies")]
[CustomState("generateGuards", "generateClubs")]
[CustomState("generateFaces", "generateBlueprints")]
public static class CustomStateGenerator
{
[GenerateState("generateClubs")]
public static void GenerateClubs()
{
Plugin.Log.LogInfo("Generating clubs...");
}
[GenerateState("generateGuards")]
public static void GenerateGuards()
{
Plugin.Log.LogInfo("Generating guards...");
}
[GenerateState("generateFaces")]
public static void GenerateFaces()
{
Plugin.Log.LogInfo("Generating faces...");
}
}
Game's generation steps in the order they appear in the Enum
parsingFile
setupCityBoundary
generateDistricts
generateBlocks
generateDensity
generateBuildings
generatePathfinding
generateBlueprints
generateCompanies
connectRooms
generateCitizens
generateRelationships
gatherData
generateAirDucts
generateEvidence
generateInteriors
prepareCitizens
loadObjects
finalizing
savingData
loadState
preSim
loadComplete
Generating Custom States
Methods to generate the custom states must be annotated with the GenerateStateAttribute, which takes a single parameter:
- stateName: The name of the state to be generated.
The plugin automatically registers and validates these methods upon loading.
Contributing
- Fork the repository.
- Create a new branch (git checkout -b feature/your-feature-name).
- Commit your changes (git commit -am 'Add some feature').
- Push to the branch (git push origin feature/your-feature-name).
- Create a new Pull Request.
Needed dlls are included in the repository, but you may need to update them to the latest version.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.