XML Format

Aus Eressea
Zur Navigation springenZur Suche springen

Anstatt sofort einen DTD zu definieren (die Dinger kann eh kaum jemand lesen) arbeiten wir hier ein Beispiel-Dokument aus, und diskutieren darüber.

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>
  • DTD - machen wir eine DTD für alle Spiele oder gibt es eine Grundlagen-DTD und dann spielspezifische DTD?
  • Version und Encoding
  • Benutztes Regelset

Allianzen

<alliance/>

Parteien

<faction id="faction_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>
  • Kultur und Magiegebiet könnten auch Referenzen sein ... to be discussed.
  • Alter, Punkte usw. würde ich gar nicht gesondert erfassen.

Messages

  <message id="message_123456" type="messagetype_23423546">
    <rendered xml:lang="de">
      Irgendwer (1234) segelt von Irgendwo (1,2) nach Nirgendwo (99,99). 
      Dabei wurden Ozean (1,3), Ozean (1,4) ... und Ozean (98,99) durchquert.
    </rendered>
    <attribute name="unit"><unitref ref="unit_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>
  • Messages können den Text in fertig gerenderter form enhalten. (Sprachabhängig)
  • Attribute sollten nicht nur einfach Werte sondern auch Listen enthalten können.
  • Ideal wäre die Attribute typisiert zu speichern, dann muss diese Info nicht aus dem Messagetyp geholt werden.
  • Eine Verschachtelung von Messages sollte möglich sein

Regionen

<region id="region_126788>
  <coordinate x="14" y="27"/>
  <name>xxxxx</name>
  <descr>dsfsf sdf sdf</descr>
  <terrain type="terraintype.plain"/>
  • Regionen, hier versehen mit einer Koordinate.
  • Wie wir verschiedene Ebenen Kennzeichen müssen wir noch diskutieren. Eine Z-Koordinate ist denkbar. Ein Element <maplevel> wäre aber auch nicht schlecht.
  • Da ansich jede Region ein bestimmtes Terrain hat, könnte man das Attribut auch direkt in region reinziehen.
  • Für subregionen will man aber ggf. keinen Terraintyp

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>
  • type referenziert auf den entsprechenden resourcetype. Wenn der nicht in den Regeln vorhanden ist, sollte der Client natürlich trotzdem den Eintrag verarbeiten, er hat nur keine Infos über den Typ.
  • Menge im Element codieren, oder als Attribut? Da es sich um die wichtigste info zur Resource handelt, ist es denke ich sinnvoll das im Element abzulegen.
  • Stufenabhängigkeit als Attribut oder als Subelement? Hab es mal als Subelement eingebaut, mit mehreren angezeigten Schichten.
  • Weitere Zusätzliche Attribute je nach Resourcentyp? Denke nicht, zumindest nicht solange sich solche werte ausrechnen lassen.

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>
  • Soll die (Grund)Menge bei trade oder bei den items stehen?
  • Brauchen wir <sell> und <buy> oder reicht <offer>?
  • Wie würde ein globaler Marktplatz funktionieren?
  • Wie könnte man Dienstleistungen anbieten?
  • Man kann sogar erlauben, das auch Gebäude und Einheiten ein trade element enthalten.

Einheiten

  <unit id="unit_mag3" faction="faction_Lotr"/>
    <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>
    <persons race="race.daemons">1</persons>
    <status type="guard"/>
    <status type="fight">front</status>
    <status type="health">wounded</status>
    <status type="hungry"/>
    <camouflage>
      <factionref ref="faction_3243/>
      <race ref="race.aquarians"/>
      <skilllevel>14</skilllevel>
    </camouflage>
    <magic area="Gwyrrd">
      <spell type="spelltype.xxx"/>
      <spell type="spelltype.xxy"/>
    </magic>
    <item type="itemtype.laen">14</item>
    <item type="itemtype.wood">44</item>
    <skill type="skilltype.camouflage"><level>17</level></skill>
    <skill type="skilltype.camouflage">
      <level>17</level><days>4567</days>
    </skill>
    <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>
  • Bei camouflage bin ich mir unsicher. Wichtig ist, Man kann sich sinnigerweise nur als eine Rasse, eine Partei oder mit einer bestimmten Stufe tarnen.
  • Ebenso unklar ist, wie man den ganzen Magiebereich flexibel abbildet. Magier haben bei Eressea ein Magiegebiet, bei anderen Spielen ggf. mehrere. Sprüche gehören zu einem Magiegebiet. Vertraute bei Eressea haben eventuell Sprüche, ohne diese aber einem Magiegebiet zuzuordnen. Bei Eressea gibt es Aura und Maximale Aura (prinzipiell ~ permanente Aura). Das kann man als Gegenstände auffassen, diese lassen sich aber in ihrer Menge nicht wie üblich übergeben. Trefferpunkte sind auch in diesem Bereich anzusiedeln. Sie werden aber nur durch einen Gesundheitsstatus grob ausgedrückt. Also modellieren wir das alles einzeln oder lassen wir uns was allgemeines einfallen?

Gebäude

  <building id="building_h0us" type="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"/>
</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

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>

=== Gegenstandstypen ===
  <itemtype id="itemtype.laen">
    <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>
  </itemtype>
  <itemtype id="itemtype.peasantblood">
    <produce>
      <skill type="skilltype.alchemy" minlevel="4" productionpoints="4"/>
      <components>
        <resource type="resourcetype.peasant">1</resource>
        <item type="itemtype.fjordfungus">1</item>
        ...
      </components>
      <command><cmd_make/> <amount optional="true"/> ...</command>
    </produce>
  </itemtype>

=== und der Rest ===
  <race/>
  <plane/>
  <terraintype/>
  <skilltype/>
  <buildingtype/>
  <shiptype/>
  <command/>
 
</atlantis>

External Links