OMSI Addon Manager

Aus OMSIWiki
Wechseln zu: Navigation, Suche

Inhaltsverzeichnis

Konzept und Entwicklung

Am logo.png
Ursprünglich war nur eine Art "Update-Erinnerer" für OMSI-Addons gedacht, doch daraus entstand während der Entwicklungsphase schnell eine Software, die die Installation, Verwaltung und Entfernung von OMSI-Addons gerade für Einsteiger erleichtert: Der OMSI Addon Manager, oder auch kurz: AM.

Am 20. Mai wurde die Version 1.0 nach einem längeren Betatest für die Öffentlichkeit freigegeben. Mit der Zeit kamen mit höheren Versionsnummern auch neue Funktionen hinzu: Einige Erweiterungen in der Skriptsprache erhielten Einzug, ein Benutzerzähler für die Addon-Entwickler, diverse Sicherheitsfeatures und eine automatische Prüfung auf zusätzlich benötigte Addons sind einige Beispiele.

Die letzte Version 1.2.3 wurde am 31. Juli veröffentlicht und kann im Aerosoft-Downloadcenter heruntergeladen werden.


Für die Benutzer

Benutzeroberfläche des Addon Managers (V1.2.3)
Für die Benutzer des Addon Managers ergeben sich einige Vereinfachungen, wenn Addons über diese Software installiert werden. In den folgenden Abschnitten werden diese Features kurz zusammengefasst.

Ein Addon herunterladen und installieren

Ein AM-kompatibles Addon wird in einer Datei mit der Endung *.ams heruntergeladen. Bei einigen Filehostern ist der Upload von *.ams nicht gestattet, da die Dateiendung unbekannt ist. Teilweise kann es also nötig sein, die *.ams-Datei erst aus einem anderen Archiv zu extrahieren.

Der AM enthält ein integriertes Downloadcenter, über das der Benutzer die Kategorien nach interessanten Addons durchstöbern kann. Klickt er dort auf den Download-Button, wird er direkt zur Website weitergeleitet, die das Addon anbietet.

Per Doppelklick auf die heruntergeladene AMS-Datei startet der Addon Importer (er ist Teil des AM), der den Benutzer durch den Installationsvorgang führt. Eventuell müssen Readme-Bedingungen akzeptiert werden. Bei einigen Addons können zudem zusätzliche Optionen gewählt werden, die ebenfalls installiert werden sollen.

Wenn der Addon-Entwickler dies vorgesehen hat, wird der Benutzer nach der Installation auch informiert, falls weitere Addons benötigt werden, die noch nicht installiert sind.

Anschließend ist das Addon fertig installiert und sollte einwandfrei funktionieren.

Updates für Addons

Je nach Konfiguration informiert der AM den Benutzer beim Systemstart mit einem Hinweisfenster in der rechten unteren Bildschirmecke, wenn Updates für OMSI-Addons verfügbar sind. Der Benutzer muss dann nur noch den Download-Button anklicken und gelangt zur Download-Website. Ab dort gleicht die Installationsroutine dem Vorgang, der im vorigen Abschnitt beschrieben wurde.

Addon deinstallieren

Die allermeisten Addons kann man auch per Mausklick wieder deinstallieren, wenn man das Interesse verloren hat oder nicht zufrieden ist. Es gilt aber zu beachten, dass der Addon-Entwickler dafür sorgt, dass diese Entfernung funktioniert. Bei Problemen ist daher im Regelfall der Autor des Addons zu benachrichtigen.

Weitere Features

Einige kleinere Features wurden noch nicht erwähnt. Beispielsweise können alle User dem Addon-Entwickler ihr Feedback schicken (wenn dieser es gestattet hat), indem sie unter "Meine installierten Addons" beim betreffenden Addon auf "Feedback senden!" klicken. Des Weiteren kann in den Einstellungen das Autostart- und Benachrichtigungsverhalten des AM gesteuert werden. Zu guter Letzt lässt sich auch der Pfad zu OMSI verändern für den Fall, dass man entweder mehrere OMSI-Installationen hat oder der Pfad irrtümlicherweise nicht richtig erkannt wurde.

Für die Entwickler

Auch für die Entwickler bieten sich einige Vorteile, wenn sie ihre Addons auch über den AM anbieten. Es wird jedoch immer empfohlen, auch eine konventionelle Installationsvariante bereitzustellen, da es auch Benutzer gibt, die den AM nicht nutzen möchten - ihnen soll deswegen aber kein Addon vorenthalten werden! Falls ein Addon-Entwickler keinen Standard-Download anbietet, kann die AMS-Datei auch in *.zip umbenannt werden. Je nach Komplexität des Addons muss man dann beim Entpacken allerdings vorsichtig sein mit der Ordnerstruktur!

Im Folgenden wird in Kürze erläutert, wie ein Entwickler sein Addon kompatibel zum AM machen kann.

Als Entwickler registrieren

Zu aller erst muss sich jeder interessierte Entwickler im AM Developer Access kostenlos registrieren. Er erhält dadurch Zugriff auf alle Administrationsfunktionen, die für den Betrieb mit AM benötigt werden, sowie auf die deutsche und englische Dokumentation. Die sollte er sich selbstverständlich erst einmal durchlesen.

Addon registrieren

Damit der Addon Manager jedes Addon weltweit einwandfrei erkennt, muss der Entwickler sein Addon zunächst im Developer Access registrieren. Details hierfür können in Kapitel 1 der Dokumentation gefunden werden.

Er erhält daraufhin eine eindeutige ID, mit der sein Addon identifiziert werden kann. Zugleich werden hier Informationen wie die neueste Verionsnummer, das Vorschaubildchen, die zugeordnete Kategorie im Downloadcenter oder die Beschreibung festgelegt.

AMS-Datei packen und veröffentlichen

Kleines Icon (64x64)
Großes Icon (250x64)
Der nächste logische Schritt ist die Erstellung der AMS-Datei. Dafür muss das sogenannten "Import-Skript" geschrieben werden, es ist eine einfache Textdatei und kann mit jedem beliebigen Editor bearbeitet werden. Eine Vorlage hierfür befindet sich im Programmverzeichnis des AM. Dieses Skript wird beim Buildvorgang in die AMS-Datei integriert und ermöglicht so die Steuerung der Addon-bezogenen Funktionen auf dem Ziel-PC. Festgelegt werden hier unter anderem die ID (s.o.), die Versionsnummer, die Readme-Texte und die Deinstallationsroutine. Es gibt noch viele weitere Möglichkeiten wie das Öffnen einer Website nach dem Import oder das Anzeigen wichtiger Hinweise, die mindestens 10 Sekunden für den Benutzer sichtbar bleiben, bevor er sie "wegklicken" kann.

Nach dem Skript müssen die Addon-Dateien und die Skriptdatei in eine AMS-Datei vereint werden. Dabei hilft der "AMS Builder", der beim AM standardmäßig mitinstalliert wird. Ist die AMS-Datei gepackt, kann sie hochgeladen und den Benutzern somit zugänglich gemacht werden.

Dem Addon-Entwickler ist es nun gestattet, mit einem der offizielle Kompatibilitätslogos zu zeigen, dass er sein Addon für den AM fit gemacht hat. Dabei stehen zwei Varianten zur Verfügung, eine kleine (64x64) und eine erweiterte (250x64). Beide sind rechts abgebildet.

HINWEIS: Emil hat ein sehr schönes und leicht verständliches Tutorial erstellt zum Thema "Wie mache ich ein Addon für den Addon Manager?" (siehe Weblinks). Jedem Einsteiger empfehle ich die Lektüre!

Ein Update bereitstellen

Bisher bedeutete die Nutzung des AM vor allem Zusatzarbeit für den Entwickler. Doch spätestens beim Updatevorgang zeigt sich, warum sich die Mühe in der Regel lohnt. Zunächst wird die neue AMS mit neuer Versionsnummer gepackt, wie im vorigen Abschnitt beschrieben. Nach dem Upload wird im Developer Access die Versionsnummer geändert.

Ab nun werden alle User weltweit beim nächsten Start des AM informiert, dass die aktuelle Addon-Version veraltet ist und eine neue zum Download bereitsteht. So erfahren alle User direkt von der neuen Version, nicht mehr oder weniger durch "Zufall". Fehler können so effektiv, schnell und weitreichend beseitigt werden.

Hilfe für Entwickler

Falls nach dem Lesen der Dokumentation noch Fragen offenbleiben sollten, können Addon-Entwickler ihre Fragen jederzeit im "Internal Help Forum" des Developer Access posten. Andere Addon-Autoren und ich (Entwickler des AM) helfen gerne weiter.


Weblinks

Meine Werkzeuge