mod
Mod related commands
Usage:
mod [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod add-mod
Adds the given mod name in the provided settings JSON.
Usage:
mod add-mod [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--mod-name |
text | N/A | Sentinel.UNSET |
--pak-dir-structure |
text | N/A | ~mods |
--packing-type |
choice (engine | unreal_pak | repak | retoc | loose) |
Packing type for the mod. | unreal_pak |
--mod-name-dir-type |
text | Directory type for the mod name (default: "Mods"). | Mods |
--mod-name-dir-name-override |
text | Override the mod name directory with this value (optional). | `` |
--pak-chunk-num |
integer | Pak chunk number (optional). | 0 |
--compression-type |
text | Compression type for the mod (optional). | `` |
--is-enabled |
boolean | Whether the mod is enabled (default: True). | True |
--asset-paths |
file | Asset path for the mod, can be specified multiple times. | Sentinel.UNSET |
--tree-paths |
directory | Tree path for the mod, can be specified multiple times. | Sentinel.UNSET |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod disable-mod
Disable the given mod names in the provided settings JSON.
Usage:
mod disable-mod [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--mod-name |
text | Name of a mod to disable, can be specified multiple times | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod disable-mods
Disable the given mod names in the provided settings JSON.
Usage:
mod disable-mods [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--mod-names |
text | Name of a mod to disable, can be specified multiple times | Sentinel.UNSET |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod enable-mod
Enable the given mod name in the provided settings JSON.
Usage:
mod enable-mod [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--mod-name |
text | Name of a mod to enable, can be specified multiple times | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod enable-mods
Enable the given mod names in the provided settings JSON.
Usage:
mod enable-mods [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--mod-names |
text | Name of a mod to enable, can be specified multiple times | Sentinel.UNSET |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod generate-mod-releases
Generate one or more mod releases.
Usage:
mod generate-mod-releases [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--mod-names |
text | A mod name, can be specified multiple times | Sentinel.UNSET |
--base-files-directory |
directory | Path to dir tree whose content to pack alongside the mod for release | Sentinel.UNSET |
--output-directory |
directory | Path to the output directory | Sentinel.UNSET |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod generate-mod-releases-all
Generate mod releases for all mods within the specified settings JSON.
Usage:
mod generate-mod-releases-all [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--base-files-directory |
directory | Path to dir tree whose content to pack alongside the mod for release | Sentinel.UNSET |
--output-directory |
directory | Path to the output directory | Sentinel.UNSET |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod generate-mods
Generates mods for the specified mod names.
Usage:
mod generate-mods [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--mod-names |
text | A mod name, can be specified multiple times | Sentinel.UNSET |
--use-symlinks |
boolean | Whether or not to use symlinks to save time with file operations | False |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod generate-mods-all
Generates mods for all enabled mods within the specified settings JSON.
Usage:
mod generate-mods-all [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--use-symlinks |
boolean | Whether or not to use symlinks to save time with file operations | False |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
mod remove-mod
Remove the given mod name in the provided settings JSON.
Usage:
mod remove-mod [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--mod-name |
text | Name of a mod to be removed. | Sentinel.UNSET |
--config-file |
file | Path to the settings JSON file | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |