TranslatorScript

[Blockierte Grafik: http://ftp.train-fever.net/flaggen/de.png] (translation below)
Hallo alle zusammen!

Als mich @Rjoande darauf ansprach, dass er meine Signalmods ins Italienische übersetzen will, ist mir folgendes aufgefallen:
Um einen Mod zu übersetzen, müssen alle Texte in den Modeldateien geändert werden. Also muss man auch für jede Sprache das Model extra bereitstellen.

Ich bin kein Fan von redundanten Daten, daher habe ich mir einen Skript geschrieben, der das ganze einfacher macht. Nur noch eine Sprachdatei muss die jeweiligen Sprachen bereit gestellt werden - und eine einzige "Grunddatei" mit dem Model. Die komplette Anleitung findet ihr dann auf der Downloadseite des Skriptes.

Wie findet ihr die Umsetzung? Habt ihr Fragen dazu? Immer her damit. Da es um Übersetzungen geht, bitte auf Englisch wenn möglich!

Entwicklung wurde eingestellt!
Durch die neuen Möglichkeiten des neuen Modding-Systems (strings.lua) wurde TranslatorScript überflüssig. Ich werde in den kommenden Tagen ein Tutorial für das neue System schreiben.

Download ->
Anleitung für Modder ->
[line][/line][Blockierte Grafik: http://ftp.train-fever.net/flaggen/gb.png]
Hello everyone!

When @Rjoande ask me for permission to translate my mods, I recognized one thing:
To translate a mod, all texts in the model files must be changed. Because of that, a complete model file must be uploaded for each language.

I hate redundant data, so I wrote a script to make it simpler. Only one language file (with only the translation) has to be uploaded per language. And only one single model file as base. The complete manual is written down on the download page of the script.

How do you like it? Any questions? Please answer in english (if possible), because here everything is about translation.

Development aborted!
With the possibilities of the new modding system (strings.lua) TranslatorScript is unnecessary. I will write a tutorial for the new system in the coming days.

download ->
manual for modders ->

Jede einzelne Datei braucht (bis jetzt) eine Sprachdatei. Ich kann aber den Script so umschreiben, dass wenn die passende Datei nicht gefunden wird, eine "Standard"-Sprachdatei im Ordner durchsucht wird...

[Blockierte Grafik: http://ftp.train-fever.net/flaggen/de.png] Es wird ab V2.0 auch nach einer Sprachdatei namens "_TRANSLATION.lang" im Ordner der *.mdl-Datei gesucht und dann ggf. daraus die Übersetzung entnommen. Es kann nur eine solche Datei pro Ordner geben! Daher vorsicht bei gemeinsam genutzten Ordnern!

Es wird empfohlen, für jede einzelne *.mdl-Datei eine eigene Sprachdatei zu verwenden. Der Aufwand ist praktisch gleich und verhindert Überschreibung durch andere Mod-Übersetzungen (falls mehrere Mods im gleichen Ordner sind)! Daher werde ich dieses Feature nicht mit in die Anleitung mit auf nehmen.
[line][/line][Blockierte Grafik: http://ftp.train-fever.net/flaggen/gb.png] Since V2.0, TanslatorScript searchs a file named "_TRANSLATION.lang" in the folder the *.mdl is located and uses the translation defined there. It can only exist one such file! Beware in shared folders!

It is recommended to use a single language file for each *.mdl-file! The effort is practically the same and prevents overwriting by other mod translations (if several mods are in the same folder)! Therefore, I will not include this feature into the manual.

Lieber EAT1963, dass erkläre ich dir gerne:

package.path ist eine von der LUA-Umgebung vordefinierte Variable. Sie beinhaltet die Suchparameter für Scripte. Durch das anfügen von '?.lang sucht jetzt LUA auch nach *.lang-Dateien.

Zum Dateien finden:

local ok, translation = pcall(require, langFileName():gsub("/", "."))

Hier "öffne" ich die Datei. Um genau zu sein binde ich sie per Require-Befehl ein. Das pcall() unterdrückt Fehlermeldungen falls keine Datei existiert. Der Befehl require gibt mir als Rückgabewerte einmal einen Statuscode und einmal (hier in translation abgespeichert) den Wert, der per return aus der zu "öffnenden" Datei kommt. Das sollte auch der Aufbau der Lang-Dateien erklären .

Zur Pfadermittlung:
langFileName() macht das "Wunder". Es gibt mir den Pfad folgendermaßen aus: res/models/model/railroad/BR146/TEST/test

local function langFileName()
   local str = debug.getinfo(3, "S").source:sub(2)

    local i = str:find("%.[^.]-$")

    if (i) then
        return str:sub(1, i - 1)
    else
        return str
    end
end

local str = debug.getinfo(3, "S").source:sub(2) ermittelt mir dabei den relativen Pfad vom "res"-Verzeichnis aus zur aufrufenden *.mdl-Datei. Hier etwas zum lesen zu den Parametern: http://www.gammon.com.au/scripts/doc.php?lua=debug.getinfo
Danach entferne ich nur noch die Dateiendung.

gsub("/", ".") ersetzt mir alle "/" durch ".", denn so muss ich das an require übergeben (http://www.lua.org/manual/5.2/manual.html#pdf-require).

Was passiert an einem Beispiel:
debug.getinfo(3, "S").source -> @res/models/model/railroad/BR146/TEST/Crocodile_test.mdl
:sub(2) -> res/models/model/railroad/BR146/TEST/Crocodile_test.mdl
Rest -> res/models/model/railroad/BR146/TEST/Crocodile_test
gsub() -> res.models.model.railroad.BR146.TEST.Crocodile_test

[Anm.: langFilePath beruht auf der selben Methode, es wird nur noch hinten mehr weggeschnitten]

Spezielle Zeichen:
Naja, ich habe alles mögliche versucht um Ä,Ö,Ü usw. ins Spiel zu bekommen. LUA scheint alle eingelesenen Daten in einen 8-bit-Datenstream zu verwandeln. In UTF-8 bestehen Umlaute aus zwei 8-bit Zeichen. Im Spiel selber werden diese dann aber falsch interpretiert, wodurch komische Zeichen angezeigt werden. Wandle ich sie um, funktioniert es plötzlich. Es ist mehr oder weniger ein "Work-Around"....

Wenn noch fragen sind, immer gerne stellen .

Mhh, das trennen wäre soweit schon hilfreich. Nur wie trenne ich hier die Sprachdateien auf? Weil alle in einen Ordner werfen geht nicht. Weil sonst jeder Mod einen eigenen Namen dafür haben müsste. Meine Idee wäre, so zu verfahren wie bei den UI-Vorschaubildern: Die Dateien würden dann in res\strings\models rein kommen mit der selben Ordnerstruktur.

Zitat von mediziner

Dateien da dann auch zusammenfassen

für Modeldateien in einem Ordner geht es ja bereits schon. Nur darf der Ordner nur von einem einzigen Mod (oder einem zusammengehörigen z.B. wie bei meinen Sperrsignalen) verwendet werden.

3? Ganz simpel erklärt:
"The function name can be an integer representing the stack level, where 0 is debug.getinfo itself"
Schauen wir uns mal den Call-Stack an:
TF ruft data() auf, welche _() aufgeruft.
_() ruft langFileName() auf, was wieder debug.getinfo() aufruft:

data() -> '3'
_() -> '2'
langFileName() -> '1'
debug.getinfo() -> '0'

Verständlich?

P.S.: Pfad zum res-Verzeichnis: schau dir mal die package.cpath an , diese lautet bei mir:
D:\Programme\Spiele\Steam\steamapps\common\Train Fever\?.dll;D:\Programme\Spiele\Steam\steamapps\common\Train Fever\loadall.dll;.\?.dll

Zitat von mediziner

Wie dann die Sprachdatei heißt, sollte egal sein.

Naja, nur ein Problem sehe ich da, z.B.:
MOD 1 hat seine Sprachdaten in res\strings\models\translation_gb.lang
MOD 2 hat seine Sprachdaten in res\strings\models\translation_gb.lang

Der User installiert Sprachdateien für MOD 1. Jetzt downloaded er Sprachpaket für MOD 2 - und BÄM! jetzt wird überschrieben! Es dürfte dann keine 2 Mods mit den selben Sprachdatei-Namen enthalten...

Zitat von Kimi

Aber hast du im Lexikon nicht geschrieben das die Sprachdatei nicht sowie so den gleichen namen haben muss wie der Mod an sich.

Nicht wie der Mod, sondern wie die *.mdl-Datei. Das ist ein Unterschied. Für jedes Kompaktsignal habe ich eine eigene Sprachdatei. Dieses Muster würde ich beibehalten. Ich arbeite gerade an folgender Umsetzung:

Modelldatei: res/models/model/railroad/BR146/Beispiel/Crocodile.mdl
Sprachdatei: res/strings/models/railroad/BR146/Beispiel/Crocodile.lang
(Oder für einen ganzen Ordner eine Sprachdatei: res/strings/models/railroad/BR146/Beispiel/_TANSLATION.lang)

Zitat von mediziner

Theoretisch könnte man für alle Sprachcodes dort auch Unterordner anlegen. Also GB oder IT ...

Wenn du mir sagst, wie ich die aktuelle Sprache aus LUA rauskitzeln kann .

Hier eine Preview: TranslatorScript V3.0.zip
Die Dateien werden wie in meinem Beispiel oben abgelegt:

Zitat von BR146

Modelldatei: res/models/model/railroad/BR146/Beispiel/Crocodile.mdl
Sprachdatei: res/strings/models/railroad/BR146/Beispiel/Crocodile.lang

Die Frage ist, ob es sich lohnt diese Unterscheidung zu machen? Natürlich könnte man dann die Sprachdateien direkt mit im Mod mitliefern...

eis_os: diese Idee werde ich mal ausprobieren.

Edit: _("Waypoint") liefert mit immer "Waypoint"... geht so also nicht. Ich habe bisher auch keine Variable gefunden, durch die ich die Sprache raus bekomme.
Folgenden Code habe ich zum Testen mal in die "signal_waypoint.mdl" direkt nach function data() eingefügt:

file = io.open("abc.txt", "w")
file:write(_("Waypoint"))
file:close()

Habe als Dateiausgabe "Waypoint" erhalten .

Ich überarbeite gerade die Anleitung. Ist der Abschnitt im Spoiler verständlich??? ([hl] steht für "Überschrift", die Zahl für die Tiefe der Überschrift)

return {
   ["Orignaltext mit Leerzeichen"] = "the translation is in here",
   ["zweitens"] = "second line",
...
}