This repository was archived by the owner on Jan 2, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2
The Manifest File
Bluebotlabz edited this page May 25, 2023
·
6 revisions
Each app has a manifest.json file, for example, the one for kchess is:
{
"minVersion": 1,
"manifestVersion": 2,
"appVersion": "v0.1.0",
"waf": false,
"id": "com.bluebotlaboratories.kchess",
"name": "KChess",
"author": "Bluebotlaboratories",
"description": "Chess on a Kindle!",
"repo": "https://github.com/Bluebotlaboratories/KWebBrew",
"icon": "icon.jpg",
"entrypoint": "index.html"
}
Here's a quick explanation of what everything does:
| Key | Description |
|---|---|
| minVersion | The minimum KWebBrew version required to run |
| manifestVerion | The version of the manifest |
| appVersion | The version string of the app, it can be anything but it is recommended that you stick to the semver standard |
| waf | RESERVED FOR FUTURE USE - Setting to true will cause the app to not run |
| id | The app's identifier (MUST MATCH FOLDERNAME, BE LOWERCASE and in that format) |
| name | The display name of the app |
| author | The author of the app |
| description | A short description of the app |
| repo | A link to the repository or mobileread thread |
| icon | The name of the icon file in the app's directory |
| entrypoint | The name of the main app file in the app's directory |
The current latest KWebBrew version number (for minVersion) is: 2
For historic reference, previous minimum version numbers were:
| Version Number | KWebBrew Version |
|---|---|
| 1 | v1.0.0 |
| 2 | v1.1.0 |
The current latest manifest version number (for manifestVersion) is: 2
For historic reference, previous manifest version numbers were:
| Version Number | KWebBrew Version |
|---|---|
| 1 | v1.0.0 |
| 2 | v1.1.0 |
- Added WAF key (MUST BE FALSE TO APPEAR ON KWEBBREW)
- Added version keys
- Added id key