packwiz/packwiz-spec

A format for specifying Minecraft modpacks, designed to be easy to manipulate with tools.

packwiz-spec

A format for specifying Minecraft modpacks, designed to be easy to manipulate with tools. This modpack format is heavily inspired by the manifest format of Scoop and by PackUpdate. See the website generated from this specification at https://packwiz.infra.link/.

Contributing

Deno is used to generate JSON schemas, with a custom DSL using TypeScript decorators. Run deno task build to re-generate schemas from the definitions in src.

packwiz-spec's Issues

Allow `x-*` keys for extensions

I am considering doing a basic dependency management script while packwiz/packwiz#97 isnʼt complete. It would be nice to be able to use keys for storing that information which were guaranteed to not conflict with official keys, and making non-official sources start their key names with x- is a standard way to do that.

I donʼt know if jsonschema supports that or if it would need to be in prose, but either way, it would be useful.

Use https://github.com/StefanTerdell/zod-to-json-schema ?

Add packwiz-example-pack as submodule

Should use Renovate or something similar to keep it up to date, with the same branch format as this repo.

Add `@examples` to schemas

There's support for examples embedded into the spec/schema:

https://github.com/YousefED/typescript-json-schema#user-content-require-a-variable-from-a-file & https://json-schema.org/understanding-json-schema/reference/generic.html describe it - the basic idea is you can show what an example of that schema looks like (in our case this is slightly weird since we need to write a typescript example for a TOML schema, but it seems like a good idea!