ModDesc.xml

Aus UniversalProcessKit
Wechseln zu: Navigation, Suche

Die modDesc.xml ist die zentrale Anlaufstelle für das Spiel, die Informationen eines Mods richtig einzusortieren und zu laden.

Übersicht

Folgende Tabelle zeigt, welche Abschnitte für welche Arten von Mods zwingend erforderlich sind. Bei allen Arten können aber andere Abschnitte verwendet werden, falls sie zusätzlich benötigt werden, wie bspw. bei Maps, die auch Skripte haben und somit auch Abschnitte für einen Skripte-Mod notwendig werden.

Abschnitt Benötigt für Maps Benötigt für platzierbare Objekte Benötigt für Fahrzeuge Benötigt für Skripte
Kopf/ Header Ja Ja Ja Ja
Mod-Eigenschaften Ja Ja Ja Ja
extraSourceFiles Nein Ja Nein Ja
maps Ja Nein Nein Nein
storeItems Nein Ja Ja Nein
l10n Nein Nein Nein Nein
inputBindings Nein Nein Nein Nein
Dateiende Ja Ja Ja Ja

Kopf/ Header

 <?xml version="1.0" encoding="utf-8" standalone="no" ?>
 <modDesc descVersion="21">

Mod-Eigenschaften

 <author>mor2000</author>
 <version>0.9.9</version>
 <title>
   <en>AAA UniversalProcessKit</en>
   <de>AAA UniversalProcessKit</de>
 </title>
 <description>
   <en><![CDATA[UniversalProcessKit]]></en>
   <de><![CDATA[UniversalProcessKit]]></de>
 </description>
 <iconFilename>UniversalProcessKit.dds</iconFilename>
 <multiplayer supported="true"/>

Eigenschaft Beschreibung
author Hier kommt der Name des Modders rein.
version Aktuelle Versionsnummer. Diese hilft vor allem den Nutzern/ Spielern zu sehen, ob ein Mod-Archiv aktueller ist als ein anderes.
title Das ist der Name des Mods und sollte mit dem Dateinamen übereinstimmen. Vor allem bei Mods, bei denen der Zeitpunkt des Ladens wichtig ist ("AAA_"/ "ZZZ_"), muss hier für die Sortier-Reihenfolge des Ladens eingehalten werden - der Dedicated-Server sortiert es nicht nach Dateinamen, sondern nach Mod-Titel.

Es muss nach verschiedenen Sprachvarianten ("<en>...</en>" / "<de>...</de>") aufgeschlüsselt werden.

description Eine kurze Beschreibung, was der Mod macht. Der Titel reicht sicher auch.

Es muss nach verschiedenen Sprachvarianten ("<en>...</en>" / "<de>...</de>") aufgeschlüsselt werden.

iconFilename Die Pfadangabe zum Icon des Mods. Eine fehlerhafte Angabe führt dazu, dass der Mod nicht geladen wird.

Für LS15 sollte das Icon 256x256 Pixel groß sein, einen transparenten Hintergrund haben und mit DXT5 abgespeichert sein.

multiplayer Die Angabe, ob der Mod multiplayer-fähig ist. Die UPK-Scripte sind darauf angelegt, multiplayer-fähig zu sein.

extraSourceFiles

 <extraSourceFiles>
   <sourceFile filename="register.lua"/>
   ...
 </extraSourceFiles>

Optionale Angabe von Lua-Scripten, die beim Laden des Mods mitgeladen werden sollen. Z.B. um neue Fruchtsorten zu registrieren.

maps

 <maps>
   <map id="PleasantValley" className="PleasantValley" filename="PleasantValley.lua" defaultVehiclesXMLFilename="defaultVehicles.xml">
     <title>
       <en>Pleasant Valley 2015</en>
       <de>Pleasant Valley 2015</de>
     </title>
     <description>
       <en>Description for the map.</en>
       <de>Beschreibung der Karte.</de>
     </description>
     <briefingImagePrefix>PleasantValley</briefingImagePrefix>
     <briefingTextPrefix>PleasantValley</briefingTextPrefix>
     <iconFilename>map_preview.png</iconFilename>
   </map>
 </maps>


Eigenschaft Beschreibung
title Titel der Karte
description Kurze Beschreibung der Karte
briefingImagePrefix Welche Bilder beim Laden der Karte angezeigt werden sollen.

Folgende 3 Bilder werden im Modordner erwartet: briefingImagePrefix+"_briefing1.dds"/ +"_briefing2.dds"/ +"_briefing3.dds"

briefingTextPrefix Der Text der beim Laden der Karte angezeigt werden soll.

Folgende 3 Texte werden im l10n-Abschnitt erwartet: briefingTextPrefix+"Text1"/ +"Text2"/ +"Text3"

iconFilename Icon der Karte

storeItems

 <storeItems>
    <storeItem>
      ...
    </storeItem>
    <storeItem>
      ...
    </storeItem>
 </storeItems>

Innerhalb der des storeItems-Abschnitts werden einzelne storeItem-Unterabschnitte für jedes kaufbare Etwas aufgeführt.

storeItem

 <storeItem>
   <name>
     <en>Apple tree</en>
     <de>Apfelbaum</de>
   </name>
   <functions>
     <function>
       <en><![CDATA[On this tree grows apples.]]></en>
       <de><![CDATA[An diesem Baum wachsen Äpfel.]]></de>
     </function>				
   </functions>
   <image active="storeTree.dds" brand="brand-mor2000.dds" />
   <price>1500</price>
   <dailyUpkeep>5</dailyUpkeep>
   <species>placeable</species>
   <category>placeables</category>
   <brand>mor2000</brand>
   <xmlFilename>appleTree.xml</xmlFilename>
   <rotation>0</rotation>

Zusätzlich mögliche Eigenschaften für Fahrzeuge und Anhänger:

   <specs>
     <capacity unit="$l10n_unit_liter">5600</capacity>
     <combination>$l10n_shopItemName_caseIH3020Cutter</combination>
     <fillTypes>wheat rape</fillTypes>
     <power>90</power>
     <workingWidth>6.5</workingWidth>
   </specs>
   <isDyeable color="0.552 0.077 0.077 1.0">true</isDyeable>

Abschnitt abschließen:

 </storeItem>

Eigenschaft Beschreibung
name Name des kaufbaren Objekts.
functions/ function Kurze Beschreibung was der Mod macht.
image Die Pfadangabe zum Icon des kaufbaren Objekts.

Für LS15 sollte das Icon 256x256 Pixel groß sein, einen transparenten Hintergrund haben und mit DXT5 abgespeichert sein.

price Preisangabe.
dailyUpkeep Tägliche Unterhaltskosten.
species Art des Objekts.
category Unter welcher Shop-Kategorie das Objekt zu finden ist. Siehe Shop-Kategorien.
brand Marke oder Hersteller des Objekts.
xmlFilename Pfad zur XML-Konfigurationsdatei.

l10n

 <l10n>
   <text name="wheat"> <en>wheat</en> <de>Weizen</de> </text>
   <text name="barley"> <en>barley</en> <de>Gerste</de> </text>
   <text name="rape"> <en>rape</en> <de>Raps</de> </text>
 </l10n>

Im l10n-Abschnitt können Übersetzungen der In-game-Begriffe für die verschiedenen Sprachen angegeben werden.

inputBindings

 <inputBindings>
    <input name="UPK_PLAYERTELEPORT" key1="KEY_less" button="" />
 <inputBindings>

Bei den inputBindings werden Tastaturkürzel bzw. Mausbefehle einem Namen zugewiesen, auf den in den Skripten dann verwiesen wird.

Dateiende

 </modDesc>