Add your app to the list
Made an app for the Xteink X4 Pro or X4 Classic? Put it on GitHub with a topic and one small file, and it shows up under Community apps by the next day, with your name and a link to your repo.
Three steps
- Publish it on GitHub
A public repo with your app's
.xtapp: in a release, or committed in the repo. - Add the topic
On the repo's page: the gear next to About, then add the topic
licorice-ink-app. - Add
inkapp.jsonAt the root of the repo's default branch, in the format below. The list is rebuilt once a day.
inkapp.json
{
"format": 1,
"apps": [
{
"app_id": "reversi",
"name": "Reversi",
"version": "1.2.0",
"description": "The classic disc-flipping game against the reader, three levels.",
"devices": ["X4 Pro", "X4 Classic"],
"category": "games",
"package": "https://github.com/you/ink-games/releases/latest/download/reversi.xtapp",
"icon": "icons/reversi.png",
"screenshots": ["shots/reversi-1.png"],
"homepage": "https://github.com/you/ink-games",
"license": "MIT"
}
]
}
| field | |
|---|---|
format | Always 1. |
apps | One entry per app; a repo can list up to 20. |
app_id | The app_id of your manifest: lower-case letters only. |
name, version | Up to 40 characters; a dotted version such as 1.2.0.
Keep it the same as in your package. |
description | One or two sentences, up to 200 characters. |
devices | "X4 Pro" (touch), "X4 Classic" (keys), or both. |
category | Optional: read, tools, learn, stories,
daily, puzzles or games (default tools). |
package | Where the .xtapp is: an https:// address (a release download works
well) or a path in the repo. |
icon, screenshots | Optional pictures, as paths in the repo or https://
addresses: a square icon, and up to 6 screenshots. |
firmware | Optional: the oldest firmware build it needs, such as "26110201". |
homepage, license | Optional: a page for the app (default: the repo), and its license. |
Paths are read from the repo's default branch. An entry with a missing or wrong field is left out; the others in the file still count.
Good to know
- The site does not copy, host or check your package: visitors download it from your repo, and the list says so.
- Repos are listed by stars, then by name. Your GitHub name and repo are shown with each app.
- To leave the list, remove the topic. Repos that cause trouble can be left out by the site's maintainer.
- Xteink also has its own app store, with review: xtapp-ai.xteink.cc.
Questions or a problem with your listing: open an issue.