Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Lenni009 authored Jun 11, 2023
1 parent 930086f commit 3bc2f3b
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Expand Down Expand Up @@ -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
```

0 comments on commit 3bc2f3b

Please sign in to comment.