Mod erstellen - Anfängertipps

Willkommen in der Transport Fever Community

Welcome to the fan community of Transport Fever and Train Fever, the economic simulators of Urban Games. The community is free for you to share and inform yourself about the game. We cultivate a friendly and objective interaction with each other and our team will be happy to answer any questions you may have.

 

Registration and use is of course free for you.

 

We wish you a lot of fun and hope for active participation.

The Team of the Transport-Fever Community

  • 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.

    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)


    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)

Share

Comments 15

  • Was die Mod Tags angeht, kann man sich an der Liste im Steam-Workshop orientieren oder in res\config\mod_tags.lua

  • Das Tutorial ist ja mehr so ein "fertiges Objekt veröffentlichen" Guide. Ich finde da "mod erstellen" eher unpassend.

    Ich habe hier für TPF 1 (gilt fast alles noch) ein richtiges "mod erstellen" beschrieben.

    Mod erstellen: Leitfaden / Anleitung für Anfänger

  • Warum muss workshop_preview.jpg ein Seitenverhältnis von 16:9 haben?

    Der Workshop ist für Vorschaubilder mit 1:1 ausgelegt, der Rest ist schwarz. Tatsächlich sieht der Workshop von TPF1 allerdings anders aus, da war das Format breiter.

    Die verschiedenen Formate sind in der Tat sehr nervig.

    Die Ingame Vorschau (image_00.tga) sollte 16:9 sein (320x180). Falls nicht, wird verzerrt.

    Das Bild fürs Forum hier muss dann nochmal ein anderes Format haben: 370x250, also irgendwas dazwischen. Der Rest wird leider einfach abgeschnitten.
    Fazit: 3 verschiedene Formate, 3 mal verschiedener Umgang mit nichtkonformen Formaten...

  • Was ich definitiv auch gut finde wenn man den neuen Mod nicht Modname_Majorversion nennt, sondern Username_Modname_Majorversion. Damit müssen Benutzer deiner Mod nicht Stunden verbringen, zu suchen von wem der Mod erstellt wurde, falls es Probleme gibt. Wäre schön wenn du das in die Beschreibung aufnimmst. Danke und Viele Grüße

  • Auf sowas hab ich gewartet! :D


    Edit: Naja, das hilft doch nicht so wirklich weiter. Die mod.lua ist gut erklärt, mehr aber auch nicht. Trotzdem danke ;)

    • Ja, in der Tat bin ich kein erfahrener Modder der Meshing, Texturen, Scripting usw. aus dem Ärmel schüttelt.

      Ich selbst wollte mit einem Repaint anfangen und dachte mir, dass das ja nicht so schwer sein kann. 80% der Zeit habe ich damit verbraucht, mir überhaupt erstmal ansatzweise die eigentlich sehr einfachen Schritte aus diversesten Quellen und Nachvollziehen in vorhandenen Mods zusammenzusuchen.

    • genau das Problem habe ich auch. Trotzdem danke ;)

  • Es ist sinnvoller den Ordner gleich in der staging_area anzulegen, denn

    1. hat man dann nur eine Version mit der man arbeitet

    2. Kann man den Mod auch gleich im Modeleditor anschauen was im modordner nicht so einfach geht

    • man könnte aber auch den staging_area Ordner löschen und per mklink wieder anlegen und dabei auf den Ordner ..\Steam\steamapps\common\Transport Fever 2\mods verweisen, so hat man auch nur einen Ordner und eine Version.

    • Könnte man machen is aber kacke :D dann hab ich ja alle Mods drinne inkl der von UG was in ner unnötigen scrollorgie ausartet.

    • Tatsache, das könnte man auch machen :-)
      Man ließt hier sozusagen mein Protokoll, wie ich mir das Wissen zusammengesucht habe.

  • Intressant von Dir hier eine Anleitung zu lesen wie man einen Mod erstellt, nachdem Du bei deinem ersten auf Steam so ziemlich alles falsch gemacht hast... ;-)

    • Lernfähige Leute sind doch super ;-) wir brauchen mehr davon.

    • Danke MaikC :-)


      Nando: Ja, das war mit Sicherheit nicht perfekt, aber alles falsch kann eigentlich nicht sein?! Was sollte ich denn deiner Meinung nach besser machen?


      Edit:

      Known Issues:

      - Fenster müssen wieder getönt werden

      - ich nutze noch die Dateien der 016 Variante

      - Heisi könnte schöner ausgeschnitten sein

      - uvm.


      Edit2:

      Habe gerade deinen Kommentar auf Steam gelesen. Du sprichst ja genau o.g. Dinge an. Werde ich morgen einmal korrigieren.