prefab-tools
v0.12.0
Published
Toolkit to analyze, trim, repopulate and manipulate your 7 Days To Die map
Downloads
13
Readme
prefab-tools for 7 Days To Die
Toolkit to analyze, trim, repopulate and manipulate your 7 Days To Die map
⚠️⚠️⚠️
Alpha status:
Use with caution, make backups, manually check the files the script generates!
⚠️⚠️⚠️
Usage
$ npm install -g prefab-tools
$ prefab-tools COMMAND
running command...
$ prefab-tools (--version)
prefab-tools/0.12.0 linux-x64 node-v18.15.0
$ prefab-tools --help [COMMAND]
USAGE
$ prefab-tools COMMAND
...
Commands
prefab-tools align
prefab-tools analyze
prefab-tools client-side-mod
prefab-tools help [COMMANDS]
prefab-tools plugins
prefab-tools plugins:install PLUGIN...
prefab-tools plugins:inspect PLUGIN...
prefab-tools plugins:install PLUGIN...
prefab-tools plugins:link PLUGIN
prefab-tools plugins:uninstall PLUGIN...
prefab-tools plugins:uninstall PLUGIN...
prefab-tools plugins:uninstall PLUGIN...
prefab-tools plugins update
prefab-tools populate [DEBUGPREFABNAME]
prefab-tools teragon-poi-property-list
prefab-tools trim
prefab-tools align
Align all POIs and tiles to the heightmap of your map
USAGE
$ prefab-tools align
DESCRIPTION
Align all POIs and tiles to the heightmap of your map
EXAMPLES
$ prefab-tools align
See code: dist/commands/align.ts
prefab-tools analyze
Analyze your maps prefabs.xml and get detailed stats about your spawned POIs
USAGE
$ prefab-tools analyze
DESCRIPTION
Analyze your maps prefabs.xml and get detailed stats about your spawned POIs
EXAMPLES
$ prefab-tools analyze
See code: dist/commands/analyze.ts
prefab-tools client-side-mod
Creates an folder with all prefabs that are spawned on your map. For prefabs with common sizes the block info will be replaced by dummy data. That way you provide a distant terrain client side mod to your players with minimal file size.
USAGE
$ prefab-tools client-side-mod
DESCRIPTION
Creates an folder with all prefabs that are spawned on your map. For prefabs with common sizes the block info will be
replaced by dummy data. That way you provide a distant terrain client side mod to your players with minimal file size.
EXAMPLES
$ prefab-tools client-side-mod
See code: dist/commands/client-side-mod.ts
prefab-tools help [COMMANDS]
Display help for prefab-tools.
USAGE
$ prefab-tools help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for prefab-tools.
See code: @oclif/plugin-help
prefab-tools plugins
List installed plugins.
USAGE
$ prefab-tools plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ prefab-tools plugins
See code: @oclif/plugin-plugins
prefab-tools plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ prefab-tools plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ prefab-tools plugins add
EXAMPLES
$ prefab-tools plugins:install myplugin
$ prefab-tools plugins:install https://github.com/someuser/someplugin
$ prefab-tools plugins:install someuser/someplugin
prefab-tools plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ prefab-tools plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ prefab-tools plugins:inspect myplugin
prefab-tools plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ prefab-tools plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ prefab-tools plugins add
EXAMPLES
$ prefab-tools plugins:install myplugin
$ prefab-tools plugins:install https://github.com/someuser/someplugin
$ prefab-tools plugins:install someuser/someplugin
prefab-tools plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ prefab-tools plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ prefab-tools plugins:link myplugin
prefab-tools plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ prefab-tools plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ prefab-tools plugins unlink
$ prefab-tools plugins remove
prefab-tools plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ prefab-tools plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ prefab-tools plugins unlink
$ prefab-tools plugins remove
prefab-tools plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ prefab-tools plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ prefab-tools plugins unlink
$ prefab-tools plugins remove
prefab-tools plugins update
Update installed plugins.
USAGE
$ prefab-tools plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
prefab-tools populate [DEBUGPREFABNAME]
Populate all empty tiles in a prefab.xml
USAGE
$ prefab-tools populate [DEBUGPREFABNAME]
ARGUMENTS
DEBUGPREFABNAME Output why a prefab is excluded from being spawned in a POI marker
DESCRIPTION
Populate all empty tiles in a prefab.xml
EXAMPLES
$ prefab-tools populate
See code: dist/commands/populate.ts
prefab-tools teragon-poi-property-list
creates a terragon poi property list based on all your prefabs.
USAGE
$ prefab-tools teragon-poi-property-list
DESCRIPTION
creates a terragon poi property list based on all your prefabs.
EXAMPLES
$ prefab-tools teragon-poi-property-list
See code: dist/commands/teragon-poi-property-list.ts
prefab-tools trim
remove spawned decorations and parts from the prefabs
USAGE
$ prefab-tools trim
DESCRIPTION
remove spawned decorations and parts from the prefabs
EXAMPLES
$ prefab-tools trim
See code: dist/commands/trim.ts