RICS Button System - Modder Guide vs 1.0.16 and newer

[ekudram]

RICS Button System - Modder Guide

Overview

RICS (Rimworld Interactive Chat Services) provides an extensible button system that allows modders to add their own buttons to both the main menu and quick-access toolbar.

Quick Start: Adding a Button

1. XML Definition

Create an XML file in your mod's Defs/ folder:

<Defs>
  <CAP_ChatInteractive.EnhancedChatInteractiveAddonDef>
    <defName>YourMod_YourButton</defName>
    <label>Your Button Label</label>
    <description>What this button does</description>
    
    <!-- Button Behavior -->
    <buttonType>DirectDialogButton</buttonType> <!-- or MenuButton, ToggleWindowButton -->
    
    <!-- For DirectDialogButton -->
    <dialogClass>YourNamespace.YourDialogClass</dialogClass>
    
    <!-- For MenuButton -->
    <menuClass>YourNamespace.YourMenuClass</menuClass>
    
    <!-- For ToggleWindowButton -->
    <windowClass>YourNamespace.YourWindowClass</windowClass>
    
    <!-- Optional Settings -->
    <enabled>true</enabled>
    <displayOrder>100</displayOrder>
    <showInToolbar>true</showInToolbar>
    <hotkey>F4</hotkey>
    <iconPath>UI/YourMod/YourIcon</iconPath>
    <category>YourCategory</category>
    <requiredPermission>Moderator</requiredPermission>
  </CAP_ChatInteractive.EnhancedChatInteractiveAddonDef>
</Defs>

[ekudram]

RICS Button Integration Guide

Quick Start: Adding a Settings Button

Add this to your mod's startup code:

[StaticConstructorOnStartup]
public static class MyMod_ButtonIntegration
{
    static MyMod_ButtonIntegration()
    {
        // Check if RICS is loaded
        if (ButtonUtils.IsRICSLoaded())
        {
            // Add a settings button for your mod
            ButtonUtils.AddModSettingsButton(
                modName: "My Awesome Mod",
                settingsDialogType: typeof(MyMod_Dialog_Settings),
                buttonLabel: "My Mod Settings",
                iconPath: "UI/MyMod/SettingsIcon", // Optional
                displayOrder: 1000
            );
        }
    }
}

[ekudram]

Either method works

XML is less C# code
Use one or the other.