mca-json 1.0.0

package/.editorconfig

@@ -0,0 +1,14 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = true

package/.prettierrc

@@ -0,0 +1,4 @@
+tabWidth: 4
+arrowParens: "always"
+endOfLine: "lf"
+singleQuote: true

package/README.md

@@ -0,0 +1,373 @@
+MCA Tools
+=========
+
+Command-line tools to work with Minecraft Anvil files (`*.mca`), from version 1.21.4 or newer. Support could be added to earlier versions incrementally as needed.
+
+To install, first you need to install Node.js, then use `npm` to install the package. (Deno and Bun users can use this too, but you'll need to use your tool to do the install.)
+
+```
+npm install -g mca-tools
+```
+
+After that, you'll have access to all of these fine utilities.
+
+This also has an API to include into your own programs. The JavaScript library doesn't require any Node-specific tooling, allowing you to bundle and build it into a browser environment.
+
+
+## Command-Line Tools
+
+
+### `mca-json` - Convert MCA to JSON
+
+Converts an MCA file to JSON. Both input and output files are optional and it will read from stdin and write to stdout if not provided.
+
+```
+# See all of the options available
+mca-json --help
+
+# Convert a MCA file to JSON
+mca-json ~/.minecraft/saves/Test_World/region/r.2.1.mca ~/r.2.1.json
+```
+
+The output JSON is expected to be quite large. For example, one mostly untouched region used for testing is about 1 gigabyte of JSON. Because of this, there are options to make the output smaller while still being valid JSON. To not pretty-print the result, using `--compact` will reduce the size to roughly 1/10 of the expanded JSON but it's now all one long line. To preserve the majority of the spacing but collapse lists of numbers into a single line while still pretty printing the rest, use `--condense` and that will consume about 3/10 of the expanded size but still be understandable in a text editor.
+
+
+### `mca-chunks` - List the chunk coordinates within a MCA file
+
+Lists the chunk coordinates (not world coordinates) of each chunk contained with a single MCA file. Each chunk's coordinates are listed to the output, one per line in the format "X,Z".
+
+```
+# Show all chunk coordinates in a file
+mca-chunks ~/.minecraft/saves/Test_World/region/r.2.1.mca
+```
+
+This can also read the MCA file from stdin or write the output to a file. See `mca-chunks --help` for usage instructions.
+
+
+### `mca-trim-chunks-without-signs` - Erase chunks
+
+Hides chunks in an MCA file if they do not have signs. If you want to change the seed of your server regularly, you could have players reserve 16x16 chunks by placing a sign anywhere in the chunk with any letters or numbers on it. These signs are different from naturally generating signs. The indexes will be overwritten with zeros to indicate that the data is no longer in the file, so Minecraft will regenerate the chunk the next time it is loaded.
+
+```
+# Trim chunks in your region files
+cd ~/.minecraft/saves/Test_World/
+mca-trim-chunks-without-signs region/*.mca DIM1/region/*.mca DIM-1/region/*.mca
+```
+
+Without using additional flags, this will trim chunks that currently have players. Check the usage with `mca-trim-chunks-without-signs --help` for additional options.
+
+For reference, the naturally generating signs will have message like the following.
+
+* Chairs in taiga villages: ["", "", "", ""] and ["", "", "", ""]
+* Igloo basements: ["", "<----", "---->", ""] and ["", "", "", ""]
+
+
+### `nbt-json` - Convert NBT data to JSON
+
+This is useful for seeing what's in a player's `*.dat` file. Simply loads and decompresses the NBT, then writes it as a JSON object.
+
+```
+# See all of the options available
+nbt-json --help
+
+# Convert an NBT file to JSON
+nbt-json ~/.minecraft/saves/Test_World/playerdata/b248e729-09c2-40dd-9168-12d191b4f0b8.dat
+```
+
+
+## API
+
+
+### `class Anvil`
+
+```
+import { Anvil } from 'mca-tools';
+import { readFile } from 'node:fs/promises';
+
+const data = await readFile('r.0.0.mca');
+const anvil = Anvil.fromBuffer(data.buffer);
+```
+
+
+#### `static fromBuffer(buffer: ArrayBufferLike): Anvil`
+
+Loads data into an Anvil class.
+
+
+#### `anvil.data`
+
+The `ArrayBuffer` used. Nothing gets parsed right away and is all loaded and parsed on demand.
+
+#### `anvil.getAllChunks(): Chunk[]`
+
+Parses the NBT data and returns an array of `Chunk` instances.
+
+
+### `class Chunk`
+
+```
+// Continuing example from Anvil class
+const chunks = anvil.getAllChunks();
+const firstChunk = chunks[0];
+console.log(firstChunk.chunkCoordinates()); // [0, 0]
+```
+
+
+#### `chunk.blockEntityData(coords: Coords3d): NbtCompound | undefined`
+
+Gets associated block entity data from the chunk. For instance, this can get a sign's text or the items in a chest. If the information is not found, this will return `undefined`.
+
+
+#### `chunk.chunkCoordinates(): Coords2d`
+
+Returns an array with the X and Z coordinates. The chunk's coordinates are the `xPos` and `yPos` tags, which are absolute chunk coordinates from the world origin, not from the region.
+
+
+#### `chunk.findBlocksByName(name: string): Coords3d[]`
+
+Returns an array. Each element in the array is another array of the X, Y, and Z coordinates of blocks. The coordinates are real-world coordinates. This method will need to unpack the block list, so it will first use a palette to see if the decompression and the lengthy scan can be avoided.
+
+
+#### `chunk.getBlock(coords: Coords3d): GenericBlock`
+
+Returns a block class that represents the block at the given coordinates. For known blocks, there are additional methods. See "Block Classes" for further information.
+
+
+#### `chunk.inhabitedTime(): bigint | undefined`
+
+Shows the number of ticks processed in the chunk. When the player is nearby, this increases at 20 ticks per second. When the player is farther away, the tick count could advance slower. Does not increment when the chunk isn't loaded.
+
+
+#### `chunk.toObject(): object`
+
+Converts the internal NBT structure to an object literal, which can be serialized properly with `JSON.stringify()`.
+
+
+#### `chunk.uniqueBlockNames(): Set<string>`
+
+Returns a list of all unique block names within a given chunk.
+
+
+#### `chunk.worldCoordinates(): Coords2d`
+
+Returns an array with the X and Z real-world coordinates. The chunk will span from X to X+15 (going East) and from Z to Z+15 (going South). The chunk is the entire vertical column of the world.
+
+
+### Block Classes
+
+All blocks will inherit from Generic. Other types of blocks are detected by their name. Below are the patterns and the type of block that will be produced if that filter matches. There's a built-in function that will be used to determine if a block is of a specific type. These are static methods on the `Block` class, which all take the name as the only parameter and return a boolean.
+
+* `Block.isBanner(name: string): boolean` - Matches all banners
+* `Block.isBarrel(name: string): boolean`
+* `Block.isBeacon(name: string): boolean`
+* `Block.isBed(name: string): boolean`
+* `Block.isBeehive(name: string): boolean` - Matches beehives and bee nests
+* `Block.isBell(name: string): boolean`
+* `Block.isSign(name: string): boolean` - Matches all signs
+
+To add to this complexity, there are many blocks that support generic methods, such as `.customName()` and `.lock()`. Those are listed under `generic` in this documentation and called out special because they are not on all block instances.
+
+
+#### `generic.components(): NbtCompound | undefined`
+
+Associated data components for this block.
+
+
+#### `generic.coords: Coords3d`
+
+The world coordinates of the block.
+
+
+#### `generic.customName(): string | undefined`
+
+Returns the custom name, used in the GUI when interacting with the block.
+
+*Method only exists if block supports a custom name.*
+
+
+#### `generic.entityData: NbtCompound | undefined`
+
+The NBT entity data associated with this block. If there is none, this is left `undefined`.
+
+
+#### `generic.lock(): string | undefined`
+
+Returns the item name needed to interact with the block.
+
+*Method only exists if block supports locking.*
+
+
+#### `generic.name: string`
+
+The name of the block.
+
+
+#### `banner.patterns(): BannerPattern[]`
+
+Returns a list of banner pattern information applied to the banner, in order.
+
+```
+interface BannerPattern {
+    color: string;
+    pattern: string | {
+        asset_id: string;
+        translation_key: string;
+    }
+}
+```
+
+
+#### `barrel.items(): NbtList<NbtCompound>`
+
+The list of items in each slot of the barrel.
+
+
+#### `barrel.lootTable(): string | undefined`
+
+The loot table name for generating random contents.
+
+
+#### `barrel.lootTableSeed(): bigint | undefined`
+
+The seed to use when generating random contents. 0 means to use a random seed.
+
+
+#### `beacon.primaryEffect(): string | undefined`
+
+The primary effect name of the beacon.
+
+
+#### `beacon.secondaryEffect(): string | undefined`
+
+The secondary effect name of the beacon.
+
+
+#### `beehive.bees(): NbtList<NbtCompound> | undefined`
+
+Information about the bees within the beehive or bee nest.
+
+
+#### `beehive.flowerPos(): Coords3d | undefined`
+
+Location of the associated flower.
+
+
+#### `sign.backColor(): string | undefined`
+
+Returns the color of the text on the back of the sign for 1.20+. For older versions, this returns `undefined`.
+
+
+#### `sign.backGlowingText(): boolean | undefined`
+
+Returns `true` if the sign has glowing text on the back for 1.20+. For older versions, this returns `undefined`.
+
+
+#### `sign.backText(): string[] | undefined`
+
+Returns the four lines of text on the back of the sign for 1.20+. For older versions, this returns `undefined`.
+
+
+#### `sign.frontColor(): string | undefined`
+
+Returns the color of the text on the front of the sign.
+
+
+#### `sign.frontGlowingText(): boolean | undefined`
+
+Returns `true` if the sign has glowing text on the front.
+
+
+#### `sign.frontText(): string[]`
+
+Returns the four lines of text on the front of the sign.
+
+
+#### `sign.isWaxed(): boolean`
+
+Returns `true` if the sign is waxed and `false` if not for 1.20+. For older versions, this returns `undefined`.
+
+
+### NBT Classes
+
+There are several NBT classes that could be retrieved when you want direct access to the chunk's data. They all have a `.toJson()` method that will return an array with the name of the tag as the first element and the tag's data as the second. This is used to facilitate easier transforms into JSON.
+
+
+#### `Nbt.fromBuffer(data: ArrayBufferLike): NbtBase<any>`
+
+Parses NBT data. Returns one of the NBT classes below, depending on the tag's type. This does *not* deal with compressed data. It's the responsibility of the container (Anvil) to decompress the data stream before passing it to this parser.
+
+
+#### `Nbt.fromSnbt(snbt: string): NbtBase<any>`
+
+Parses SNBT data. Returns the hydrated NBT classes from the string form.
+
+
+#### `Nbt.getTag(binaryData: BinaryData): NbtBase<any>`
+
+Reads binary data from the `BinaryData` instance to determine the type, then calls the appropriate reader to provide the NBT tag.
+
+
+#### `NbtBase.readName(binaryData: BinaryData): string`
+
+Reads the name portion from a tag. Included in most tags.
+
+
+#### `nbtBase.findChild(path: string): NbtBase<any> | undefined`
+
+Finds a child by looking for exact string matches on names. Children can also be matched by using "/" as a separator, such as "Level/sections".
+
+Only works on `NbtList` and `NbtCompound` tags. On all others, this will return `undefined`.
+
+
+#### `nbtBase.isCompound(name: string): boolean`
+
+Checks if this is a compound tag. If `name` is also given, this checks to see if the compound tag's name also exactly matches. If either condition is not met, this returns `false`.
+
+
+#### `nbtBase.isList(subtype: NbtTagType): boolean`
+
+Checks if the tag is a list. If `subtype` is also given, this checks to see if the list tag's subtype also exactly matches. If either condition is not met, this returns `false`.
+
+
+#### `nbtBase.toObject(): any`
+
+Returns a plain object form of the tag. If this is a compound or list, then all children are included as well.
+
+
+#### `nbtBase.toSnbt(): string`
+
+Converts the tag to SNBT. The conversion will write out into a standard form, not necessarily matching what was parsed. For instance, the byte value "true" would be changed to "1". Strings will all use double quotes. Other minor changes, but the output will be valid SNBT.
+
+
+## Additional Notes
+
+
+### Coordinate Systems
+
+A player in Minecraft can easily determine their world coordinates. To convert
+from world coordinates to chunk coordinates, divide the x and z world
+coordinates by 16, rounded down. World coordinates and chunk coordinates also
+relate similarly to regions, which are 32 x 32 chunks.  The region coordinates
+are the chunk coordinates divided by 32 and rounded down.
+
+|        Type        |   X   |   Y   |   Z   |
+|:------------------:|:-----:|:-----:|:-----:|
+|  World Coordinates |  1234 |   65  | -5678 |
+|  Chunk Coordinates |   77  |   *   |  -355 |
+| Region Coordinates |   2   |   *   |  -12  |
+
+Special notes about the above example:
+
+* Rounding always rounds down. This may be tricky for negative numbers. -5678 / 16 = -354.875, so that rounds down to -355.
+* Chunks span the entire Y column, from bedrock to the build limit.
+* Region coordinates are used in the naming of the anvil file. The coordinates used in the example above would be in the file named `r.2.-12.mca`.
+
+
+### Supported versions
+
+This has been loosely tested with the following editions. Other versions should work as well. If not, please supply a test MCA file and a description of the problem, or submit a pull request.
+
+* Java, 1.21.4, data version 4189.
+* Java, 1.17.1, data version 2730.
+
+Other versions can be supported through pull requests that contain tests to verify loading and processing works.

package/dist/bin/mca-chunks.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=mca-chunks.d.ts.map

package/dist/bin/mca-chunks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mca-chunks.d.ts","sourceRoot":"","sources":["../../src/bin/mca-chunks.ts"],"names":[],"mappings":""}

package/dist/bin/mca-chunks.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+import getStdin from 'get-stdin';
+import neodoc from 'neodoc';
+import { Anvil } from '../lib/anvil';
+import { readFile, writeFile } from 'node:fs/promises';
+async function readInput(filename) {
+    if (!filename || filename === '-') {
+        return await getStdin.buffer();
+    }
+    return readFile(filename);
+}
+const args = neodoc.run(`Usage: mca-chunks [OPTIONS] [<input> [<output>]]
+
+Lists the chunk coordinates in a Minecraft MCA file, one set of coordinates per
+line. Each line will have "X,Z", such as "-23,14". Both input and output are
+optional.  If input is not provided, this reads from stdin. If output is not
+provided, this writes to stdout.
+
+Options:
+    -h, --help      Show this message.
+`, {
+    argv: [...process.argv].slice(2),
+    laxPlacement: true,
+});
+readInput(args['<input>'])
+    .then((inputBuffer) => {
+    if (inputBuffer.length === 0) {
+        console.error('No input provided. Use --help for usage.');
+        process.exit(1);
+    }
+    const anvilParser = Anvil.fromBuffer(inputBuffer.buffer);
+    let chunks = anvilParser.getAllChunks();
+    return chunks.map((chunk) => chunk.chunkKey()).join('\n');
+})
+    .then((output) => {
+    if (args['<output>']) {
+        writeFile(args['<output>'], output);
+    }
+    else {
+        console.log(output);
+    }
+});
+//# sourceMappingURL=mca-chunks.js.map

package/dist/bin/mca-chunks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mca-chunks.js","sourceRoot":"","sources":["../../src/bin/mca-chunks.ts"],"names":[],"mappings":";AAEA,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAEvD,KAAK,UAAU,SAAS,CAAC,QAA4B;IACjD,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QAChC,OAAO,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,IAAI,GAGN,MAAM,CAAC,GAAG,CACd;;;;;;;;;CASC,EACG;IACI,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,YAAY,EAAE,IAAI;CACrB,CACJ,CAAC;AAEF,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACrB,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;IAClB,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,MAAqB,CAAC,CAAC;IACxE,IAAI,MAAM,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC;IAExC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9D,CAAC,CAAC;KACD,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE;IACrB,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACnB,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport getStdin from 'get-stdin';\nimport neodoc from 'neodoc';\nimport { Anvil } from '../lib/anvil';\nimport { readFile, writeFile } from 'node:fs/promises';\n\nasync function readInput(filename: string | undefined) {\n    if (!filename || filename === '-') {\n        return await getStdin.buffer();\n    }\n\n    return readFile(filename);\n}\n\nconst args: {\n    '<input>'?: string;\n    '<output>'?: string;\n} = neodoc.run(\n`Usage: mca-chunks [OPTIONS] [<input> [<output>]]\n\nLists the chunk coordinates in a Minecraft MCA file, one set of coordinates per\nline. Each line will have \"X,Z\", such as \"-23,14\". Both input and output are\noptional.  If input is not provided, this reads from stdin. If output is not\nprovided, this writes to stdout.\n\nOptions:\n    -h, --help      Show this message.\n`,\n    {\n        argv: [...process.argv].slice(2),\n        laxPlacement: true,\n    }\n);\n\nreadInput(args['<input>'])\n    .then((inputBuffer) => {\n        if (inputBuffer.length === 0) {\n            console.error('No input provided. Use --help for usage.');\n            process.exit(1);\n        }\n\n        const anvilParser = Anvil.fromBuffer(inputBuffer.buffer as ArrayBuffer);\n        let chunks = anvilParser.getAllChunks();\n\n        return chunks.map((chunk) => chunk.chunkKey()).join('\\n');\n    })\n    .then((output: string) => {\n        if (args['<output>']) {\n            writeFile(args['<output>'], output);\n        } else {\n            console.log(output);\n        }\n    });\n"]}

package/dist/bin/mca-find-chunks-with-signs.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=mca-find-chunks-with-signs.d.ts.map

package/dist/bin/mca-find-chunks-with-signs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mca-find-chunks-with-signs.d.ts","sourceRoot":"","sources":["../../src/bin/mca-find-chunks-with-signs.ts"],"names":[],"mappings":""}

package/dist/bin/mca-find-chunks-with-signs.js

@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+import debug from 'debug';
+import neodoc from 'neodoc';
+import { Anvil } from '../lib/anvil';
+import { Sign } from '../block/sign';
+import { readFile } from 'node:fs/promises';
+const debugLog = debug('mca-find-chunks-with-signs');
+const args = neodoc.run(`Usage: mca-trim-chunks-without-signs [OPTIONS] MCA_FILE...
+
+Displays chunk X and Z coordinates, separated by a tab, for all chunks in MCA
+files that contain a sign block. Signs need to have at least one letter or
+number on them to differentiate them from naturally generated signs.
+
+Options:
+    -h, --help      Show this message.
+    -v, --verbose   Show more information during processing.
+`, {
+    argv: [...process.argv].slice(2),
+    laxPlacement: true,
+});
+if (!args.MCA_FILE?.length) {
+    console.error('No files specified.');
+    process.exit(1);
+}
+for (const file of args.MCA_FILE) {
+    try {
+        await processFile(file);
+    }
+    catch (e) {
+        console.error(`Error processing file ${file}: ${e}`);
+        process.exit(1);
+    }
+}
+async function processFile(filename) {
+    debugLog(`Reading file: ${filename}`);
+    if (args['--verbose']) {
+        console.log(`Reading file: ${filename}`);
+    }
+    const contents = await readFile(filename);
+    const anvil = Anvil.fromBuffer(contents.buffer);
+    const chunks = anvil.getAllChunks();
+    for (const chunk of chunks) {
+        const chunkKey = chunk.chunkKey() || '';
+        if (processChunk(chunk)) {
+            const coords = chunk.chunkCoordinates();
+            if (!coords) {
+                throw new Error(`Chunk ${chunkKey} has no coordinates.`);
+            }
+            console.log(`${coords[0]}\t${coords[1]}`);
+        }
+    }
+}
+function processChunk(chunk) {
+    const blockNames = chunk.uniqueBlockNames();
+    for (const blockName of blockNames) {
+        if (blockName.match(/^minecraft:.+_sign$/)) {
+            debugLog(`Found sign: ${blockName}`);
+            for (const coords of chunk.findBlocksByName(blockName)) {
+                const block = chunk.getBlock(coords);
+                if (!(block instanceof Sign)) {
+                    throw new Error(`Block is supposed to be a sign: ${block.name}`);
+                }
+                const front = block.frontText();
+                const back = block.backText();
+                debugLog(`Front: ${JSON.stringify(front)}`);
+                debugLog(`Back: ${JSON.stringify(back)}`);
+                if ([...front, ...(back || [])].join('').match(/[a-z0-9]/i)) {
+                    debugLog(`Found a user-created sign. Preserving chunk.`);
+                    if (args['--verbose']) {
+                        console.log(`Found a user-created sign: ${JSON.stringify(front)} and ${JSON.stringify(back)}`);
+                    }
+                    return true;
+                }
+            }
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=mca-find-chunks-with-signs.js.map

package/dist/bin/mca-find-chunks-with-signs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mca-find-chunks-with-signs.js","sourceRoot":"","sources":["../../src/bin/mca-find-chunks-with-signs.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,MAAM,QAAQ,GAAG,KAAK,CAAC,4BAA4B,CAAC,CAAC;AACrD,MAAM,IAAI,GAGN,MAAM,CAAC,GAAG,CACV;;;;;;;;;CASH,EACG;IACI,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,YAAY,EAAE,IAAI;CACrB,CACJ,CAAC;AAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAED,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC/B,IAAI,CAAC;QACD,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,yBAAyB,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;QAErD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,QAAgB;IACvC,QAAQ,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAC;IAEtC,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,iBAAiB,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAEpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;QAExC,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC;YAExC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,SAAS,QAAQ,sBAAsB,CAAC,CAAC;YAC7D,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;AACL,CAAC;AAED,SAAS,YAAY,CAAC,KAAY;IAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC;IAE5C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACjC,IAAI,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,CAAC;YACzC,QAAQ,CAAC,eAAe,SAAS,EAAE,CAAC,CAAC;YAErC,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrD,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAErC,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CACX,mCAAmC,KAAK,CAAC,IAAI,EAAE,CAClD,CAAC;gBACN,CAAC;gBAED,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;gBAChC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAC9B,QAAQ,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC5C,QAAQ,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAE1C,IAAI,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC1D,QAAQ,CAAC,8CAA8C,CAAC,CAAC;oBAEzD,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;wBACpB,OAAO,CAAC,GAAG,CACP,8BAA8B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CACpF,CAAC;oBACN,CAAC;oBAED,OAAO,IAAI,CAAC;gBAChB,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport debug from 'debug';\nimport neodoc from 'neodoc';\nimport { Anvil } from '../lib/anvil';\nimport { Chunk } from '../lib/chunk';\nimport { Sign } from '../block/sign';\nimport { readFile } from 'node:fs/promises';\n\nconst debugLog = debug('mca-find-chunks-with-signs');\nconst args: {\n    '--verbose'?: boolean;\n    MCA_FILE?: string[];\n} = neodoc.run(\n    `Usage: mca-trim-chunks-without-signs [OPTIONS] MCA_FILE...\n\nDisplays chunk X and Z coordinates, separated by a tab, for all chunks in MCA\nfiles that contain a sign block. Signs need to have at least one letter or\nnumber on them to differentiate them from naturally generated signs.\n\nOptions:\n    -h, --help      Show this message.\n    -v, --verbose   Show more information during processing.\n`,\n    {\n        argv: [...process.argv].slice(2),\n        laxPlacement: true,\n    }\n);\n\nif (!args.MCA_FILE?.length) {\n    console.error('No files specified.');\n    process.exit(1);\n}\n\nfor (const file of args.MCA_FILE) {\n    try {\n        await processFile(file);\n    } catch (e) {\n        console.error(`Error processing file ${file}: ${e}`);\n\n        process.exit(1);\n    }\n}\n\nasync function processFile(filename: string) {\n    debugLog(`Reading file: ${filename}`);\n\n    if (args['--verbose']) {\n        console.log(`Reading file: ${filename}`);\n    }\n\n    const contents = await readFile(filename);\n    const anvil = Anvil.fromBuffer(contents.buffer);\n    const chunks = anvil.getAllChunks();\n\n    for (const chunk of chunks) {\n        const chunkKey = chunk.chunkKey() || '';\n\n        if (processChunk(chunk)) {\n            const coords = chunk.chunkCoordinates();\n\n            if (!coords) {\n                throw new Error(`Chunk ${chunkKey} has no coordinates.`);\n            }\n\n            console.log(`${coords[0]}\\t${coords[1]}`);\n        }\n    }\n}\n\nfunction processChunk(chunk: Chunk): boolean {\n    const blockNames = chunk.uniqueBlockNames();\n\n    for (const blockName of blockNames) {\n        if (blockName.match(/^minecraft:.+_sign$/)) {\n            debugLog(`Found sign: ${blockName}`);\n\n            for (const coords of chunk.findBlocksByName(blockName)) {\n                const block = chunk.getBlock(coords);\n\n                if (!(block instanceof Sign)) {\n                    throw new Error(\n                        `Block is supposed to be a sign: ${block.name}`\n                    );\n                }\n\n                const front = block.frontText();\n                const back = block.backText();\n                debugLog(`Front: ${JSON.stringify(front)}`);\n                debugLog(`Back: ${JSON.stringify(back)}`);\n\n                if ([...front, ...(back || [])].join('').match(/[a-z0-9]/i)) {\n                    debugLog(`Found a user-created sign. Preserving chunk.`);\n\n                    if (args['--verbose']) {\n                        console.log(\n                            `Found a user-created sign: ${JSON.stringify(front)} and ${JSON.stringify(back)}`\n                        );\n                    }\n\n                    return true;\n                }\n            }\n        }\n    }\n\n    return false;\n}\n"]}

package/dist/bin/mca-json.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=mca-json.d.ts.map

package/dist/bin/mca-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mca-json.d.ts","sourceRoot":"","sources":["../../src/bin/mca-json.ts"],"names":[],"mappings":""}

package/dist/bin/mca-json.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+import getStdin from 'get-stdin';
+import neodoc from 'neodoc';
+import { Anvil } from '../lib/anvil';
+import { readFile, writeFile } from 'node:fs/promises';
+async function readInput(filename) {
+    if (!filename || filename === '-') {
+        return await getStdin.buffer();
+    }
+    return readFile(filename);
+}
+const args = neodoc.run(`Usage: mca-json [OPTIONS] [<input> [<output>]]
+
+Converts a Minecraft MCA file to JSON. Both input and output are optional. If
+input is not provided, this reads from stdin. If output is not provided, this
+writes to stdout.
+
+Because MCA files can contain a tremendous amount of information, the tool
+might run out of memory. When that happens, you can dump specific chunks by
+specifying the --chunk-coords option.
+
+Options:
+    --chunk-coords=COORDS
+                    Only write out the chunk at the specified chunk coordinates.
+                    Chunk coordinates are absolute chunks from the world origin.
+                    Can be specified multiple times. Coordinates are specified
+                    as "x,z". Highly recommended to limit the size of the JSON
+                    that's generated.
+    --compact       Do not use pretty-printing in the JSON output.
+    --condense      Condense arrays of bytes, ints, and longs to a single line.
+                    This significantly cuts down on the size of the generated
+                    JSON.
+    -h, --help      Show this message.
+`, {
+    argv: [...process.argv].slice(2),
+    laxPlacement: true,
+});
+readInput(args['<input>'])
+    .then((inputBuffer) => {
+    if (inputBuffer.length === 0) {
+        console.error('No input provided. Use --help for usage.');
+        process.exit(1);
+    }
+    const anvilParser = Anvil.fromBuffer(inputBuffer.buffer);
+    let chunks = anvilParser.getAllChunks();
+    if (args['--chunk-coords']) {
+        if (!Array.isArray(args['--chunk-coords'])) {
+            args['--chunk-coords'] = [args['--chunk-coords']];
+        }
+        const wanted = new Set(args['--chunk-coords']);
+        chunks = chunks.filter((chunk) => wanted.has(chunk.chunkKey()));
+    }
+    let jsonObjects = chunks.map((chunk) => chunk.toObject());
+    if (args['--compact']) {
+        return JSON.stringify(jsonObjects);
+    }
+    let content = JSON.stringify(jsonObjects, null, 4);
+    if (args['--condense']) {
+        content = content.replace(/: \[(\n\s*"?-?\d+"?,?)*\n\s*\]/g, (match) => {
+            return match.replace(/\n\s*/g, ' ');
+        });
+    }
+    return content;
+})
+    .then((output) => {
+    if (args['<output>']) {
+        writeFile(args['<output>'], output);
+    }
+    else {
+        console.log(output);
+    }
+});
+//# sourceMappingURL=mca-json.js.map

package/dist/bin/mca-json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mca-json.js","sourceRoot":"","sources":["../../src/bin/mca-json.ts"],"names":[],"mappings":";AAEA,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAEvD,KAAK,UAAU,SAAS,CAAC,QAA4B;IACjD,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QAChC,OAAO,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,IAAI,GAMN,MAAM,CAAC,GAAG,CACd;;;;;;;;;;;;;;;;;;;;;;CAsBC,EACG;IACI,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,YAAY,EAAE,IAAI;CACrB,CACJ,CAAC;AAEF,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;KACrB,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;IAClB,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,MAAqB,CAAC,CAAC;IACxE,IAAI,MAAM,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC;IAExC,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,GAAG,CAAqB,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACnE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAE1D,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAEnD,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACrB,OAAO,GAAG,OAAO,CAAC,OAAO,CACrB,iCAAiC,EACjC,CAAC,KAAK,EAAE,EAAE;YACN,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACxC,CAAC,CACJ,CAAC;IACN,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC,CAAC;KACD,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE;IACrB,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACnB,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport getStdin from 'get-stdin';\nimport neodoc from 'neodoc';\nimport { Anvil } from '../lib/anvil';\nimport { readFile, writeFile } from 'node:fs/promises';\n\nasync function readInput(filename: string | undefined) {\n    if (!filename || filename === '-') {\n        return await getStdin.buffer();\n    }\n\n    return readFile(filename);\n}\n\nconst args: {\n    '--chunk-coords'?: string | string[];\n    '--compact'?: boolean;\n    '--condense'?: boolean;\n    '<input>'?: string;\n    '<output>'?: string;\n} = neodoc.run(\n`Usage: mca-json [OPTIONS] [<input> [<output>]]\n\nConverts a Minecraft MCA file to JSON. Both input and output are optional. If\ninput is not provided, this reads from stdin. If output is not provided, this\nwrites to stdout.\n\nBecause MCA files can contain a tremendous amount of information, the tool\nmight run out of memory. When that happens, you can dump specific chunks by\nspecifying the --chunk-coords option.\n\nOptions:\n    --chunk-coords=COORDS\n                    Only write out the chunk at the specified chunk coordinates.\n                    Chunk coordinates are absolute chunks from the world origin.\n                    Can be specified multiple times. Coordinates are specified\n                    as \"x,z\". Highly recommended to limit the size of the JSON\n                    that's generated.\n    --compact       Do not use pretty-printing in the JSON output.\n    --condense      Condense arrays of bytes, ints, and longs to a single line.\n                    This significantly cuts down on the size of the generated\n                    JSON.\n    -h, --help      Show this message.\n`,\n    {\n        argv: [...process.argv].slice(2),\n        laxPlacement: true,\n    }\n);\n\nreadInput(args['<input>'])\n    .then((inputBuffer) => {\n        if (inputBuffer.length === 0) {\n            console.error('No input provided. Use --help for usage.');\n            process.exit(1);\n        }\n\n        const anvilParser = Anvil.fromBuffer(inputBuffer.buffer as ArrayBuffer);\n        let chunks = anvilParser.getAllChunks();\n\n        if (args['--chunk-coords']) {\n            if (!Array.isArray(args['--chunk-coords'])) {\n                args['--chunk-coords'] = [args['--chunk-coords']];\n            }\n\n            const wanted = new Set<string | undefined>(args['--chunk-coords']);\n            chunks = chunks.filter((chunk) => wanted.has(chunk.chunkKey()));\n        }\n\n        let jsonObjects = chunks.map((chunk) => chunk.toObject());\n\n        if (args['--compact']) {\n            return JSON.stringify(jsonObjects);\n        }\n\n        let content = JSON.stringify(jsonObjects, null, 4);\n\n        if (args['--condense']) {\n            content = content.replace(\n                /: \\[(\\n\\s*\"?-?\\d+\"?,?)*\\n\\s*\\]/g,\n                (match) => {\n                    return match.replace(/\\n\\s*/g, ' ');\n                }\n            );\n        }\n\n        return content;\n    })\n    .then((output: string) => {\n        if (args['<output>']) {\n            writeFile(args['<output>'], output);\n        } else {\n            console.log(output);\n        }\n    });\n"]}

package/dist/bin/mca-trim-chunks-without-signs.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=mca-trim-chunks-without-signs.d.ts.map

package/dist/bin/mca-trim-chunks-without-signs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mca-trim-chunks-without-signs.d.ts","sourceRoot":"","sources":["../../src/bin/mca-trim-chunks-without-signs.ts"],"names":[],"mappings":""}