24 lines
1.3 KiB
Markdown
24 lines
1.3 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.
|
|
* `-d` or `--data` - The data directory containing the data files. Defailts to data.
|
|
* `-r` or `--revision` - The revision/version. Defaults to `git rev-parse --short HEAD` if .git exists, else required.
|
|
* `-i` or `--info` - The info file. Defaults to info.json.
|
|
|
|
### 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"]]`)
|
|
* `overrides` - A dictionary map of version to data directory, superseding the common directory. (`{"1.20": "data"}`)
|