UPack Documentation

Universal Package Format

  • Last Modified: 2019-07-18

There's not much to a universal package file; at a minimum it:

  • is a ZIP archive format with a .upack file extension
  • has a manifest file at the root level of archive named upack.json with a few required fields
  • contains any number of files in the /package directory; these files are the files that will get "unpackaged" by the client or server

You can add any number of files or directories outside of these minimal requirements - and in fact, that's exactly what universal packages are designed for.

In the extremely unlikely event that a future version of this specification will require, or uses additional files (we can think of absolutely no reason this would ever be required), then these will be opt-in and specified using the manifest, or potentially use a .upack2 extension.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ce197caa on master