Skip to main content

Metadata

An XPP bundle must contain a script named Info.lua that returns a Lua table constant describing the bundle metadata. It should not contain executable logic beyond constants.

A typical Info.lua example:

return {
BundleIdentifier = "com.yourcompany.yourscript";
BundleVersion = "0.0.1";
BundleName = "Your Name";
BundleDisplayName = "Your Display Name";
BundleIconFile = "appicon.png";
Executable = "xui-script.lua";
MainInterfaceFile = "xui-demo.xui";
MinimumSystemVersion = "10.0";
MaximumSystemVersion = "10.2";
MinimumXXTVersion = "1.1.2";
SupportedResolutions = {
{ width = 640; height = 1136; };
};
PackageControl = {
AuthorName = "i_82";
AuthorEmail = "[email protected]";
Description = "";
Homepage = "https://82flex.com";
};
};

The returned table usually contains the following keys. See subpages for details:

KeyRequiredRecommendedDescription
BundleIdentifier**Unique identifier
BundleVersion**Version
BundleName**Name
Executable*Entry script filename ( .lua, .xxt )
BundleDisplayName*Display name
BundleIconFile*App icon
MainInterfaceFile*XUI entry config ( .xui, .xuic )
MinimumSystemVersionMinimum iOS version
MaximumSystemVersionMaximum iOS version
MinimumXXTVersionMinimum XXTouch version
SupportedResolutionsSupported device resolutions
PackageControlAdditional information

You should complete these as much as possible. A good display name, icon, and configuration UI improve the look-and-feel and acceptance of your script.

In scripts, you can read constants from Info.lua via the XPP bundle module.

Which script formats does XPP support?

Executable service scripts supported in XPP bundles: .lua and .xxt. Scripts access resources/configs from the bundle via relative paths. To specify the entry script, see Executable.

How to specify the XPP configuration UI?

To specify the configuration page opened from XXTouch, set MainInterfaceFile. To write the config UI, see the XUI Handbook.

How to manage resources in XPP?

  • Put scripts/resources/modules/data inside the XPP directory and access them via relative paths.
  • Do not write temporary files/data into the XPP bundle at runtime; use XXTouch cache/temp directories instead.

In scripts, you can get resource paths from the XPP bundle module.