XML Format
Anstatt sofort einen DTD zu definieren (die Dinger kann eh kaum jemand lesen) arbeiten wir hier ein Beispiel-Dokument aus, und diskutieren darüber.
Generelles
Das Format soll es u.a. erlauben, einen Client zu entwickeln der weitestgehend Spiel-agnostisch ist, und trotzdem in der Lage moeglichst viel des Spielstandes fuer den Spieler sichtbar zu machen. Das bedeutet, dass man sich eher auf weniger Elemente festlegt, die ein Client dann jeweils in einer "Default" Implementation behandeln kann.
Die Hierarchie von "echten" Objekten, item, unit, region, alliance, faction, building, ship, usw. wuerde ich trotzdem gern als <item/>, <unit/>, usw. modellieren. Bei Schiffen kann man eventuell auf allgemeine Transporter verallgemeinern, aber fuer alle Objekte gilt, dass sie sich in ihrere Art und ihrere Darstellung stark genug voneinander unterschieden.
Einige Beispiele, wo weniger Elemente besser sind:
<region><resource ref="wood"/></region>
... ist besser als ...
<region><wood/></region>
Weil ein Client, der Ressourcen darstellen kann auch ohne Wissen um die Resource Holz einen Fallback machen kann ("wood" in den Localization-Ressourcen nach Icon + Name durchsuchen) als mit einem <wood/> Element, das er nicht kennt. Mal ganz abgesehen davon, dass jede neue Ressource eine Aenderung am DTD verursacht.
<ship><link role="captain" ref="unit_546"/></ship>
Hier kann der Regel-agnostische Client immerhin noch das Icon des referenzierten Objektes, seinen Schlüssel und evtl. den Namen, darstellen, selbst wenn er mit dem Begriff "Kapitän" nichts anzufangen weiß. Wenn er es natürlich kennt, kann er spielspezifisch darauf reagieren (und z.B. testen ob der Kapitaen der Schiff-betretenden Einheit ein HELFE setzt, o.ä.
IDs und Referenzen
- Elemente die wir mit IDs versehen verwenden das standardisierte xml:id Attribut.
Spielobjekte (Regionen, Einheiten, Schiffe, Burgen, ...)
... also Objekte die in Atlantis-ähnlichen Spielen eine id haben. Um diese im Spiel anzusprechen, erhalten sie zusätzlich zur xml:id das Attribut key. Das xml:id Attribut kann, muss aber nicht, den key als Teil der id verwenden.
Beispiele:
<unit xml:id="unit_raLf" key="raLf">... <ship xml:id="ship_12f4" key="12f4">... <unit xml:id="ddff556787u" key="enno">...
- Wird der XML-Report vom Server erzeugt, werden die xml:id vom Server vorgegeben.
- Wird der XML-Report aus einem anderen Format konvertiert, welches keine global eindeutigen ids hat (CR), dann sollte der client <elementname>_<key> als xml:id generieren.
- Referenzen auf diese Elemente sollten ein einheitliches Attribut verwenden, z.b. ref
<memberof ref="faction_bgz7"/>
Regelobjekte (Gegenstände, Talente, Resourcen, Rassen, Terrain ...)
... also mögliche Typen die üblicherweise in den Regeln definiert werden. Im Report wird, wenn überhaupt möglich, nur darauf referenziert.
Beispiel in der Regeldatei:
<itemtype xml:id="itemtype_wateroflife">... <skilltype xml:id="skilltype_perception">...
- Referenzen auf diese "Typ"-Elemente sollten ein einheitliches Attribut verwenden, z.b. type
- Elemente tragen nach Möglichkeit die Bezeichnung ihrer "Rolle". Wobei <item> den Besitz/vorhandensein eines Gegenstandes des Typ <itemtype> meint. Gleiches gilt für <skill>.
<items> <item type="itemtype_wateroflife">12</item> </items> <skills> <skill type="skilltype_perception"><level>12</level></skill> </skills>
- ggf. macht es sinn itemtype als item zu bezeichnen und das Halten eines Gegenstandes doch unter einem anderen element abzulegen. (z.b. hasitem) - meinungen gefragt ...
Lokalisierung
- Es sollte das Attribut xml:lang verwendet werden. Elemente die dieses Attribut erlauben, sollten generell auch mehrfach auftauchen dürfen. Problematisch ist der Umgang wenn man mehrfach die gleiche sprache angibt.
- Elemente die so etwas unterstützen könnten:
<name ...>... <descr ...>... <text ...>... <keytext ...>... <pattern ...>...
Datierung
Fürs erste haben wir uns gegen eine Datierung von einzelnen Elementen entschieden. Ein Report erhält daher global ein Datum, und gibt den Status zu diesem Datum wieder
Beispiel Report
Header und Serverinfos | |
<!DOCTYPE atlantis PUBLIC "-//PBEM//DTD Atlantis 1.0//EN" "http://eressea.de/atlantis-report.dtd"> <?xml version="1.0" encoding="UTF-8"?> <atlantis rules="eressea"> <server> <uri>mailto:eressea-server@eressea.kn-bremen.de</uri> <subject>ERESSEA BEFEHLE</subject> </server> |
|
Allianzen | |
<alliance id="alliance_1245" key="1245"> ??? <helpstatus set="59"/> <helpstatus ref="faction_1234" set="59"/> <helpstatus ref="alliance_badg" set="1"/> </alliance> |
|
Parteien | |
<faction id="faction_Lotr" key="Lotr">
<name>xxxxx</name>
<descr>dsfsf sdf sdf</descr>
<race ref="racetype.aquarians"/>
<magic><area>Gwyrrd</area></magic>
<culture>...</culture>
<status type="age">60</status>
<status type="points">12345</status>
<status type="avgpoints">10000</status>
<inventory>
<item type="birthdaycake">1</item>
</inventory>
|
|
Allianzen (HELFE Stati) | |
<helpstatus ref="faction_1234" set="59"/>
<diplomacy ref="faction_1234">
<state type="state_help_silver"/>
<state type="state_help_guard"/>
<state type="state_help_give"/>
<state type="state_help_defend"/>
<state type="state_help_attack"/>
<state type="state_forbid_trade"/>
<state type="state_forbid_recruit"/>
<state type="state_warn_nmr"/>
<state type="state_send_report"/>
</diplomacy>
|
|
Gruppen (wie in Eressea verwendet) | |
<unitgroup id="unitgroup.1234.Kapitäne">
<helpstatus remove="2"/>
<helpstatus ref="faction.gtzu" add="2"/>
</unitgroup>
<unitgroup id="unitgroup.1234.Matrosen" basegroup="unitgroup.1234.Kapitäne">
<helpstatus remove="1"/>
</unitgroup>
|
|
Messages | |
<message id="message_123456" type="msgtype_23423546">
<text xml:lang="de">
Die Nussschale (1234) segelt von Irgendwo (1,2) nach Nirgendwo
(99,99). Dabei wurden Ozean (1,3), Ozean (1,4) ... und Ozean
(98,99) durchquert.
</text>
<attribute name="ship"><shipref ref="ship_1234"/></attribute>
<attribute name="from"><regionref ref="region_653456"/></attribute>
<attribute name="to"><regionref ref="region_653567"/></attribute>
<attribute name="through">
<regionref ref="region_953456"/>
<regionref ref="region_68656"/>
...
<regionref ref="region_114562"/>
</attribute>
<message id="message_456346" type="msgtype_456902645">
<text xml:lang="de">
Die Nussschale (1234) wurde in Ozean (77,78) von Stürmen nach
Ozean (78,78) abgetrieben. Sie erlitt dabei 2% Schaden.
</text>
<attribute name="ship"><shipref ref="ship_1234"/></attribute>
<attribute name="from"><regionref ref="region_673256"/></attribute>
<attribute name="to"><regionref ref="region_322167"/></attribute>
<attribute name="damage"><int>2</int></attribute>
</message>
</message>
|
|
Messages (Alternative) | |
<message id="message_123456" type="msgtype_23423546">
<msgtext xml:lang="de">
Die <shipref name="ship" ref="ship_1234">Nussschale
(1234)</shipref> segelt von <regionref name="from"
ref="region_653456">Irgendwo (1,2)</regionref> nach <regionref
name="to" ref="region_653567">Nirgendwo (99,99)</regionref>.
Dabei wurden <msgfunc name="through" type="regions"><regionref
ref="region_953456">Ozean (1,3)</regionref>, <regionref
ref="region_68656">Ozean (1,4)</regionref>, ... und <regionref
ref="region_114562">Ozean (98,99)</regionref></msgfunc>
durchquert.
</msgtext>
</message>
|
|
Regionen | |
<region id="region.126788" type="terraintype.plain"> <coordinate x="14" y="27"/> <name>xxxxx</name> <descr>dsfsf sdf sdf</descr> |
|
Regionsresourcen | |
<resources>
<resource type="resourcetype.mallorntrees">50</resource>
<resource type="resourcetype.mallornsaplings">10</resource>
<resource type="resourcetype.laen">
<level depth="33">10</level>
<level depth="34">12</level>
</resource>
<resource type="resourcetype.silver">10000</resource>
<resource type="resourcetype.peasant">1000</resource>
<resource type="resourcetype.elvendear" quantity="many"/>
<resource type="resourcetype.elvendear">many</resource>
</resource>
</resources>
|
|
Handel | |
<trade amount="10">
<buy type="balm">5</buyitem>
<sell type="spice">35</sellitem>
<offer>
<get><item>balm</item><amount>1</amount></get>
<give><item>silver</item><amount>5</amount></give>
</offer>
</trade>
|
|
Einheiten | |
<unit id="unit_mag3" key="mag3">
<name ...>
<descr xml:lang="de">Er schützt die Region.</descr>
<descr xml:lang="en">He protects the region.</descr>
<descr type="private">
Botschafter (1234) ist ein parteigetarnter Spion der xxx
</descr>
<race ref="race_daemons">1</race>
<memberof ref="faction_Lotr"/>
<status type="guard"/>
<status type="fight">front</status>
<status type="health">wounded</status>
<status type="hungry"/>
<camouflage>
<memberof ref="faction_3243"/>
<race ref="race_aquarians"/>
<skilllevel>14</skilllevel>
</camouflage>
<magic area="Gwyrrd">
<spell type="spelltype.xxx"/>
<spell type="spelltype.xxy"/>
</magic>
<inventory>
<item type="itemtype.laen">14</item>
<item type="itemtype.wood">44</item>
</inventory>
<skills>
<skill type="skilltype.perception"><level>17</level></skill>
<skill type="skilltype.camouflage">
<level>17</level><days>4567</days>
</skill>
</skills>
<effect>
<keytext key="ew34" xml:lang="de">
Die Einheit fühlt sich sehr stark.
</keytext>
</effect>
<effect>
<item type="itemtype.sevenmilestea">7</item>
</effect>
<message ...>
</unit>
|
|
Gebäude | |
<building id="building_h0us" key="h0us" type="buildingtype.academy">
<name>xxxxx</name>
<descr>dsfsf sdf sdf</descr>
<size>25</size>
|
Name und Beschreibung sind klar #PCDATA. Typ und Grösse sind zumindest bei Eressea etwas das jedes Gebäude als Eigenschaft hat. Den Typ würde ich lieber als Attribut auslegen, da man dann ggf. auf einen Gebäudetyp referenzieren kann. In dem Fall muss es aber wieder global eindeutig sein. Also doch wieder sowas wie type="buildingtype.academy". Leider kann man ja nicht klar stellen, dass type auf einen buildingtype referenziert. Die Grösse hingegen würde ich als Element angeben - warum - keine Ahnung. |
Schiffe | |
<ship id="ship_ttnc" key="ttnc" type="boat"/>
<name>...
<descr>...
<status tag="load">2000</status>
<status tag="damage">2</status>
|
|
</region> |
|
Messagetypen | |
<messagetype id="msgtype_5673456873">
<section>travel</section>
<pattern locale="de">
<attribute name="unit"/> segelt von <attribute name="from"/> nach
<attribute name="to"/>. Dabei wurden
<function type="regions"><attribute name="through"></function> durchquert.
</pattern>
</messagetype>
|
So richtig gefällt mir das hier noch nicht.
Man sollte anhand der Pattern bereits den Typ des jeweiligen Attributs erkennen. Vermutlich müsste jede $xyz() die es derzeit gibt, als extra Elementtyp in der (Eressea)-DTD definiert werden. |
</atlantis> |
|
Regelset
Mir stellt sich die Frage, ob das Regelset nur die "technischen" Infos enthalten soll, oder ob auch die UI-Infos hier direkt rein sollen. Damit meine ich die Lokalisierung und Icons. Solche Sachen könnten auch in einer zusätzlichen XML Datei definiert sein, die dann z.B. nur Übersetzungen enthält.
Die Icons sollen sowieso nach Möglichkeit nicht direkt referenziert sein, sondern in einer Grafikset-XML verwaltet werden. D.h. es wird nur auf die im Grafikset eindeutigen IDs referenziert. Natürlich kann man auch das Grafikset spielabhängig gestalten und dort die Bindung der Icons an die Spielobjekte vornehmen.
Gleiches gilt für die Übersetzungen von Namen. Die können ebenso als "Benennungsset" spielabhängig und in einer Extra Datei gehalten werden und auf Spielobjekte referenzieren.
Und noch ein Dokument fuer eine Spiel-Definition
<!DOCTYPE atlantis PUBLIC "-//PBEM//DTD Atlantis 1.0//EN" "http://eressea.de/atlantis-ruleset.dtd">
<?xml version="1.0" encoding="UTF-8"?>
<atlantis>
<itemcategory id="itemcategory_resource">
<name lang="de">Ressource</name>
<useicon ref="icon_resource">
</itemcategory>
<itemtype id="itemtype_laen">
<name lang="de">Laen</name>
<weight>2</weight>
<produce>
<skill type="skilltype.bergbau" minlevel="7" productionpoints="7"/>
<building type="buildingtype.mine" required="yes"/>
<components>
<resource type="resourcetype.laen">1</resource>
</components>
</produce>
<useicon ref="icon_laen"/>
<category ref="itemcategory_resource"/>
</itemtype>
<itemtype id="peasantblood">
<produce>
<skill type="skilltype.alchemy" minlevel="4" productionpoints="4"/>
<components>
<resource type="resourcetype.peasant">1</resource>
<item type="fjordfungus">1</item>
...
</components>
<command><cmd_make/> <amount optional="true"/> ...</command>
</produce>
</itemtype>
<race/>
<plane/>
<terraintype/>
<skilltype/>
<buildingtype id="buildingtype_mine">
...
<useicon ref="icon_mine">
<placement role="map" x="0%" y="30%"/>
</useicon>
</buildingtype>
<shiptype/>
<command/>
</atlantis>
Siehe auch
