Inhaltsverzeichnis

1 Vorwort

Die Maratis3D Game Engine besitzt die M�glichkeit durch ein Game Plugin Standardkomponenten der Engine auszutauschen oder sogar eigene hinzuzuf�gen. Im Folgenden werde ich auf die ben�tigten Schritte zur Erstellung eines Game-Plugins in einer Linux Umgebung eingehen.

1.1 Markierungen und Code

Sourcecode wird wie folgt dargestellt:

Schreibweise von Pfaden: Pfad=>Zur=>Datei

Diese Pfadangaben sind m�glichst allgemein gehalten.

2 Voraussetzungen

Um ein Plugin unter Linux zu kompilieren ben�tigt man:

• gcc
• g++
• GNU make
• Maratis SDK

Au�erdem ben�tigt man einen Texteditor. Dieser darf jeder Texteditor sein, den Sie verwenden m�chten. Diese Tools sollten gr��tenteils in den Standardrepositories Ihrer Linux Distribution vorhanden sein wobei das offizielle Maratis SDK von der Maratis Downloadseite heruntergeladen werden muss. Die offizielle Maratis3D website ist unter http://www.maratis3d.org zu finden.

Um das Plugin in einem Maratis Projekt nutzen zu k�nnen muss zun�chst ein Projekt mithilfe des Maratis Editors, welcher dem SDK beiliegt, erstellt werden.

3 Das Game-Plugin

3.1 Was ist ein Game-Plugin?

Ein Maratis Game-Plugin ist eine Windows *.dll, Linux *.so oder OS X *.dylib Datei, welche Code f�r Behaviourals (Verhaltensweisen) und den Ersatz verschiedenster Maratis Standardkomponenten enthalten kann. Behaviourals sind Programmteile, welche einem Objekt des Spiels zugeordnet werden und mit diesem Objekt ein bestimmtes Verhaltensmuster erzeugen. Ein Beispiel f�r die Verwendung einer Verhaltensweise ist die Logik eines Computergegners in einem Spiel. Aus dem Plugin k�nnen auch Teile f�r das Lua Interface zur Verwendung freigegeben werden. Dadurch ist es m�glich rechenintensive Programmteile statt in ’langsamen’ Lua in ’schnellem’ C++ zu schreiben um damit Rechenzeit zu sparen und letztendlich die Systemanforderungen zu senken. Das Plugin muss in Maschinencode vorliegen weshalb der Sourcecode vor der Verwendung Kompiliert werden muss.

3.2 Standard Buildordner des Buildsystems

Bevor wir mit dem Plattform-spezifischen Teil des Buildsystems beginnen k�nnen m�ssen wir erst einmal eine einheitliche Ordnerstruktur schaffen um den Code sp�ter einfacher auf mehrere Plattformen portieren zu k�nnen. Daf�r wird der Ordner mit dem Namen ’_GamePlugin’ im Maratis Projektordner erstellt. Im neuen Ordner wird noch ein weiterer Unterordner mit dem Namen ’Sources’ erstellt, sodass folgende Ordnerstruktur vorhanden ist:

Projekt=>_GamePlugin=>Sources

3.3 Erstellung des Game-Plugins mit Linux

Das Plugin wird mit g++ als Compiler gebaut und das ganze gegen die Maratis Engine gelinkt. Verwendet wird folgende Makefile welche die richtigen Parameter f�r g++ zusammenbaut:

Die Pfade in LIBPATH und INCLUDES m�ssen gegebenenfalls an Ihr System angepasst werden. Dabei ist ’SDK’ der Pfad zur Maratis SDK. Allgemeing�ltig lautet der Pfad:

PfadZumSDK=>MCore=>Libs
PfadZumSDK=>MEngine=>Libs

f�r LIBPATH und

PfadZumSDK=>MCore=>Includes
PfadZumSDK=>MEngine=>Includes

f�r INCLUDES.

Der Pfad zum SDK kann auch ein relativer Pfad sein.

Nachdem diese Pfade eingetragen wurden kann man auch schon anfangen zu kompilieren. Dazu wechselt man mit dem Terminal in das Verzeichnis mit der Makefile Datei und gibt

in die Konsole ein. Daraufhin sollte die Kompilation beginnen wobei beim jetzigen Status nur Fehler ausgegeben werden, da noch keine Quelldateien f�r das Projekt erstellt wurden.

4 Die Makefile

Im vorigen Kapitel wurde eine Makefile f�r die Kompilation des Plugins erstellt und getestet. Hier m�chte ich nun die genaue Funktionsweise dieser Datei erl�utern.

4.1 Auswahl der Dateien

Eine Makefile ist dazu da alle Dateien eines Softwareprojektes zu kompilieren, zu linken und gegebenenfalls andere Operationen mit ihnen auszuf�hren. Dazu muss erst einmal herausgefunden werden, welche Dateien �berhaupt einbezogen werden m�ssen. Wie macht man das?

In vielen Makefile Tutorials findet man die Verwendung einer festgelegten Liste mit Dateinamen als Angabe der Quellen. In meiner Makefile wird dies jedoch anders gel�st indem alle wichtigen Dateien automatisch bei jedem Build erkannt werden und somit in die Kompilation eingebunden werden.

In diesen zwei Zeilen Code wird dies erledigt. Eingebunden werden alle Dateien mit den Endungen *.asm, *.c,. *.cpp und *.S. Wir ben�tigen zur Zeit nur *.cpp Dateien, daher k�nnen die Targets f�r die anderen Dateitypen vernachl�ssigt werden. Um die Dateinamen dem Compiler zu �bergeben brauchen wir den Namen der resultierenden Objektdatei mit der Endung *.o. Diese Namen werden aus den Namen der Sourcedateien erzeugt und in der Variable ’OBJS’ gespeichert.

4.2 Vorbereitung der Kompilation

Bevor das Plugin kompiliert werden kann muss der Compiler eingerichtet werden. Dies geschieht indem die n�tigen Konfigurations-Flags in Variablen zusammengefasst werden.

Hier wird zun�chst der verwendete Compiler festgelegt: F�r C-Dateien gcc und g++ f�r C++ Dateien. Wichtig f�r das Ergebnis des Linkers ist das Flag ’-fPIC’ welches dem Compiler mitteilt, den Maschinencode Positionsunabh�ngig zu produzieren. Das hat alleine den Zweck, dem Linker die Erstellung einer Linux Bibliothek als *.so Datei zu erm�glichen. In den Variablen ’LIBPATH’ und ’LIBS’ werden die ben�tigten Bibliotheken der Maratis SDK eingestellt, damit das Plugin auf Maratis spezifische Funktionalit�ten zur�ckgreifen kann. Au�erdem m�ssen die C und C++ Standardbibliotheken eingebunden werden damit der Zugriff auf Dinge wie die C++ String Klasse m�glich sind. Die Variable ’INCLUDES’ sorgt daf�r, dass innerhalb des C/C++-Codes einfach per #include-Direktive auf die Header der Maratis SDK zugegriffen werden k�nnen. Um die Nutzung dieser Pfade zu vereinfachen werden beide Variablen in ’ARG’ gespeichert.

4.3 Die eigentliche Kompilation

Die eigentliche Kompilation wird durch Programmiersprachen spezifische Make-Targets �bernommen.

1. all: Dies wird jedes mal aufgerufen, wenn das Projekt kompiliert wird. Es ruft f�r jede Quelldatei den entsprechenden Compiler (meist g++) auf um daraus die Datei Game.so zu bauen und in das Projektverzeichnis des Maratis Projektes zu kopieren.
2. %.o: %.cpp Hier werden alle *.cpp Dateien kompiliert.
3. %.o: %.c Hier werden alle *.c Dateien kompiliert.
4. clean: Mit dem clean Target werden alle erzeugten *.o Dateien gel�scht und so die Buildumgebung aufger�umt.

Man beachte die Verwendung der vorher definierten Konfigurationsvariable ’ARG’ um die Bibliotheken und die Objektdateien mit gcc zu einer *.so zu linken.

5 Verwendung

Die Verwendung des Plugins erfolgt automatisch, wenn die Datei ’Game.so’ im selben Ordner zu finden ist wie das Maratis Projekt. Das Plugin wird auch automatisch eingebunden, wenn das Projekt mithilfe des Editors ver�ffentlicht wird.

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Germany License.