Jump to content

MapConverter

From fCraft Wiki
Revision as of 13:26, 30 October 2012 by F (talk | contribs) (Options)
MapConverter usage

MapConverter is a utility, bundled with fCraft 0.630+, that can convert mapfiles between different file formats. MapConverter.exe requires fCraft.dll to function.

Usage

MapConverter [options] -e=ExporterName "Directory"
MapConverter [options] -e=ExporterName "File1" "File2" "File3..."

Examples

Single file conversion

MapConverter -e=MCSharp "filename.dat"
Converts a single file named "filename.dat" to MCSharp format, and saves it to "filename.lvl"

Batch conversion

MapConverter -r -e=FCMv3 "C:/maps"
Finds all map files in "C:/maps", including files in subdirectories, and converts them to FCMv3 (.fcm) format. Each converted file is saved into the same directory as the original file.

Moving out conveted maps

MapConverter -r -o "C:/converted" -e=FCMv3 "C:/maps"
Same as above, but converted map files are all placed into "C:/converted" directory.

Filtering

MapConverter -f=builder* -e=Opticraft "old_maps"
Looks for filenames that start with "builder", in a directory named "old_files".

Options

Options have alternative short (one-letter) and a long (whole word) forms. You can use either form: -e=MCSharp is same as --exporter=MCSharp

One-letter flags can be combined: -rty is same as -r -t -y

-e, --exporter=FORMAT

REQUIRED: Converter used for exporting/saving maps. Available formats:
  • D3 (.map)
  • FCMv3 (.fcm) - used in fCraft 0.500-0.630
  • FCMv4 (.fcm) - planned format for future versions of fCraft
  • JTE (.gz)
  • MCSharp (.lvl) - MCSharp, FemtoCraft, MCZall, MCLawl, MCForge, etc
  • MinerCPP (.dat) - also works for LuaCraft
  • Opticraft (.save)
  • Raw (.raw) - block data array, without any metadata

-f, --filter=PATTERN

Optional: Pattern to filter input filenames, e.g. *.dat or builder*. Applicable only when a directory name is given as input. Regular expressions can be used in the filter if -x / --regex flag is given.

-i, --importer=FORMAT

Optional: Converter used for importing/loading maps. Available importers:
  • Auto - default; tries to determine file type automatically
  • Classic (.dat or .mine) - Minecraft Classic and SurvivalTest maps
  • D3 (.map)
  • FCMv2 (.fcm) - used by fCraft prior to version 0.500
  • FCMv3 (.fcm) - used in fCraft 0.500-0.630
  • FCMv4 (.fcm) - planned format for future versions of fCraft
  • Indev (.mclevel) - from Minecraft Indev maps
  • JTE (.gz)
  • MCSharp (.lvl) - MCSharp, FemtoCraft, MCZall, MCLawl, MCForge, etc
  • MinerCPP (.dat) - MinerCPP and LuaCraft
  • Myne (directory-based) - Myne, MyneCraft, Hyvebuild, and iCraft
  • Opticraft (.save)

-o, --output=PATH

Optional: Path to save converted map files to. If not specified, converted maps will be saved to the original maps' directory.

-r, --recursive

Optional: Look through all subdirectories, and convert map files there too. Applicable only when a directory name is given as input.

-t, --tryhard

Template:0.64x
Try ALL the map converters on files that MapRenderer has trouble loading. When enabled, ALL map converters are tried, including ones that do not typically handle files with the given file extension.

-x, --regex

Template:0.64x
Enable regular expressions in \"filter\".

-y, --overwrite

Optional: Do not ask for confirmation to overwrite existing files.

-?, -h, --help

Prints usage information and a list of options.

MapConverter.exe edit codes

Code Meaning Notes
0 Success
1 ArgumentError Required command-line arguments were missing, or an error occurred while trying to parse options.
2 UnrecognizedImporter Given importer name was not recognized.
3 UnrecognizedExporter Given exporter name was not recognized.
4 InputDirNotFound Given file/directory name does not exist.
5 PathError Error occurred while trying to check input directory, or error occurred while trying to check/create output directory.
6 UnsupportedLoadFormat Given "importer" format name was recognized, but loading from it is not supported.
7 UnsupportedSaveFormat Given "exporter" format name was recognized, but saving to it is not supported.