From cb685a04ebea1682b7f42c056d3229b963355f3d Mon Sep 17 00:00:00 2001 From: MooglePing <33149289+pingmoogle@users.noreply.github.com> Date: Mon, 22 Apr 2024 22:47:32 +0800 Subject: [PATCH] Update README.md Make the user guide of SaintCoinach.Cmd more user-friendly --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3c26ec1..71b93d62 100644 --- a/README.md +++ b/README.md @@ -87,9 +87,14 @@ There should, however, be enough documentation available to know how to use the ### SaintCoinach.Cmd The project `SaintCoinach.Cmd` is a very basic console application that can be used to extract various assets. + +To use it, run `SaintCoinach.Cmd.exe` in your terminal with a parameter which helps locate your game installation. For example: +``` +.\SaintCoinach.Cmd.exe 'C:\Program Files (x86)\SquareEnix\FINAL FANTASY XIV - A Realm Reborn' +``` The following commands are currently supported: -* `lang`: Displays or changes the language used for data files. Valid arguments are `Japanese`, `English`, `German`, `French`. If no argument is supplied the currently used language is shown. +* `lang`: Displays or changes the language used for data files. Valid arguments are `Japanese`, `English`, `German`, `French`, `ChineseSimplified`. If no argument is supplied the currently used language is shown. * `raw`: Exports a file from the game assets without any conversions. The argument should be the friendly name of the file. * `image`: Exports a file from the game assets as a PNG-image. The argument should be the friendly name of the image file. * `ui`: Exports one or multiple UI icons as PNG-images. The argument can either be the number of a single UI icon, or the first and last number for a range of icons seperated by a space. Valid numbers are in the interval [0, 999999].