mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2026-04-05 14:25:45 +00:00
add plugin readme, wildcardhandler
This commit is contained in:
parent
e04ba4b812
commit
8097b4bb12
4 changed files with 56 additions and 5 deletions
19
plugins/readme.md
Normal file
19
plugins/readme.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
## Eigene Plugins schreiben
|
||||
|
||||
Um ein eigenes Plugin zu schrieben, sollte man sich am besten zuerst einmal das Plugin `template` ansehen.
|
||||
Dies kann als Vorlage für das eigene Plugin genutzt werden.
|
||||
|
||||
### 1.) Informationen anpassen
|
||||
- Dateikopf anpassen
|
||||
- Namen des Plugins vergeben in der __init__ Methode `super().__init__("template")`
|
||||
|
||||
### 2.) Benötigte Methode überschreiben
|
||||
Die Plugin Basisklasse bietet einige Methoden, welche vom Plugin überschrieben werden können.
|
||||
- `onLoad()` wird direkt beim Import des Plugins ausgeführt
|
||||
- `setup()` wird vor jeder Ausführung gerufen
|
||||
- `fms()` wird bei einem FMS Paket ausgeführt
|
||||
- `pocsag()` wird bei einem POCSAG Paket ausgeführt
|
||||
- `zvei()` wird bei einem ZVEI Packet ausgeführt
|
||||
- `teardown()` wird nach jeder Ausführung gerufen
|
||||
- `onUnload()` wird beim Zerstören der Plugin Instanz zum Programmende ausgeführt
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue