MCFurryPacks/PackFormatter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add info file information

Browse Source
This commit is contained in:
Donovan Daniels 2024-05-30 05:08:27 -05:00
parent a8786c3e64
commit e742d839e1
Signed by: Donovan_DMC
GPG Key ID: 907D29CBFD6157BA
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -11,3 +11,11 @@ build-packs
* `-o` or `--outdir` - The directory to output the compiled packs to. Defaults to dist. * `-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. * `-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. * `-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"]]`)