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 automatic execution in a structured and efficient manner.

Table of Contents

• Installation
• Usage
  • Creating Custom States
  • Generating Custom States
• Contributing
• License

Installation

1. Download and install BepInEx, if not already installed.
2. 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...");
    }
    
}

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

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/your-feature-name).
5. 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.

Changelog

[1.1.0] - 2024-08-05

Fixed Assemblies

Changed logic to be less prone to errors

[1.0.2] - 2024-08-03

Added better logging

[1.0.1] - 2024-08-01

Initial Release