From 3bc2f3bdbf7c58ccedae2039b6a34e5f17dcafbd Mon Sep 17 00:00:00 2001 From: Lenni Date: Sun, 11 Jun 2023 11:02:53 +0200 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 555959c..d0d8f35 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,13 @@ This script can generate combined and simplified language files for No Man's Sky Resulting files can be seen in the [language archive](https://github.com/NMSCD/de-en-lang-archive). ## How to use - -1. [Install Deno](https://deno.land/manual@v1.31.0/getting_started/installation) -2. Put your EXML files into the "EXML" folder (create it if it doesn't exist - yet) -3. Execute the script in the directory by using this command: - -```bat -deno task run -``` +1. Put your EXML files into the "EXML" folder (create it if it doesn't exist yet) +2. Double click the exe file ### Command Line Arguments +You can optionally run it from the command line and specify additional arguments: + `--input-path`: Specifies the path to the folder with the EXML files. Default: "./EXML/" `--output-path`: Specifies the path to the folder with the resulting combined file. Default: "./output/" @@ -45,9 +40,20 @@ Valid values: - Japanese - USEnglish -For example, this would give the English and German translations in all files in the "input directory" folder next to the main.js file. It would then generate the resulting "Lenni.txt" in the "output directory" folder: +For example, this would give the English and German translations in all files in the "input directory" folder next to the LangFileGenerator.exe file. It would then generate the resulting "Lenni.txt" in the "output directory" folder: + ```bat -deno task run --input-path="./input directory/" --output-path="./output directory/" --filename="Lenni.txt" english german +LangFileGenerator.exe --input-path="./input directory/" --output-path="./output directory/" --filename="Lenni.txt" english german ``` Note that you must have the necessary language files decompiled in order to use this script. You can't get a German translation without the German files. + +## How to build from source + +[Install Deno](https://deno.land/manual@v1.31.0/getting_started/installation) + +Run this command: + +```bat +deno task build +```