GymMed-Mods_Communicator_Menu icon

Mods Communicator Menu

Menu to inspect mods communicator interactions and publish events.

Last updated 17 hours ago
Total downloads 6
Total rating 0 
Categories Utility UI
Dependency string GymMed-Mods_Communicator_Menu-0.0.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

GymMed-Chat_Commands_Manager-0.1.0 icon
GymMed-Chat_Commands_Manager

CLI library for Outward chat. Eliminates the need to build a separate UI to execute mod functions by providing an in-chat console.

Preferred version: 0.1.0
GymMed-Mods_Communicator-1.2.0 icon
GymMed-Mods_Communicator

Outward Mods Communicator enables seamless communication between mods through shared events and configuration syncing. It also lets users override any changes made by other mods, giving them full control over their settings.

Preferred version: 1.2.0
sinai-dev-SideLoader-3.8.4 icon
sinai-dev-SideLoader

API and Mod Development Toolkit for Outward.

Preferred version: 3.8.4
BepInEx-BepInExPack_Outward-5.4.19 icon
BepInEx-BepInExPack_Outward

BepInEx pack for Outward.

Preferred version: 5.4.19

README

Outward Mods Communicator Menu


Logo
A visual in-game menu interface for the Outward Mods Communicator event system. Browse, inspect, and publish events directly from a user-friendly UI.

Overview

Outward Mods Communicator Menu gives you a graphical interface to interact with the Mods Communicator event system. Instead of typing complex chat commands, you can use this menu to:

  • Browse all registered events from every mod
  • See which mods publish which events
  • View which mods subscribe to events
  • Send (publish) events with custom parameters
  • Toggle the menu with a hotkey or chat command

Requirements

This mod requires the following dependencies to be installed:

Dependency Purpose
Outward Mods Communicator Core event bus system
Chat Commands Manager Enables /MCMenu command
SideLoader Keybinding support
UniverseLib UI framework

How to Use

Opening the Menu

You can open the menu in two ways:

  1. Chat Command: Type /MCMenu in the in-game chat
  2. Keyboard Shortcut: Press your configured hotkey (needs to be set through settings)

Menu Tabs

The menu has three main tabs:

Publish Tab
Use this tab to send events to mods. Logo

How to publish an event:

  1. Enter the Mod GUID (e.g., gymmed.loot_manager_*)
2. Enter the **Event Name** (e.g., `AddLoot`) Logo
3. Click on **registered parameters** to add them, or create custom **dynamic parameters** Logo
4. Click **Publish** to send the event

Parameters:

  • Registered Parameters: Parameters that the event was originally designed to accept. Click on them to add to your payload.
  • Dynamic Parameters: Custom parameters not in the original event schema. Specify the name, type, and value.
Subscribers Tab

View which mods are listening to which events. This shows you:

  • Which mods have subscribed to events
  • What callback methods they use
  • The event names they're listening for
This helps you understand how different mods communicate and react to each other. Logo
Publishers Tab

See which mods have published events. This shows:

  • Mod GUIDs that have published events
  • The events they've sent
  • Payload data that was sent
Useful for debugging and understanding the event flow between mods. Logo

Features

Type Support

When entering parameter values, the menu supports various data types:

Type Example
Primitives string, int, float, bool, double
Enums Character.Factions.Bandits, ItemDrop.ItemData.ItemType.Weapon
Collections Lists and arrays of any supported type
Vectors Vector2, Vector3, Vector4

Input Methods

Parameters can be entered in two ways:

  1. Positional: Values entered in order matching the parameter definitions
  2. Named: Using --parameterName=value format

Validation

The menu provides real-time validation:

  • Warns if the event isn't registered
  • Shows parsing errors for invalid values
  • Displays success messages after publishing

Installation

Manual Install

  1. Create the directory: Outward\BepInEx\plugins\OutwardModsCommunicatorMenu\
  2. Extract the mod archive to an empty folder
  3. Copy the contents from the plugins\ folder to the directory you created
  4. Your folder should look like: Outward\BepInEx\plugins\OutwardModsCommunicatorMenu\OutwardModsCommunicatorMenu.dll
  5. Launch the game

Thunderstore Install

Install through the Thunderstore mod manager by searching for "Mods Communicator Menu".

Troubleshooting

Menu doesn't open:

  • Ensure all dependencies are installed
  • Check that the mod is loaded (look for log messages in BepInEx\LogOutput.log)

Events won't publish:

  • Verify the mod GUID and event name are correct
  • Check the parameter types match what the event expects

Parameters not showing:

  • Not all events have registered parameters
  • Use dynamic parameters to add custom data

Technical Details

The menu is built using:

  • UniverseLib: For creating the in-game UI panels
  • Event Bus: Connects to Outward Mods Communicator's event system
  • Harmony: For game method patching

Support

If you encounter issues or have questions:


If you like this mod, consider leaving a star on GitHub!