Configuration

config.lua

The general settings in config.lua: framework, language, opening, notebook items, notes, money, and a map of which file holds which setting.

config.lua holds the general settings. Every app has its own apps/<id>/config.lua, and the store has config_shops.lua. These files are shared with every client. Keys and webhooks go in the config_server.lua files, which stay on the server.

Defaults on these pages are the values in the shipped files.

#Which file holds which key

File Keys Page
config.lua Framework, Locale, LocaleFallback, Languages, MenuOpenMode, MenuToggle, Command, Access, OpenMenuKey, MaxNoteLength, CustomApps, MoneyAccount This page
config.lua UI, Holding, Notifications, Wallpaper, UIPrefs Look, holding and sounds
config.lua Signal, Towns Signal
config.lua Store, HomeDefaults App Store and home page
config_shops.lua SellPercent, PreviewLight, Stores, ShopLocales and the store camera and prompt keys Store
config_server.lua Logs config_server.lua
apps/bank, apps/billing, apps/borsa, apps/company Bank, Billing, Borsa, Company Finance apps
apps/telegram/*.lua Telegram, Parcels, Birds, Office, OfficeBusiness, Operations Telegraph
apps/stables, apps/kartlarim, apps/takvim, apps/katalog, apps/hekim, apps/almanak, apps/pusula, apps/saat, apps/eskiz, apps/faq Stables, Kartlarim, Takvim, Katalog, Hekim, Almanak, Pusula, Saat, Eskiz, FAQ Daily apps
apps/news, apps/darkchat, apps/pano, apps/cagri, apps/atlas News, Darkchat, Pano, Cagri, Atlas Communication and map
apps/music, apps/album, apps/kartmasasi Music, Album, Kart Phonograph, Album and Card Table
apps/mdt MDT Official Ledger

Several app configs say: do not use Turkish letters in their texts, and write s, i, g, c, o, u. Plain letters are always safe. The book's own pages show Turkish letters.

Texts the game draws with its own font (VORP notices, hold prompts, map blip names) cannot show the Turkish ş, ğ, ı and İ. The notebook writes them as s, g, i and I there by itself (PocketText.Native), so a Turkish locale shows readable words instead of boxes.

#Framework and money

Setting Default What it does
Config.Framework 'auto' 'auto', 'vorp' or 'rsg'. Auto picks the one that is started. If both are started, set it yourself
Config.MoneyAccount 'cash' The framework money the book takes and pays, for example Stock Bulletin trades, Card Table stakes and Town Board fees. RSG: 'cash' or 'bank'. VORP: 'cash'; another value needs a bank adapter and pocketbook_health warns

#Language

Setting Default What it does
Config.Locale 'tr' Language of the server and of new characters. Reads locales/<language>.json and apps/<id>/locales/<language>.json
Config.LocaleFallback 'tr' Language a missing text falls back to
Config.Languages { 'tr', 'en', 'de', 'fr', 'es', 'pt', 'pl', 'ru', 'it', 'nl' } Languages a player can pick in the setup wizard and Settings. Only the ones with a locales/<language>.json file are offered

The package has locale files for all ten languages. Language changes take effect on resource restart.

#Opening

Setting Default What it does
Config.MenuOpenMode 'keybind' 'keybind': the key opens the book. 'command': only the command. 'both': key and command
Config.MenuToggle true The open key and the command also close an open book
Config.Command 'pocketbook' The command, when MenuOpenMode is 'command' or 'both'
Config.OpenMenuKey.useKey true Open with a key
Config.OpenMenuKey.key 112 The key as a Windows virtual-key code. 112 is F1

Using a notebook item also opens the book, whatever MenuOpenMode is.

#Notebook items

Setting Default What it does
Config.Access.RequireItem true A notebook item is needed to open the book
Config.Access.Item 'pocketbook' The plain notebook. It opens in Config.UI.DefaultTheme
Config.Access.CheckInterval 2000 ms between the server checks that the player still carries a notebook while the book is open. At least 1000
Config.Access.ThemeItems [0] = 'pocketbook_standard' ... [14] = 'pocketbook_plum' One item per colour, 0 to 14. Using one opens the book in that colour; the colour picker shows only the colours the player carries. false: every colour is free in Settings

The colour numbers:

# Item # Item # Item
0 pocketbook_standard 5 pocketbook_darkred 10 pocketbook_mustard
1 pocketbook_dark 6 pocketbook_forest 11 pocketbook_slate
2 pocketbook_pink 7 pocketbook_midnight 12 pocketbook_olive
3 pocketbook_white 8 pocketbook_tobacco 13 pocketbook_teal
4 pocketbook_red 9 pocketbook_sand 14 pocketbook_plum

#Notes

Setting Default What it does
Config.MaxNoteLength 8000 Longest note, in characters

The Notes app also reads an optional Config.Notes table that is not in the shipped config.lua. Add it to change the limits:

luaConfig.Notes = {
    MaxNotes = 50,    -- notes per character, 1 to 200
    MaxTitle = 60,    -- 1 to 120
    MaxLength = 8000, -- body length; falls back to Config.MaxNoteLength, at most 16000
    Tear = true       -- tear a page out onto a blank paper item (needs the Telegraph papers on)
}

#Custom apps

Setting Default What it does
Config.CustomApps.Enabled true Apps from other resources, made with the SDK in sdk/
Config.CustomApps.Maximum 24 Most custom apps the book accepts
Config.CustomApps.RequireInstall true A custom app must be installed from the App Store before it can be used. false: it counts as installed