Features
FAQ, Settings and App Store
The three system apps that every book has: the server's FAQ, the player's Settings, and the App Store, with Config.FAQ and the store settings.
FAQ, Settings and App Store are on every book and cannot be removed. Settings and App Store cannot be switched off either.
#FAQ
FAQ (faq) shows your own questions and answers under category tiles. Each question is a closed row that opens on a tap. A search and the category tiles filter them. It is read only.
apps/faq/config.lua (Config.FAQ):
| Key | Default | What it does |
|---|---|---|
Enabled |
true |
Turns the app on |
Items |
twelve questions | Rows of category, q (question), a (answer), optional icon |
luaConfig.FAQ = {
Enabled = true,
Items = {
{ category = 'Baslarken', q = 'Defteri nasil acarim?',
a = 'Envanterinizdeki Pocketbook esyasini kullanin ya da F1 tusuna basin.' },
{ category = 'Banka', icon = 'bank-outline', q = 'Bakiye gercek mi?', a = 'Evet.' },
}
}
The shipped questions cover opening and closing the book, signal, the telegraph, the App Store, the bottom bar, the bank and the stables. Rewrite them for your server. icon is a file name in preview/assets/mdi/ without .svg; without it the shipped categories use their own picture.
#Settings
Settings (settings) holds the player's own choices. They are saved to the character.
- Theme: the colour of the book. With
Config.Access.ThemeItemsset, the picker shows only the colours whose notebook item the player carries. WithThemeItems = falseevery colour is free. - Wallpaper: one of the ready-made paper patterns (
Config.Wallpaper.Presets), or the player's own HTTPS picture link whenConfig.Wallpaper.Enabled = true, with blur, brightness, contrast, saturation and opacity. - Look: book size, position on the screen and text size.
- Sounds: the notification sound and its volume, and the interface sounds on or off with their volume. Each kind of interface sound (taps, typing, hover, openings, Card Table sounds) can be turned on or off; hover is off by default.
- Language, and hints on or off.
A new character starts with a short setup wizard that asks for the same choices. The defaults come from Config.UI, Config.UIPrefs, Config.Notifications and Config.Wallpaper in config.lua.
#App Store
App Store (store) lists every app the player can add.
- Search, a featured app, category tiles and one row per app with Install or Open.
- An app page with its description, and a Remove button for apps that can be removed.
- The installed apps on their own page.
- Installed apps are added to the home page. Apps can be dragged into the bottom bar (up to
Config.HomeDefaults.DockMax) and grouped into folders.
Apps from other resources, made with the custom app SDK, appear in the store under their own name when Config.CustomApps.Enabled = true. Config.CustomApps.Maximum (default 24) limits how many a player installs, and with RequireInstall = true they must be installed from the App Store first.
The store's settings, switching apps off and keeping apps for some jobs are on Apps overview.