2.pkg.md

icon	description
box-check	The type of Package or Binary

2.Pkg

{% code overflow="wrap" %}

#Example ONLY
pkg: "Real Name, It will be Installed & Integrated based on this Value"
pkg_id: "Unique Identifier, Based on src_url, used for identifying this .pkg"
pkg_type: "Pkg Format, if empty or nonexistent, Builder reads Magic Bytes to determine format"

{% endcode %}

• pkg is the Canonical name of the Package. It will be installed as this, regardless of the actual filename. Desktop entry will also show this name (TYPE: ENFORCED)
• pkg_id¹ is like an ID, It is Unique & NOT SHARED with any other pkg_id from other packages (TYPE: RECOMMENDED)

• pkg_id is to make it seamless to add multiple binaries from multiple sources for the same pkg
• pkg_id is just src_url without http|https schema along with some extra params
• Example: src_url ``= "https://github.com/AppImager/example-appimage" --> github.com.AppImager.example-appimage
• Notice how, all special chars like / --> . and http://|https:// was removed Another example, where the repo has multiple appimages:

• alpha --> github.com.AppImager.example-appimage.alpha
• latest --> github.com.AppImager.example-appimage.latest
• nightly --> github.com.AppImager.example-appimage.nightly
• stable --> github.com.AppImager.example-appimage.stable

• It's just $tag or some other identifier added at last

{% hint style="info" %} If you don't specify a pkg_id, the first entry of src_url is auto converted & added as pkg_id {% endhint %}

• pkg_type is the Package Format, it can be one of the following (lowercase) (TYPE: RECOMMENDED)

• AppImage denotes it is an AppImage pkg_type: "appimage"
• AppBundle denotes it is an AppBundle pkg_type: "appbundle"
• Archive denotes it is an archive (SELF-EXTRACTABLE) format: .7z .bz .bz2 .gz .lz4 .lzma .rar .sz .tar .xz .zst or a mix-mash of these. This includes formats like alpix, staticx etc. pkg_type: "archive"
• Dynamic denotes it is a Dynamic Binary pkg_type: "dynamic"
• FlatImage denotes it is a FlatImage , pkg_type: "flatimage"
• GameImage denotes it is a GameImage , pkg_type: "gameimage"
• NixAppImage denotes it is a NixAppImage , pkg_type: "nixappimage"
• RunImage denotes it is a RunImage , pkg_type: "runimage"
• Static denotes it is a Static Binary , pkg_type: "static"

{% hint style="info" %} Runner/Linter will read the magic bytes to determine correct format in case this field is empty. {% endhint %}

Footnotes

1. pkg_id will be auto generated based on src_url if pkg_id is empty ↩