Skip to content

Commit

Permalink
doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Noggog committed Sep 18, 2024
1 parent 0c28e05 commit febfbba
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This converts from a Bethesda Plugin mod to Yaml, and puts it in your Git Reposi
| ---- | ---- | ---- | ---- |
| `-i` | `--InputPath` | Required | Path to the Bethesda plugin (esp/esm) |
| `-o` | `--OutputPath` | Required | Dedicated folder to export mod as its text representation |
| `-g` | `--GameRelease` | Semi | Game release that the plugin is related to. Required if no `.spriggit` file is found. |
| `-g` | `--GameRelease` | Semi-Optional | Game release that the plugin is related to. Required if no `.spriggit` file is found. |
| `-p` | `--PackageName` | Optional | Spriggit serialization nuget package name to use for conversion |
| `-v` | `--PackageVersion` | Optional | Spriggit serialization nuget package version to use for conversion |
| `-t` | `--Threads` | Optional | Maximum number of threads to use |
Expand Down Expand Up @@ -94,14 +94,14 @@ The final capstone should then be the `serialize` command once all the other cus
This command helps derandomize script properties, which often change order randomly after edits in the CK

#### Typical
`.\Path\To\Spriggit.CLI.exe sort-script-properties -i "C:\MyGitRepository\SomeMod.esp" -o "Some\Temp\Path\SomeMod.esp"
`.\Path\To\Spriggit.CLI.exe sort-script-properties -i "C:\MyGitRepository\SomeMod.esp" -o "Some\Temp\Path\SomeMod.esp"`

#### Parameters
| Short | Long | Required | Description |
| ---- | ---- | ---- | ---- |
| `-i` | `--InputPath` | Required | Path to the Bethesda plugin folder as its Spriggit text representation |
| `-o` | `--OutputPath` | Required | Path to export the mod with the properties sorted |
| `-g` | `--GameRelease` | Semi | Game release that the plugin is related to. Required if no `.spriggit` file is found. |
| `-g` | `--GameRelease` | Semi-Optional | Game release that the plugin is related to. Required if no `.spriggit` file is found. |
| `-d` | `--DataFolder` | Semi-Optional | Provides a path to the data folder for reference. [Read More](#master-style-input) |

## Master Style Input
Expand Down

0 comments on commit febfbba

Please sign in to comment.