Skip to content

v0.2.0

Choose a tag to compare

@github-actions github-actions released this 06 Jan 17:17
· 316 commits to main since this release

This release changes the way the cli has to be used in non-interactive mode. Commands are now grouped in various groups. For example, commands that operate on savegames are now found in sc4 city, .e.g. sc4 city growify <city>.

The submenu commands can now be found in sc4 submenu, e.g. sc4 submenu create and sc4 submenu add. Use sc4 --help to display the list of all subcommands.

Usage: sc4 [options] [command]

sc4 is a cli utility to modify .sc4 savegames and perform various modding tasks.
You can use the individual commands listed below, or just run sc4 without any commands to get an interactive interface.
Run sc4 [command] --help to view all options for the individual commands.

Options:
  -V, --version  output the version number
  -h, --help     display help for command

Commands:
  city           Modify savegames. Run sc4 city to view all available commands
  submenu        Manage submenus. Run sc4 submenu to list available commands
  plugins        Manage plugins. Run sc4 plugins to list available commands
  dbpf           Operate on DBPF files. Run sc4 dbpf to list available commands
  misc           Contains various commands that are experimental and not officially supported. Be very careful when using them!
  config         Manage sc4 configuration. Run sc4 config to list available commands

City commands

Usage: sc4 city [options] [command]

Modify savegames. Run sc4 city to view all available commands

Options:
  -h, --help                           display help for command

Commands:
  historical [options] <city>          Make buildings within the given city historical
  growify [options] <city>             Convert plopped buildings into functional growables
  pipes <city>                         Create the optimal pipe layout in the given city
  plop [options] <city> [patterns...]  Plops all lots that match the patterns in the city. DO NOT use this on established cities!
  refs [options] <city>                Lists all subfiles where the given pointer address or pointer type is referenced
  pointer <city> <pointer>             Finds the subfile entry addressed by the given pointer
  help [command]                       display help for command

Submenu commands

Usage: sc4 submenu [options] [command]

Manage submenus. Run sc4 submenu to list available commands

Options:
  -h, --help                display help for command

Commands:
  create [options] <icon>   Generates a new submenu button
  add [options] <files...>  Adds all specified lots to the given menu using the Exemplar Patching method
  scan [folder]             Scans the given folder for any submenus and adds them to the config file. Uses your configured plugin folder by default
  unpack [options] [dir]    Unpacks all in a given directory for use in github.com/sebamarynissen/sc4-submenu-collection
  help [command]            display help for command

What's Changed

Full Changelog: v0.1.3...v0.2.0