Installing plugins
Plugins add integrations, pages, and flow nodes to MultiShock. Manage them from Manage plugins at the bottom of the sidebar.
The page has three tabs: Installed lists your plugins, Browse lists the plugins you can install, and Developer has tools for building plugins.
Install a plugin
- Open Manage plugins and switch to the Browse tab.
- Click Install next to the plugin.
- When MultiShock says a restart is required, click Restart now.
MultiShock checks each download before installing it. Plugins that don't support your version of MultiShock are marked Incompatible and can't be installed.
Install from a file
If someone gives you a plugin file:
- For a
.dllfile, click Install from file and pick it. MultiShock copies it, along with its matching.pdband.deps.jsonfiles, into the plugin folder. - For a
.mspluginfile, click Plugin folder and copy the file into the folder that opens. - For an unpacked plugin folder, copy the whole folder into Plugin folder.
Keep
plugin.json, the entry DLL, and the supplied dependencies together. Do not copy just the main DLL from a multi-file plugin.
Then restart MultiShock to load it. Only install plugins from people you trust: a plugin runs with the same access as MultiShock itself, including control of your shockers.
Keep only one installed copy of each plugin ID. An older loose DLL plus a new package or manifest folder can produce an installed twice error. Close the app before replacing or moving files. For file locations and backup, see files and backups; for package layout, see packaging and testing.
Show a plugin's pages
A new plugin's pages don't appear in the sidebar until you turn them on:
- In the Installed tab, click Configure on the plugin.
- Under Sidebar pages, switch each page you want to Shown.
The pages then appear under Plugins in the sidebar, and in the Ctrl+K search.
Configure a plugin
Click Configure on a plugin to see its settings under Plugin settings. Many plugins also have their own page, shown in the sidebar once you turn it on, where most of their setup happens. Plugins with a guided setup also have a Setup button.
Updates
When a newer version of an installed plugin is available, it is marked Update available, and the page header shows how many updates are waiting. Click Update in the Browse tab, then restart MultiShock.
Turn off or remove a plugin
- Switch a plugin Off to stop loading it without deleting it. This takes effect the next time MultiShock starts.
- Click Delete this plugin (the trash icon) to remove it.
Available plugins
- Image Detection: react to images, health bars, and text on screen.
- OBS Integration: control OBS Studio and react to its events.
- Random Nodes: random picks, chance gates, time, and media info.
- Speech To Text: react to spoken words and sentences.
- Throne Integration: react to Throne gifts.
- Twitch Integration: react to bits, subs, follows, raids, channel points, and chat.
- VRChat OSC: talk to VRChat avatars over OSC.
If a plugin doesn't load, see troubleshooting.
