Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

App Folder Structure

Bluebotlabz edited this page May 25, 2023 · 4 revisions

Any webapp (compatible with Safari 5 or using the polyfill) can be converted into a KWebBrew app, it just needs an icon and a manifest file!

Each app is stored as a folder in the apps folder located in /mnt/us/apps/ (or in the root of the directory you see when connecting the Kindle to your computer)

The actual folder structure of the app does not matter, however, it must have a manifest.json file and an icon
Additionally, whilst the name of the app doesn't matter the folder must be in all lowercase will no spaces and it is recommended to make a folder with a name such as com.organisation.app (like in Java, but not as subdirectories)
It is also important to note that the folder name must match the id specified in the manifest.json file
The app name can be whatever you want (see manifest.json)

Nonetheless, let's take a look at the KChess app structure:

com.bluebotlaboratories.kchess
│   icon.jpg
│   index.html
│   main.css
│   main.js
│   manifest.json
│
└───pieces
        bB.svg
        bK.svg
        bN.svg
        bP.svg
        bQ.svg
        bR.svg
        wB.svg
        wK.svg
        wN.svg
        wP.svg
        wQ.svg
        wR.svg

As you can see, there is a `manifest.json`, an icon and some app assets
Whilst they do not need to follow this naming scheme, it is highly recommended
Clone this wiki locally