ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-14 16:27:13 +03:00
Code Issues Projects Releases Wiki Activity

clarified docs around inara

Browse Source
This commit is contained in:
A_D 2021-08-17 19:41:08 +02:00
parent 6c7245ee3d
commit bb882d633a
No known key found for this signature in database
GPG Key ID: 4BE9EB7DF45076C4
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Killswitches.md
View File

@ -94,13 +94,16 @@ The current recognised (to EDMC and its internal plugins) killswitch strings are
| :------------------------------------------- | :---------------------: | :---------------------------------------------------------------------------------------- |
| `plugins.eddn.send` | eddn | Disables all use of the send method on EDDN (effectively disables EDDN updates) |
| `plugins.<plugin>.journal` | eddn, inara, edsm, eddb | Disables all journal processing for the plugin |
| `plugins.<plugin>.worker` | edsm, inara | Disables the plugins worker thread (effectively disables updates) (does not close thread) |
| `plugins.<plugin>.worker` | edsm, *inara | Disables the plugins worker thread (effectively disables updates) (does not close thread) |
| `plugins.<plugin>.worker.<eventname>` | edsm, inara | Disables the plugin worker for the given eventname |
| `plugins.<plugin>.journal.event.<eventname>` | eddn, inara, edsm | Specific events to disable processing for. |
Killswitches marked with `*` do **not** support modification of their values via set/redact/delete. And as such any match
will simply stop processing.
For `plugin.inara.worker`, events are checked individually later by the eventname version. Use that to modify individual
inara events
## File location
The main killswitch file is kept in the `releases` branch on the EDMC github repo. The file should NEVER be committed to