MCA Selector Documentation

repository·master·Indexed 24 days ago

https://github.com/querz/mcaselector

A specialized utility for Minecraft Java Edition players and server administrators to manage world saves. MCA Selector allows users to select, export, import, or delete specific chunks and regions. It features a graphical user interface and a command-line interface (CLI) with modes for NBT value changes, cache image generation, and filter-based queries.

Tokens
1.6K
Snippets
1
Records
7
Agent score
89%

What's inside MCA Selector

  1. Overview of MCA Selector

    master
    MCA Selector is an external tool used to export or delete selected chunks and regions from Minecraft Java Edition world saves. It allows for precise manipulation of the world save data by selecting specific areas on a chunk and region grid.
  2. Download and Install MCA Selector

    master

    MCA Selector is available for multiple platforms. Always download directly from the official GitHub repository to ensure safety.

    ⚠️ Warning: MCA Selector modifies and deletes chunks in your Minecraft world. Please make backups of your world before using it.

    Available distributions for version 2.8:

    • Windows: Windows Installer (.exe)
    • macOS: arm64 (.dmg) and x64 (.dmg)
    • Linux: .deb (arm64/x64) and .rpm (arm64/x64)
    • Universal: Universal .jar (requires Java runtime)
  3. Check Supported Minecraft Versions

    master

    Before using MCA Selector, ensure your Minecraft world version is supported. The tool maps Minecraft versions to specific DataVersion ranges. Note that there is no guarantee for worlds generated in Snapshot versions, and old Snapshots are not officially supported.

    | Minecraft Version | DataVersion  |
    |-------------------|--------------|
    | 1.2.1 - 1.12.2    | None - 1343  |
    | 1.13 - 1.13.2     | 1444 - 1631  |
    | 1.14 - 1.14.4     | 1901 - 1976  |
    | 1.15 - 1.15.2     | 2200 - 2230  |
    | 1.16 - 1.16.5     | 2566 - 2586  |
    | 1.17 - 1.17.1     | 2724 - 2730  |
    | 1.18 - 1.18.2     | 2825 - 2975  |
    | 1.19 - 1.19.4     | 3105 - 3337  |
    | 1.20 - 1.20.6     | 3463 - 3839  |
    | 1.21 - 1.21.11    | 3953 - 4671  |
    | 26.1 - 26.2+      | 4764 - 4902+ |
  4. Configure MCA Selector CLI options

    master

    Use the following flags to control the behavior of MCA Selector commands:

    General Options

    • --help, -h: Print all available command line options.
    • --version, -v: Shows the current version of MCA Selector.
    • --debug, -d: Enable logging of debug level logs.
    • --process-threads: Set the number of threads to be used for processing.
    • --write-threads: Set the number of threads to use for writing files.

    Selection and Query Options

    • --query, -q: The query to run.
    • --script: The Groovy script to run.
    • --selection, -s: The CSV selection file to be applied to the target world.
    • --source-selection: The CSV selection file to be applied to the source world.
    • --radius, -r: The radius to be applied for a selection.

    World and Directory Options

    • --world, -w: The target world directory.
    • --region: Specific region folder for the target world (overwrites detected folder).
    • --poi: Specific poi folder for the target world.
    • --entities: Specific entities folder for the target world.
    • --source-world: The source world directory.
    • --source-region: Specific region folder for the source world.
    • --source-poi: Specific poi folder for the source world.
    • --source-entities: Specific entities folder for the source world.
    • --output-world: The output world folder.
    • --output-region: Specific region folder for the output world.
    • --output-poi: Specific poi folder for the output world.
    • --output-entities: Specific entities folder for the output world.
    • --output, -o: Specify the output file or directory.

    Import/Export Specific Options

    • --x-offset: Offset in x-direction for chunk import.
    • --y-offset: Offset in y-direction for chunk import.
    • --z-offset: Offset in z-direction for chunk import.
    • --overwrite: Overwrite existing chunks in the target world during import.
    • --sections: One or a range of section indices to import.
    • --fields: The NBT fields to change (used with change mode).
    • --force: Force NBT tags during NBT change.

    Image Mode Options

    • --render-height: The highest Y level to render.
    • --render-caves: Enable cave rendering.
    • --render-layer-only: Only render the layer specified by --render-height.
    • --render-shade: Enable/disable shading of terrain and water.
    • --render-water-shade: Enable/disable shading of water.
    • --render-height-shade: Enable/disable shading of terrain height.
    • --overlay-type: The type of overlay to be rendered.
    • --overlay-min-value: Minimum value for the overlay.
    • --overlay-max-value: Maximum value for the overlay.
    • --overlay-data: Additional data for the overlay.
    • --overlay-min-hue: Minimum hue for the overlay gradient (0.0 to 1.0).
    • --overlay-max-hue: Maximum hue for the overlay gradient (0.0 to 1.0).
    • --zoom-level: The zoom level for the cache to be generated.
  5. Available MCA Selector CLI modes

    master

    MCA Selector operates in several distinct modes. You must specify a mode using the --mode (or -m) flag.

    Available modes:

    • select: Create a selection from a filter query and save it as a CSV file.
    • export: Export chunks based on a filter query and/or a selection.
    • import: Import chunks with an optional offset.
    • delete: Delete chunks based on a filter query and/or a selection.
    • change: Change NBT values in an entire world or only in chunks based on a selection.
    • cache: Generate the cache images for an entire world.
    • image: Generate a single image based on a selection.
  6. Run MCA Selector via Command Line

    master
    MCA Selector can be executed via the command line. The application uses a ParamExecutor to process arguments. If the provided arguments result in a successful execution of a command (returning true from the execution future), the application will exit with code 0. If arguments are provided that do not trigger a command-line specific task, the application proceeds to launch the graphical user interface (GUI).