Skip to content

Latest commit

 

History

History
69 lines (56 loc) · 6.48 KB

USAGE.md

File metadata and controls

69 lines (56 loc) · 6.48 KB
Raw

Program Usage

Program Options

Parameter Description
db dir (Required) Directory which holds world files (level.dat is in this dir)
outdir dir Directory for output file(s). Defaults to "./output/"
html Create html and javascript files to use as a fancy viewer
html-most Create html, javascript, and most image files to use as a fancy viewer
html-all Create html, javascript, and all image files to use as a fancy viewer
no-tile Generates single images instead of tiling output into smaller images. May cause loading problems if image size is > 4096px by 4096px
tile-size[=tilew,tileh] Changes tile sizes to specified dimensions (Default: 2048px by 2048px)
slices[=did] Create slices (one image for each layer)
movie[=did] Create movie of layers
movie-dim x,y,w,h Integers describing the bounds of the movie (UL X, UL Y, WIDTH, HEIGHT)
xml filename XML file containing data definitions
cfg filename CFG file containing parsing configuration
detail Log extensive details about the world to the log file
verbose verbose output
quiet supress normal output, continue to output warning and error messages
help show basic help info
help-extended show extended help info
help-experimental show experimental help info
hide-top=did,bid Hide a block from top block (did=dimension id, bid=block id)
force-top=did,bid Force a block to top block (did=dimension id, bid=block id)
geojson-block=did,bid Add block to GeoJSON file for use in web app (did=dimension id, bid=block id)
schematic[-get] did,x1,y1,z1,x2,y2,z2,fnpart Create a schematic file (fnpart) from (x1,y1,z1) to (x2,y2,z2) in dimension (did)
grid[=did] Display chunk grid on top of images
all-image[=did] Create all image types
biome[=did] Create a biome map image
height-col[=did] Create a height column map image (red is below sea; gray is sea; green is above sea)
height-col-gs[=did] Create a height column map image (grayscale)
height-col-alpha[=did] Create a height column map image (alpha)
shaded-relief[=did] Create a shaded relief image
slime-chunk[=did] Create a slime chunk map image
no-force-geojson Don't load geojson in html because we are going to use a web server (or Firefox)
limit-x=did,min,max Limit generation in dimension did to chunks between min and max (x chunk coordinate)
limit-z=did,min,max Limit generation in dimension did to chunks between min and max (z chunk coordinate)
shortrun Debug testing parameter - process only first 1000 records
leveldb-filter=i Bloom filter supposed to improve disk performance (default: 10)
leveldb-block-size=i The block size of leveldb (default: 4096)
leveldb-try-repair If the leveldb fails to open, this will attempt to repair the database. Data loss is possible, use carefully.

Note: [=did] are optional dimension-ids - if not specified, do all dimensions; 0=Overworld; 1=Nether, 2=End) Example: --biome=0 1, --biome 0 --biome 1

Configuration

The visualizer will look for up to two configuration files, combining the results. The logic for this search is as follows:

  1. If the program is invoked with a --cfg fn option, that file path alone will be read for configuration information. No other file will be looked at for configuration if that file is found.

  2. When a configuration is not specified in the invocation, or the one specified is not found, the application will look for two files:

    a. The base config file: bedrock-viz.cfg. This is the configuration as delivered with the visualizer, with basic settings that should produce an informative map out of the box. This file is subject to be replaced and changed from release to release.

    b. Your local configuration additions: bedrock_viz.local.cfg. This file is where you should put your personal configuration. Document the player ids for the users in your world, configure the blocks that you don't care about, or that you find important enough to export as identifiable in the web app. The project does not provide this file, you own it entirely.

    These two files will be searched for in three locations each, the first one found will be used:

    1. Your home directory, as indicated by the HOME environment variable. In this location the file is expected to be a hidden file, eg prefixed with a ..

    2. Your profile directory, as indicated by the USERPROFILE environment variable. In this location the file is expected to be a hidden file, eg prefixed with a ..

    3. The Application's Local Data directory, this is typically /usr/local/share/bedrock-viz/data/ on unix-like platforms, or the data directory that is in the same directory as the executable for Windows.

    The local configuration additions can not undo any settings in the base configuration. They may only add to it. It is recommended therefore to keep the local configuration additions minimal. Should you find yourself needing to override a value from the base configuration, it is advised that you make a copy of the base configuration file, make your changes there and specify that file with the --cfg filename option.