Es geht weiter!
Nach fast einem Jahr Pause geht es nun weiter mit dem Projekt OctoAwesome! Das NoobDevTv-Team versucht wieder regelmäßig Donnerstags um 19 Uhr einen OctoAwesome-Stream auf den Streaming-Kanäle von NoobDevTv: Twitch, Youtube und Mixer. zu veranstalten! Die neu produzierten Folgen der nun dritten Staffel werden ab jetzt auf deren Youtube-Kanal veröffentlicht.Extensions: Unterschied zwischen den Versionen
Manuel (Diskussion | Beiträge) (Beispiellink für Extension) |
Manuel (Diskussion | Beiträge) (Blöcke und Bäume ergänzt) |
||
| Zeile 15: | Zeile 15: | ||
* Entitytypen | * Entitytypen | ||
* Extender für Entitäten und die Simulation | * Extender für Entitäten und die Simulation | ||
| + | |||
| + | Für alle Erweiterungen wird ein Verweis auf <code>OctoAwesome.dll</code> benötigt. | ||
; Beispielimplementierung: | ; Beispielimplementierung: | ||
| Zeile 20: | Zeile 22: | ||
''Die Dokumentation zu den einzelnen Typen wird zur Zeit überarbeitet und wird in Kürze wieder online sein.'' | ''Die Dokumentation zu den einzelnen Typen wird zur Zeit überarbeitet und wird in Kürze wieder online sein.'' | ||
| − | |||
| − | ; | + | ===Definitonstypen=== |
| − | : OctoAwesome. | + | |
| − | + | ; Beispielimplementierungen: | |
| − | : [https://github.com/OctoAwesome/octoawesome/blob/ | + | : [https://github.com/OctoAwesome/octoawesome/blob/feature/entities/OctoAwesome/OctoAwesome.Basics/Definitions/Blocks/GrassBlockDefinition.cs Blocktyp (GrassBlockDefintion.cs) auf GitHub] |
| − | : [https://github.com/OctoAwesome/octoawesome/blob/ | + | : [https://github.com/OctoAwesome/octoawesome/blob/feature/entities/OctoAwesome/OctoAwesome.Basics/Definitions/Items/WauziEggDefinition.cs Item (WauziEggDefinition.cs) auf GitHub] |
| + | : [https://github.com/OctoAwesome/octoawesome/blob/feature/entities/OctoAwesome/OctoAwesome.Basics/Definitions/Trees/CactusTreeDefinition.cs Baumtyp (CactusTreeDefintion.cs) auf GitHub] | ||
| + | |||
| + | Mit einer Defintion wird dem Spiel ein neues Spielelement definiert. Dabei gibt es bisher drei mögliche Definitionstypen. | ||
| + | |||
| + | ====Blocktypen==== | ||
| + | Blocktypen erben implementieren die Basisschnittstelle <code>[http://doc.octoawesome.net/api/develop/OctoAwesome.IBlockDefinition.html IBlockDefinition]</code> oder erben von der Basisklasse <code>[http://doc.octoawesome.net/api/develop/OctoAwesome.BlockDefinition.html BlockDefinition]</code>. Der Vorteil der Basisklasse ist, dass sie bereits viel Standardcode enthält, der nicht in jeden Blocktyp kopiert werden muss. | ||
| + | |||
| + | Die Texturen des Blocks werden als Array von ''Asset-Referenzen'' (ohne Dateiendung) dem Spiel übergeben. Diese müssen als Bilddatei mit dem gleichen Namen (aber mit Dateiendung) als Eingebettete Ressource im Ordner Assets des jeweiligen Assemblies liegen. Als Unterordner müssen die Namespacenamensteile (jeder Punkt trennt ein Verzeichnis) ohne den Assemblynamen am Anfang verwendet werden. Hat z.B. ein <code>XYZBlock</code> den Namespacenamen <code>OctoAwesome.XYZ.Blocks</code> aus dem Assembly <code>OctoAwesome.XYZ</code> und verwendet die Textur <code>xyz</code>, so muss die Texturdatei den Pfad <code>${PROJEKTVERZEISCHNIS}/Assets/Blocks/xyz.png</code> haben. Alternativ können auch jpg oder bmp Dateien verwendet werden. | ||
| − | + | Die Methoden <code>GetProperties()</code> und <code>Hit()</code> müssen zwar implementiert werden, werden aber nicht vom Spiel verwendet. Das <code>Icon</code> und der <code>Name</code> werden im Spiel angezeigt, aber nicht zur internen Identifikation eingesetzt, können also lokalisiert werden. | |
| − | + | ====Baumtypen==== | |
| + | Als weiterer Verweis muss ein Verweis auf <code>OctoAwesome.Basics.dll</code> hinzugefügt werden. | ||
| − | + | Blocktypen implementieren entweder die Basisschnittstelle <code>[http://doc.octoawesome.net/api/develop/OctoAwesome.Basics.ITreeDefinition.html ITreeDefinition]</code> oder erben von der Basisklasse <code>[http://doc.octoawesome.net/api/develop/OctoAwesome.Basics.TreeDefinition.html TreeDefinition]</code>. | |
| + | Über <code>MinTemperature</code>, <code>MaxTemperature</code> und <code>GetDensity()</code> werden die Minimal-/Maximaltemperaturen für diesen Baum und die Häufigkeit des Auftretens ermittelt. In der Methode <code>Init()</code> können die benötigten Blocktypen herausgesucht werden und dann schließlich in der Methode <code>PlantTree()</code> zum "Pflanzen" eines Baumes an der angegebenen Position verwendet werden. | ||
| + | <!-- | ||
===Map Populators=== | ===Map Populators=== | ||
| Zeile 44: | Zeile 56: | ||
<code>Order</code> definiert die Reihenfolge, in der die Populatoren auf die Welt angewendet wird. In der Methode <code>Populate()</code> wird ein Chunk mit Dingen versehen. | <code>Order</code> definiert die Reihenfolge, in der die Populatoren auf die Welt angewendet wird. In der Methode <code>Populate()</code> wird ein Chunk mit Dingen versehen. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Map Generatoren=== | ===Map Generatoren=== | ||
Version vom 26. Februar 2017, 20:58 Uhr
| Diese Seite bedarf einer Überarbeitung, da sie unvollständig oder fehlerhaft ist. Näheres ist auf der Diskussionsseite angegeben. Hilf mit, sie zu verbessern, vermerke es auf der Diskussionsseite und entferne anschließend diese Markierung. Vielen Dank für Deine Mithilfe! |
Dieser Artikel beschreibt den neuen Lademechanismus aus dem Branch feature/entities
In diesem Artikel geht es um das Entwickeln von eigenen Erweiterungen für das Projekt OctoAwesome, nicht um das Verwalten dieser.
Inhaltsverzeichnis
Erweiterungen erstellen
Erweiterungen müssen in allen Fällen eine eigene .dll Dateien sein, die entweder direkt im Programmverzeichnis oder im Unterverzeichnis Plugins liegen müssen. Zur Entwicklung verwendet man am besten VisualStudio oder MonoDevelop. Der Namespace- und Assemblyname sollte im Format OctoAwesome.* oder OctoAwesome.Plugin.* sein. In einer einzelnen Erweiterung können mehrere erweiternde Typen definiert sein.
Eine Erweiterung ist eine Klasse, die von IExtension abgeleitet ist. Alle solchen Klassen werden beim Programmstart geladen, wenn der Nutzer sie aktiviert hat. Die Erweiterungsklasse enthält Informationen zur Erweiterung und Code für den Anwendungstart. Darüber können mit dem übergebenen IExtensionLoader einzelne Typen für das Spiel registriert werden:
- Definitions (= Blocktypen, Items und Baumtypen)
- Map Populators
- Map Generatoren (noch keine Auswahl möglich)
- Entitytypen
- Extender für Entitäten und die Simulation
Für alle Erweiterungen wird ein Verweis auf OctoAwesome.dll benötigt.
- Beispielimplementierung
- Extension.cs auf GitHub
Die Dokumentation zu den einzelnen Typen wird zur Zeit überarbeitet und wird in Kürze wieder online sein.
Definitonstypen
- Beispielimplementierungen
- Blocktyp (GrassBlockDefintion.cs) auf GitHub
- Item (WauziEggDefinition.cs) auf GitHub
- Baumtyp (CactusTreeDefintion.cs) auf GitHub
Mit einer Defintion wird dem Spiel ein neues Spielelement definiert. Dabei gibt es bisher drei mögliche Definitionstypen.
Blocktypen
Blocktypen erben implementieren die Basisschnittstelle IBlockDefinition oder erben von der Basisklasse BlockDefinition. Der Vorteil der Basisklasse ist, dass sie bereits viel Standardcode enthält, der nicht in jeden Blocktyp kopiert werden muss.
Die Texturen des Blocks werden als Array von Asset-Referenzen (ohne Dateiendung) dem Spiel übergeben. Diese müssen als Bilddatei mit dem gleichen Namen (aber mit Dateiendung) als Eingebettete Ressource im Ordner Assets des jeweiligen Assemblies liegen. Als Unterordner müssen die Namespacenamensteile (jeder Punkt trennt ein Verzeichnis) ohne den Assemblynamen am Anfang verwendet werden. Hat z.B. ein XYZBlock den Namespacenamen OctoAwesome.XYZ.Blocks aus dem Assembly OctoAwesome.XYZ und verwendet die Textur xyz, so muss die Texturdatei den Pfad ${PROJEKTVERZEISCHNIS}/Assets/Blocks/xyz.png haben. Alternativ können auch jpg oder bmp Dateien verwendet werden.
Die Methoden GetProperties() und Hit() müssen zwar implementiert werden, werden aber nicht vom Spiel verwendet. Das Icon und der Name werden im Spiel angezeigt, aber nicht zur internen Identifikation eingesetzt, können also lokalisiert werden.
Baumtypen
Als weiterer Verweis muss ein Verweis auf OctoAwesome.Basics.dll hinzugefügt werden.
Blocktypen implementieren entweder die Basisschnittstelle ITreeDefinition oder erben von der Basisklasse TreeDefinition.
Über MinTemperature, MaxTemperature und GetDensity() werden die Minimal-/Maximaltemperaturen für diesen Baum und die Häufigkeit des Auftretens ermittelt. In der Methode Init() können die benötigten Blocktypen herausgesucht werden und dann schließlich in der Methode PlantTree() zum "Pflanzen" eines Baumes an der angegebenen Position verwendet werden.
ResourcePacks
Wenn einem die Texturen einer Erweiterung nicht gefallen, muss man nicht sofort eine eigene Erweiterung erstellen. Häufig reicht dafür ein ResourcePack aus.
Ein ResourcePack ist ein eigener Unterordner im Ordner Resources/. In diesem Ordner kann optional eine Info-Datei mit dem Namen packinfo.xml angelegt werden, diese Informationen werden im Spiel angezeigt. Zum Aufbau dieser Datei siehe den Link unten.
Im Ordner des ResourcePacks werden zu ersetzende Resourcen in Unterordnern gespeichert. Die Ordnernamen entsprechen dabei den Namespacenamen der ladenden Komponente oder Klasse (mit / statt .).
- Beispieldateien
- packinfo.xml
- Ordnerstruktur
