1.0.0 • Published 11 months ago

@sheikah-converter/cli v1.0.0

Weekly downloads
-
License
AGPL-3.0-or-later
Repository
github
Last release
11 months ago

@sheikah-converter/cli

CLI to convert The Legend of Zelda: Breath of the Wild game saves between console formats (Wii U to Switch and viceversa)

Installation

npm install -g @sheikah-converter/cli

NOTE Even if the package name is @sheikah-converter/cli, the executable is called botwc

NOTE The cli can be used "without installing" it globally using npx @sheikah-converter/cli

Usage

Convert a BotW save

USAGE
  $ botwc INPUT [OUTPUT] [-f] [-d] [-c] [-v]

ARGUMENTS
  INPUT   The directory containing the save to convert
  OUTPUT  The directory to write the converted save to

FLAGS
  -c, --check    Check and print the type of save inside the input directory
  -d, --dry      Dry run (do not write files)
  -f, --force    Overwrite existing output directory
  -v, --verbose  Print verbose output

DESCRIPTION
  Converts a BotW saves

  This program converts a BotW save directory to from one console format to another.

  This works with Wii U and Switch saves up to version 1.6 of the game.

  Version 1.5 and 1.6 are compatible and should work interchangeably on both platforms.

Example

The following example will convert the save files in the directory ./original/save/backup and write them to the ./converted direcetory. If the directory already exists and is not empty, the command will fail (use -f to enable prompting for deleting files).

botwc ./original/save/backup/ ./converted