FAQ

<ConfigOverrides>
  <Mod GUID="gymmed.outward_game_settings">
    <Section Name="Enchanting Modifications">
      <Entry Key="EnchantingSuccessChance" Value="5" />
      <Entry Key="RequireRecipeToAllowEnchant" Value="false" />
      <Entry Key="UseRecipeOnEnchanting" Value="false" />
    </Section>
  </Mod>
  <Mod GUID="gymmed.outward_mods_communicator">
    <Section Name="Event Profiler">
      <Entry Key="EnableEventsProfiler" Value="true" />
      <Entry Key="InstantLogEventsProfileData" Value="true" />
    </Section>
  </Mod>
</ConfigOverrides>

## Settings file was created by plugin Outward Game Settings v0.0.1

## Plugin GUID: gymmed.outward_game_settings

[Enchanting Modifications]
## Allow enchanting only if enchantment is on character?

# Setting type: Boolean

# Default value: true

RequireRecipeToAllowEnchant = false

## Remove recipe after using it on enchanting?

# Setting type: Boolean

# Default value: true

UseRecipeOnEnchanting = false

## What is success chance(%) of enchanting?

# Setting type: Int32

# Default value: 50

# Acceptable value range: From 0 to 100

EnchantingSuccessChance = 5

## Play additional audio on enchanting failed/success?

# Setting type: Boolean

# Default value: true

PlayAudioOnEnchantingDone = true

using OutwardModsCommunicator.EventBus;
...
void Awake()
{
    ...
    // GUID is your plugin ID provided as a string
    // "EnchantmentMenu@TryEnchant" is the event name
    // ("menu", typeof(EnchantmentMenu)) defines your variable name and its type
    EventBus.RegisterEvent(GUID,  "EnchantmentMenu@TryEnchant", ("menu", typeof(EnchantmentMenu)));
    // you can add multiple variables and
    // add as many as you need like this:
    //EventBus.RegisterEvent("MyPluginId",  "MyClass@MyMethod", ("name", typeof(string)), ("health", typeof(int)));
    ...
}

using OutwardModsCommunicator.EventBus;
...
void YourMethod()
{
    ...
    // Add variable types and names
    var payload = new EventPayload
    {
        ["EnchantmentMenu"] = menu,
    };
    // Send event for subscribers to receive data
    EventBus.Publish(OutwardGameSettings.GUID,  "EnchantmentMenu@TryEnchant", payload);
}

using OutwardModsCommunicator.EventBus;
...
void Awake()
{
    ...
    // Provide other mod GUID
    // Provide event name
    // Provide method you want to execute
    EventBus.Subscribe("gymmed.outward_game_settings", "EnchantmentMenu@TryEnchant", OnTryEnchant);
}
private static void OnTryEnchant(EventPayload payload)
{
    if (payload == null) return;
    // try to retrieve passed event data
    EnchantmentMenu menu = payload.Get<EnchantmentMenu>("menu", null);
    // if event data is null log and stop execution
    if (menu == null)
    {
        Log.LogMessage("Mod gymmed.outward_game_settings event EnchantmentMenu@TryEnchant returned null for EnchantmentMenu");
        return;
    }
    // Lets log success
    Log.LogMessage($"{GUID} successfully communicated with gymmed.outward_game_settings mod and passed menu!");
}

using OutwardModsCommunicator.EventBus;
...
// We use harmony patch to execute code after each plugin is loaded
// and have already registered their events
[HarmonyPatch(typeof(ResourcesPrefabManager), nameof(ResourcesPrefabManager.Load))]
public class ResourcesPrefabManager_Load
{
    static void Postfix(ResourcesPrefabManager __instance)
    {
        // Log all registered events
        EventBusDataPresenter.LogRegisteredEvents();
    }
}