PackFormatter/README.md

22 lines
1.1 KiB
Markdown

## Pack Formatter
To use this, you must have the [Bun runtime](https://bun.sh) installed. Simply run `bun install`, `bun compile`, and you'll find the `build-packs` binary in the `dist` folder.
## Usage
```sh
build-packs
```
### Arguments
* `-i` or `--indir` - The input directory. Defaults to the current working directory.
* `-o` or `--outdir` - The directory to output the compiled packs to. Defaults to dist.
* `-c` or `--common` - The common directory containing shared files. Defailts to common.
* `-r` or `--revision` - The revision/version. Defaults to `git rev-parse --short HEAD` if .git exists, else required.
### Info File
An `info.json` file should be present in the input directory. This file should contain the following fields:
* `name` - The name of the pack.
* `description` - A description of the pack.
* `url` - The URL to the pack's repository.
* `versions` - A two dimensional array of mc version to pack format. (`[[mcVersion, packFormat]]`)
* `exports` - The exports to be made from the zip files produced for each version. A two dimensional array of mcVersion or "all". (`[["all"],["1.20", "1.20.2"]]`)