Magellan-Logo

[EN] [DE]

Home

Download
Magellan 2.x ·  
Magellan 1.x ·  

Feedback & Support

F.A.Q.

Dokumentation

Plugins
Alliance Plugin ·  
ExtCmds Plugin ·  
FoW-Update Plugin ·  
Lighthouse Plugin ·  
MapCleaner Plugin ·  
MapEdit Plugin ·  
MapIcons Plugin ·  
MemWatch Plugin ·  
Statistics Plugin ·  
Teacher Plugin ·  

Tools
Console Merger ·  

JavaDoc

Fehler melden

SourceForge

Plugins

Plugins sind externe Module oder Erweiterungen, die sich in den Magellan Client einklinken und erweiterte Funktionen anbieten, die es so in Magellan nicht gibt.

Uns sind folgende Plugins bis dato bekannt:

Die Installation der meisten Plugins ist denkbar einfach. Jedes Plugin wird genauso wie Magellan als Installer JAR ausgeliefert. Wenn der Installer nach einem Installationspfad verlangt, nennt man ihm einfach den Pfad, in dem Magellan installiert ist. Der Installer prüft dann die vorhandene Magellan Version und installiert dann das Plugin an geeigneter Stelle. Nach dem nächsten Neustart von Magellan wird automatisch das Plugin erkannt und in den Client integriert.

Entwicklung von Plugins

Die Entwicklung von Plugins ist ebenfalls relativ einfach, vorausgesetzt man kennt sich in der Programmiersprache Java. Die Entwickler haben die bestehende Schnittstelle von Magellan 1.x erweitert. Man muss in seinem Projekt dann mindestens eine Klasse besitzen, die sich vom Interface magellan.client.extern.MagellanPlugIn ableitet und alle darin benötigten Methoden implementiert. Eine genaue Beschreibung für all die vielen Möglichkeiten des Clients findest Du in der API in den JavaDocs.

Hier nun eine kurze Beschreibung (HowTo) für den Installer.

Wir gehen davon aus, dass das Plugin ein eigenes Projekt in Eclipse ist. Das Magellan2 Projekt MUSS ausgecheckt sein. Die Verzeichnisstruktur des Plugin Projekts sollte idealerweise so aussehen:

- src
   - ...Source files...
- doc
   - LICENSE.txt
   - CHANGELOG.txt
   - ....
- etc
   - ...message properties...what ever
- lib
   - ...optionale Bibliotheken...
- build.installer.xml
- izpack-install.xml
- README.txt

In build.installer.xml sollten ein paar Variablen geändert werden:

Außerdem sollte man folgendes machen

In izpack-install.xml muss folgendes gemacht werden

Ja, das war's auch schon. Wenn man die beiden Dateien aus einem anderen Projekt kopiert, die Verzeichnisstruktur beibehält und die obigen Daten ändert, ist das eine Sache von 'ner knappen Minute. Gestartet wird das Target create-installer. Wenn man das macht, wird ein Verzeichnis release angelegt und darin ist das Plugin mit Installer.
ACHTUNG: Direkt im Hauptverzeichnis wird bei der Ausführung des Scripts auch ein JAR erzeugt, das ist aber nur der kompilierte Source des Plugins (kein Installer). Der befindet sich immer im Verzeichnis 'release'.