Alexius25.ChipLibrary 1.4.0

Chip Creation Guide

Reference Library

Chip Library is available either as a dll or through nuget. You need to reference it in your project to create custom chips.

dotnet add package Alexius25.ChipLibrary

Step 1

Make a class that inherits from ChipBase.cs:

public class TestChipMono : ChipBase
{
    public override bool UsesUpdate => true; // Set to true if you want to use the EquippedUpdate method
    
    public override void OnEquip()
    {
        // Call the base method
        base.OnEquip();
        
        // Code to execute when the chip is equipped
    }

    public override void OnUnequip()
    {
        // Call the base method
        base.OnUnequip();
        
        // Code to execute when the chip is unequipped
    }
    
    public override void EquippedUpdate()
    {
        // Code to execute every frame while the chip is equipped
    }
}

Notes:

• The ChipBase class itself inherits from MonoBehaviour, so you can use all Unity lifecycle methods (e.g., Start, Update) in your chip class.
• Override the OnEquip and OnUnequip methods to define behavior when the chip is equipped or unequipped.

Step 2

Create your item prefab:

public static class TestChip
{
    public static void Register()
    {
        var prefab = new CustomPrefab("TestChip", "Test Chip",
            "A test chip for demonstration purposes.");
        prefab.SetEquipment(EquipmentType.Chip);
        prefab.SetGameObject(new CloneTemplate(prefab.Info, TechType.ComputerChip));
        prefab.Register();

        // Register the Class you created previously with the techtype of the item
        ChipHandler.RegisterChip<TestChipMono>(prefab.Info.TechType);
    }
}

Note:

• You can put these two snippets in the same file if you prefer.

Step 3

Register your chip during the mod initialization:

using BepInEx;
using BepInEx.Logging;

namespace TestChip;

[BepInPlugin(PluginInfo.PLUGIN_GUID, PluginInfo.PLUGIN_NAME, PluginInfo.PLUGIN_VERSION)]
[BepInDependency("com.alexius25.chiplibrary")]
public class Main : BaseUnityPlugin
{
    private new static ManualLogSource Logger { get; private set; }

    private void Awake()
    {
        // set project-scoped logger instance
        Logger = base.Logger;
        
        TestChip.Register();
        Logger.LogInfo($"Plugin {PluginInfo.PLUGIN_GUID} is loaded!");
    }
}

Note:

• You need to add a dependency on ChipLibrary in your BepInEx plugin attributes. ([BepInDependency("com.alexius25.chiplibrary")]) and users have to install ChipLibrary for your mod to work.

Final Notes

• An Example mod is available on GitHub for reference.
• Available Debug Commands can help you test your chip in-game.
• Events are also available for more advanced functionality; see the Events Documentation for details.