Skip to content

Commit

Permalink
Update config.md (#1800)
Browse files Browse the repository at this point in the history
  • Loading branch information
MFransen69 authored Nov 28, 2024
1 parent eca514f commit 2977252
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/plugin/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ These are the options applicable to all plugins
| callsign | The callsign of the plugin. This is arbitrary and does not need to reflect any class names in the code<br /><br />Some people like to use reverse domain names for their plugin callsigns, although it's not a requirement | string | - | com.example.SamplePlugin |
| locator | The name of the library (.so/.dll) that contains the plugin code. | string | - | libSamplePlugin.so |
| classname | The name of the class to be instantiated when loading the plugin | string | - | SamplePlugin |
| startmode | Default start state of the plugin when loading (Unavailable, Deactivated, Activated).<br /><br />Setting to Activated will automatically start the plugin | enum | Deactivated | Activated |
| startmode | Default start state of the plugin when loading (Unavailable, Deactivated, Activated).<br /><br />Setting to Activated will automatically start the plugin | enum | Activated | Deactivated |
| resumed | When starting a plugin that supports suspend/resume (IStateControl), when activating the plugin start it in a resumed state instead of suspended | bool | false | true |
| webui | A plugin can be configured to act as a web server hosting generic files, typically used for hosting a UI.<br /><br />This config option sets the URL the server should run under, relative to the plugin callsign. Files will be served from a corresponding directory in the plugin's data dir.<br /><br />If not set, web server functionality disabled | string | - | UI |
| precondition | Array of subsystems that are preconditions for plugin activation[^1]. If any of the provided subsystems aren't marked as active, the plugin will not activate until those preconditions are met. | array | - | ["GRAPHICS"] |
Expand Down

0 comments on commit 2977252

Please sign in to comment.