Mod erstellen - Anfängertipps

Dies ist ein Einsteiger-Guide und richtet sich an absolute Anfänger.

Den Einstieg ins Modding zu finden empfand ich als sehr schwierig, da man sich grundlegendste Informationen aus allen möglich Quellen zusammensuchen muss. Daher möchte ich an dieser Stelle die absoluten Basics aufschreiben, so dass eine Mod überhaupt im Spiel ohne Fehler angezeigt wird und auch bei Steam akzeptiert wird.

Dieser Guide erklärt nicht die Lua-Syntax oder Struktur- und Verhaltensanforderungen von TPF2 an den Code. Man sollte m.E. zumindest eine Skript- oder Programmiersprache kennen und dementsprechend Grundbegriffe wie String, Boolean, relative Pfade, etc. kennen, ansonsten wird man sich in der Mod-Entwicklung sehr schwer tun.

1 Mod-Ordner erstellen

Zu allererst müsst ihr einen Mod Ordner in eurem Mod Verzeichnis der TPF2 Installation erstellen.

(z.B. Ordner in C:\Program Files (x86)\Steam\steamapps\common\Transport Fever 2\mods)

Dieser Ordner muss einem Namensschema folgen:

<NAME> + "_" + <MAJOR_VERSION>

(z.B. MeineMod_1)

MAJOR_VERSION soll bedeuten, dass es sich um eine Hauptversion handelt, deren Update (z.B. von 1.x auf 2.y) inkompatibel zu vorhandenen Spielständen sein kann. Die MINOR_VERSION wird in der mod.lua festgelegt (s. nächsten Abschnitt). D.h. Updates von Version 1.1 auf 1.2 sollten beim Benutzer keine Probleme verursachen. Ein einfaches Beispiel für ein Minor Update wäre ein Update der Textur auf dem gleichen Mesh-Modell.

1.1 Optional: Autor im Mod-Ordner

Weiter kann es für eure Mod-Nutzer einfacher sein - falls es einmal Probleme gibt - wenn der Autorenname gleich im Ordnerpfad erkennbar ist. Natürlich sollte dein Nutzername auch in der Mod-Beschreibung stehen (s. nächster Abschnitt) und sich idealerweise mit dem Namen bei Steam und TPF.net decken.

(z.B. cmuggi_MeineMod_1)

1.2 Optional: Ordner direkt in der Steam Mod Staging Area anlegen

Wenn ihr von vorherein vorhabt, eure Mod im Steam Workshop zu veröffentlichen, könnt ihr den Mod-Ordner auch direkt in der Steam Staging Area anlegen (siehe auch letzter Abschnitt).

(z.B. C:\Program Files (x86)\Steam\userdata\<DEINE_STEAM_ID>\1066780\local\staging_area\cmuggi_MeineMod_1\)

2 mod.lua

Folgender Inhalt stellt ein Minimalsetting (möglicherweise reichen auch noch weniger Attrbiute) der mod.lua dar, welche immer im Mod-Ordner-Root vorhanden sein muss.
(C:\Program Files (x86)\Steam\steamapps\common\Transport Fever 2\mods\MeineMod_1\mod.lua)

function data()
    return {
        info = {
            minorVersion = 0, -- die oben angesprochene MINOR_VERSION. Updates sind in Savegames kompatibel.
            severityAdd = "NONE", -- Option, ob der Benutzer Warnungen bekommen soll, wenn er die Mod aktiviert
            severityRemove = "WARNING", -- Option, ob der Benutzer Warnungen bekommen soll, wenn er die Mod deaktiviert 
            name = "Hauptbahnhof Nürnberg", -- Beliebiger Name, wie die Mod dann in der Liste aller Mods im Spiel heißt.
            description = _("desc"), -- Verweis auf einen String in der strings.lua, insbesondere notwendig, wenn man Mehrsprachigkeit unterstützen möchte. 
                                     -- description ist ein beliebiger Langtext, der die Mod beschreibt, wenn man sie in der Liste aller Mods im Spiel anklickt.
                                     -- Wird auch in die Steam Workshop Beschreibung übernommen.
            tags = { "europe", "locomotive" }, -- Zeigt die Mod-Kategorie in der Liste aller Mods an. Wird auch in den Steam Workshop übernommen.
            authors = { -- einen oder mehrere Autoren und ihre Rolle
                {
                    name = "cmuggi", -- beliebiger String eures Namens, Nicknames, etc. Taucht auch in der Liste aller Mods auf.
                    role = "CREATOR", -- Rolle des Autors
                },
            },
        },
    end
    }
end

Randinformation:

Manche Felder (z.B. tags) sollten aus einer vorgegebenen Auswahl getroffen werden. Ich versuche diese in späteren Versionen dieses Artikels zu ergänzen, sofern sie mir bekannt werden.

3 Entwicklung

Nun entwickelt ihr eure Mod. Mir hat es sehr geholfen aus vorhandenen Mods zu lernen. Dabei kann es sinnvoll sein, sich von sehr übersichtlichen Mods, wie sie Urban Games mit liefert, hin zu komplexeren Mods zu hangeln.

4 Vorschaubild

Um dem Benutzer im Modauswahldialog ein Vorschaubild zu zeigen muss dieses im Mod-Root mit dem Namen image_00.tga angelegt werden.

(z.B. C:\Program Files (x86)\Steam\userdata\11141510\1066780\local\staging_area\cmuggi_MeineMod_1\image_00.tga)

Randinformation:

Ob weitere Formate neben TGA unterstützt werden, wird in kommenden Updates dieses Artikels ggf. ergänzt. Freie Software wie z.B. Paint.NET unterstützt das Format.

5 Bei transportfever.net veröffentlichen

t.b.a.

6 Im Steam Workshop veröffentlichen

Kopiere den gesamten Ordner deiner Mod (z.B. C:\Program Files (x86)\Steam\steamapps\common\Transport Fever 2\mods\MeineMod_1\) in den Staging Area Ordner für die Steam Workshop Mods. (z.B. C:\Program Files (x86)\Steam\userdata\11141510\1066780\local\staging_area\MeineMod_1\). Ihr bekommt dann einen neuen Punkt im TPF2 Hauptmenü.

Randinformation:

• 11141510 ist meine Steam-ID. Eure wird anders lauten
• 1066780 ist die ID von TPF2 bei Steam.

6.1 Vorschaubild für Steam

Für den Steam Workshop sollte eine Vorschaubild vorhanden sein. Diese sollte ein Seitenverhältnis von 16:9 haben und den Namen workshop_preview.jpg tragen. Die Datei muss im Mod-Root liegen.

(z.B. C:\Program Files (x86)\Steam\userdata\<DEINE_STEAM_ID>\1066780\local\staging_area\cmuggi_MeineMod_1\workshop_preview.jpg)