Click or drag to resize
LaunchBox

Unbroken.LaunchBox.Plugins Namespace

The interfaces in this namespace all represent a particular plugin type that can be built for LaunchBox/Big Box.

Pick the interface that best matches what you're trying to achieve, and create a class that inherits from that interface. Then simply build your DLL, put it in the LaunchBox\Plugins folder (or the subsequent Plugins folder inside of a Big Box theme), and test it out!

The PluginHelper static class can be used to get access to LaunchBox data from within any plugin.

Also, please note that the Unbroken.LaunchBox.Plugins.Data.IGameBadge interface can be implemented as a plugin as well to add custom badges to the LaunchBox interface.

Classes
 ClassDescription
Public classPluginHelper Used to provide logic, state information, and data to LaunchBox and Big Box plugins.
Interfaces
 InterfaceDescription
Public interfaceIBigBoxThemeElementPlugin Implement this interface in order to add an element/control to a Big Box theme, access the data, and accept user input.
Public interfaceIGameConfiguringPlugin Implement this interface in order to handle specific game configuration events in LaunchBox and Big Box. Added in LaunchBox and Big Box 11.0-beta-3.
Public interfaceIGameLaunchingPlugin Implement this interface in order to handle specific game launching events in LaunchBox and Big Box. Added in LaunchBox and Big Box 9.2-beta-3.
Public interfaceIGameMenuItemPlugin Implement this interface in order to add a game-specific menu item to the right-click menu in LaunchBox and/or the game details menu in Big Box.
Public interfaceIGameMultiMenuItemPlugin This plugin is similar to IGameMenuItemPlugin. The primary exceptions being that this interface allows you to create multiple menu items, and supports menu nesting
Public interfaceISystemEventsPlugin Implement this interface in order to handle system-wide events in LaunchBox and Big Box.
Public interfaceISystemMenuItemPlugin Implement this interface in order to add a non-game-specific menu item to the Tools menu in LaunchBox and/or the System menu in Big Box.