From e742d839e140768f25894b9961c23041600044db Mon Sep 17 00:00:00 2001 From: Donovan Daniels Date: Thu, 30 May 2024 05:08:27 -0500 Subject: [PATCH] Add info file information --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index f31ad38..fa76275 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,11 @@ build-packs * `-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"]]`)