larperCord

Plugin starter

Pick what your plugin should do and download a ready-to-edit .lua file. A plugin is one file: the comments at the top are its manifest (name, description, what it asks for) and the code below them is the plugin. The starter only offers what the plugin API really has, fills in the @capabilities line for you and keeps every call where the app allows it.

Where to put it

SystemFolder
Linux~/.config/larpercord/plugins/ (or $XDG_CONFIG_HOME/larpercord/plugins/)
Windows%APPDATA%\larpercord\plugins\

Then open Settings → Plugins (Ctrl+,) and click Reload. The plugin's card shows its name, what it asks for and any error, with file:line. If it uses the internet, nothing goes out until you approve the host on that card.

To see what the plugin prints (the starter writes a loaded line when it starts): on Linux, start larperCord from a terminal. On Windows the app has no terminal: turn on Settings → Advanced → Save debug log, click Reload in Settings → Plugins and open %LOCALAPPDATA%\larpercord\debug.log (the Open the log folder button takes you there). The debug log works on Linux too, at ~/.cache/larpercord/debug.log.

What the starter checks

The file is plain Lua: open it in any editor and change it from there. The API page has every function, and the plugin directory lists the plugins that come with the app, which are good examples to read.

Source of this page on GitHub