Skip to content

collection

Collection related commands

Usage:

collection [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. Sentinel.UNSET

collection add-collections-to-mod-entry

Add collections to the mod entry in the settings json

Usage:

collection add-collections-to-mod-entry [OPTIONS]

Options:

Name Type Description Default
--config-file file The path to the settings json, who's mod entry you want to add collections to. Sentinel.UNSET
--mod-name text The mod name of the mod entry in the settings json to add the collection(s) to. Sentinel.UNSET
--collection-paths file The path to a collection to add to the settings json, can be specified multiple times. []
--help boolean Show this message and exit. Sentinel.UNSET

collection add-content-lines-to-collection

Add content lines to collection file, Dynamic accepts filter lines, while Static accepts content path lines and unreal asset path lines

Usage:

collection add-content-lines-to-collection [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to edit. Sentinel.UNSET
--content-path-lines text The new content lines to add to the collection, they will be converted to unreal asset paths. []
--filter-lines text The new content filter lines to add to the collection. []
--unreal-asset-paths text The new unreal asset path lines to add to the collection. []
--help boolean Show this message and exit. Sentinel.UNSET

collection create-collection

Create Collection

Usage:

collection create-collection [OPTIONS]

Options:

Name Type Description Default
--collection-path path The path to the collection file to edit. Sentinel.UNSET
--file-version integer The collection file version. 2
--content-type choice (Static | Dynamic) The type of content collection, dynamic uses file filters, static uses manual specification Static
--guid text The guid of the collection, if not provided one will be automatically generated. EF692E2E-DB61-43DB-B720-F7CCA312FB82
--parent-guid text The parent guid of the collection, if not provided no parent is assumed, and a blank one is given. 00000000-0000-0000-0000-000000000000
--red float The value of the color, accepts 0.0-1.0. 0.0
--green float The value of the color, accepts 0.0-1.0. 0.0
--blue float The value of the color, accepts 0.0-1.0. 0.0
--alpha float The value of the color, accepts 0.0-1.0. 0.0
--file-paths text A list of file paths to include in the collection, they will be automatically converted into unreal asset paths. For use with static collections. Sentinel.UNSET
--unreal-asset-paths text A list of unreal asset paths for the collection, for static collections. Sentinel.UNSET
--filter-lines text A list of asset filter for the collection, for use with dynamic collections. Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

collection delete-collection

Delete Collection

Usage:

collection delete-collection [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to rename. Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

collection disable-collection

Disable Collection

Usage:

collection disable-collection [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to rename. Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

collection enable-collection

Enable Collection

Usage:

collection enable-collection [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to rename. Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

collection remove-collections-from-mod-entry

Remove collections to the mod entry in the settings json

Usage:

collection remove-collections-from-mod-entry [OPTIONS]

Options:

Name Type Description Default
--config-file file The path to the settings json, who's mod entry you want to remove collections from. Sentinel.UNSET
--mod-name text The mod name of the mod entry in the settings json to remove the collection(s) from. Sentinel.UNSET
--collection-paths file The path to a collection to remove from the settings json, can be specified multiple times. []
--help boolean Show this message and exit. Sentinel.UNSET

collection remove-content-lines-from-collection

Remove content lines from collection file, Dynamic accepts filter lines, while Static accepts content path lines and unreal asset path lines

Usage:

collection remove-content-lines-from-collection [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to edit. Sentinel.UNSET
--content-path-lines text The new content lines to remove from the collection, they will be converted to unreal asset paths. []
--filter-lines text The new content filter lines to remove from the collection. []
--unreal-asset-paths text The new unreal asset path lines to remove from the collection. []
--help boolean Show this message and exit. Sentinel.UNSET

collection rename-collection

Rename Collection

Usage:

collection rename-collection [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to rename. Sentinel.UNSET
--new-name text New name for the collection. Sentinel.UNSET
--help boolean Show this message and exit. Sentinel.UNSET

collection set-collection-type-from-collection-path

Set Collection Type

Usage:

collection set-collection-type-from-collection-path [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to change the file version of. Sentinel.UNSET
--collection-type choice (Static | Dynamic) The new content type for the collection, Static or Dynamic. Static
--help boolean Show this message and exit. Sentinel.UNSET

collection set-color-from-collection-path

Set Collection Color

Usage:

collection set-color-from-collection-path [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to edit. Sentinel.UNSET
--red float The value of the color, accepts 0.0-1.0. 0.0
--green float The value of the color, accepts 0.0-1.0. 0.0
--blue float The value of the color, accepts 0.0-1.0. 0.0
--alpha float The value of the color, accepts 0.0-1.0. 0.0
--help boolean Show this message and exit. Sentinel.UNSET

collection set-file-version-from-collection-path

Set File Version

Usage:

collection set-file-version-from-collection-path [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to change the file version of. Sentinel.UNSET
--file-version integer The new file version for the collection. 2
--help boolean Show this message and exit. Sentinel.UNSET

collection set-guid-from-collection-path

Set Guid

Usage:

collection set-guid-from-collection-path [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to rename. Sentinel.UNSET
--guid text The new guid in string form for the collection. E19ADD39-6276-4813-A196-BB7A3940FD61
--help boolean Show this message and exit. Sentinel.UNSET

collection set-parent-guid-from-collection-path

Set Parent Guid

Usage:

collection set-parent-guid-from-collection-path [OPTIONS]

Options:

Name Type Description Default
--collection-path file The path to the collection file to rename. Sentinel.UNSET
--parent-guid text The new parent guid in string form for the collection. 00000000-0000-0000-0000-000000000000
--help boolean Show this message and exit. Sentinel.UNSET