Handbuch

STS Handbuch

Stellwerksim Handbuch

Webseiten-Werkzeuge


Seitenleiste



JavaScript ist deaktiviert!

stellwerksim:plugins

Plugins

Die Erweiterungsschnittstelle im Sim

Voraussetzungen

Zur Nutzung der Plugins muss deren Nutzung erst dem Simulator erlaubt werden. Dazu ist im laufenden Spiel (also im Simulator) im Menü Voreinstellungen der Menüpunkt „Pluginschnittstelle starten“ auszuwählen. Ist die Schnittstelle einmal aktiviert, ist sie das auch bei weiteren Starts.

Plugins nutzen

Plugins sind externe Programme, die sich mit dem laufenden Sim verbinden. Deshalb ist es zwingend nötig, dass erst der Sim gestartet wird, das Hauptfenster mit dem Gleisbild muss bereits geöffnet sein. Erst dann können Plugins sich mit dem Sim verbinden und sollten deshalb auch erst dann gestartet werden.

Wie man ein Plugin dann nutzt, hängt vom Plugin selbst ab und kann deshalb hier nicht beschrieben werden.

Pluginliste

Plugins schreiben

Plugins kann jeder selbst schreiben! Die Schnittstelle ist offen im Kapitel Plugin-Schnittstelle dokumentiert.

Grundsatz

Die Schnittstelle wird versucht abwärts kompatibel zu halten. Es existiert eine XML-Dokumentation wie auch ein JavaDoc. Letzteres ist in der Regel aktueller und detaillierter, da es direkt aus dem Schnittstellencode erzeugt wird. Etwas, das in beiden Dokumentationen nicht dokumentiert ist, kann nicht als gegeben vorausgesetzt werden und sich evtl. ändern.

Die Plugin-Schnittstelle ist nur für lesenden Zugriff gedacht. D.h. die Fernsteuerung ist nicht möglich und es ist nicht geplant, die je zu ermöglichen. STS soll ein Spiel für Menschen sein und nicht automatisch gespielt werden.

stellwerksim/plugins.txt · Zuletzt geändert: 2021/09/24 13:03 von js