Configuration
Look, holding and sounds
Config.UI, Config.Holding, Config.Notifications, Config.Wallpaper and Config.UIPrefs: how the book looks, how the character holds it and what it sounds like.
All keys on this page are in config.lua.
#Config.UI
| Setting | Default | What it does |
|---|---|---|
DefaultTheme |
9 |
Cover colour of new characters, 0 to 14. 9 is Sand. The plain pocketbook item is a notebook of this colour |
ShowHand |
false |
true shows a gloved hand holding the book on screen; false shows the book alone |
FingerAnimation |
true |
Finger movement of the drawn hand. Ignored while ShowHand = false |
Scale |
0.75 |
Book size on screen, anchored bottom right. 1.0 is the old full size, 0.75 phone size. 0.4 to 1.5 |
PageTurnMs |
600 |
Duration of the cover and page turn and the hand swipe, in ms. 200 to 2000 |
AppIcons |
'illustrated' |
'illustrated': drawn app icons. 'line': line icons |
ButtonStyle |
'printed' |
'printed': buttons, tags and icons inked on the page with drawn frames. 'classic': filled boxes |
Sounds.Enabled |
true |
Interface sounds, a soft paper set: a fingertip tap for buttons, a soft stamp for the main action, the leather cover opening and closing, a page turned for page turns and tabs, a faint pencil stroke while typing, a muted Morse key in the telegraph |
Sounds.Volume |
0.25 |
0.0 to 1.0. 0.25 is quiet; the old default was 0.4 |
Every action makes one sound only: a click that opens a sheet or turns a page plays the opening, not the tap as well. The sound under the mouse (hover) is off unless a player switches it on.
Players can switch the interface sounds off, set their own volume and turn each kind on or off (taps, typing, hover, openings, Card Table sounds) in Settings. These are the defaults.
#Config.Holding
While the book is open the character holds a small notebook in the right hand and may walk. When a writing field (a telegram, a note, a letter) has the focus, the left hand takes the notebook and the right hand writes with a pencil.
| Setting | Default | What it does |
|---|---|---|
Enabled |
true |
The character holds a notebook while the book is open |
Dict |
'fx_phone@base' |
Animation dictionary for male characters |
DictFemale |
'fx_phone@female' |
Same clips fitted to the female body |
ClipOut, ClipIn |
'phone_out', 'phone_in' |
Take out and open; close and put back |
ClipHold |
'phone_hold' |
Loops while the book is open. false: the last frame of phone_out is held |
Write.Enabled |
true |
The writing pose while a writing field has the focus |
Write.Dict, Write.DictFemale |
'fx_phone_write@base', 'fx_phone_write@female' |
Writing animations |
Write.ClipIn, Write.ClipLoop, Write.ClipOut |
'write_in', 'phone_write', 'write_out' |
Writing clips |
Write.Pencil |
'p_pencil01x' |
Pencil model in the right hand. false: no pencil |
Write.PencilFix |
pos and rot all 0.0 |
Extra shift and turn of the pencil in the hand |
Write.LeftFix |
pos and rot all 0.0 |
Extra shift and turn of the notebook in the left hand |
Write.LeaveDelay |
800 |
ms after leaving a field before the pencil goes away, so moving between fields does not flicker |
OpenSuffix |
'_open' |
The open notebook model is the closed model name plus this, for example fx_pocketbook_sand_open |
FlagOnce, FlagLoop, Ik, Filter |
67109394, 67109393, 1245184, 'UpperbodyFixup_filter' |
Animation flags. Upper body only, so the legs keep walking and the spine stays straight |
Prop |
'fx_pocketbook_sand' |
Notebook model when the theme is unknown |
PropByTheme |
[0] = 'fx_pocketbook_standard' ... [14] = 'fx_pocketbook_plum' |
Notebook model per colour, streamed by fx-pocketbook-assets |
Bone |
'SKEL_R_Hand' |
Hand bone the notebook is attached to |
Offset.male, Offset.female |
positions and rotations on SKEL_R_Hand |
Where the notebook sits in the hand |
AllowWalk |
true |
Walking keys reach the game while the book is open. Weapons, jump and pause stay off |
AllowSprint |
true |
Sprinting while the book is open |
FreeLook |
true |
The mouse turns the view whenever the cursor is off the book. On the book it clicks |
CloseOnMount |
true |
Horse, vehicle, water, ragdoll or death close the book |
TuneCommand |
'pocketbook_hold' |
The command that places the notebook in the hand in game |
#Placing the notebook in the hand
/pocketbook_hold opens the fx-toolbag offset tool with a ghost character. The first tab places the notebook in the right hand, the second tab ("Yazma") places the notebook in the left hand and the pencil in the writing pose. The package does not ship holding.json, so the Offset values are used until someone saves a place. Saving creates holding.json in the resource folder, sends the new place to every player and replaces the Offset values for everybody.
Saving needs the ACE permission command.pocketbook_hold, and fx-toolbag must be started:
cfgadd_ace group.admin command.pocketbook_hold allow
Keep holding.json when you update.
#Config.Notifications
| Setting | Default | What it does |
|---|---|---|
Enabled |
true |
The book's notification box |
Duration |
5000 |
ms a notification stays. The interface keeps it between 1500 and 15000. A sender can give its own duration |
QueueLimit |
5 |
Notifications waiting in the queue. 1 to 20 |
Sound |
'auto' |
Default notification sound of new characters. 'auto' plays the sound of the app that sends it |
SoundByApp |
see below | Which sound each app makes with 'auto'. default is every app not listed |
Volume |
0.6 |
Default loudness of the file sounds, 0.0 to 1.0. Players can change their own |
Sounds |
16 entries | The sounds a player can pick in the setup wizard and Settings |
luaSoundByApp = { default = 'sketch', bank = 'coins', billing = 'coins', borsa = 'coins', company = 'coins', katalog = 'coins',
telegram = 'envelope', darkchat = 'envelope', news = 'paper', takvim = 'watch', saat = 'watch' },
Each entry of Sounds has an id and a name shown to players, and one of:
file: a short sound shipped with the resource, played in the book's interface. The shipped ones are inpreview/assets/sounds/of fx-pocketbook-assets: sketch, bell, chime, telegraph, paper, envelope, coins, pen, cover, watch, latch.soundandset: one of the game's own frontend sounds, for example{ id = 'ledger', name = 'Oyun: Defter', sound = 'INFO_SHOW', set = 'Ledger_Sounds' }.
id = 'auto' follows SoundByApp and id = 'none' is silent.
Every app sends its notifications with its own id, so with 'auto' each app has its own sound, its name and picture on the card, and a badge on its icon. Repeated notices of the same app and kind fold into one card with a "+N new" count. The fields other resources can send are on Notify.
#Config.Wallpaper
| Setting | Default | What it does |
|---|---|---|
Enabled |
true |
Players may set their own wallpaper from a link |
AllowedHosts |
{} |
Empty: any public HTTPS domain. Or a list such as { 'images.example.com' } |
Presets |
16 entries | Ready-made plain paper textures. Each has id, name, file and thumb. Saved as 'preset:<id>'; they work even when Enabled = false |
#Config.UIPrefs
Interface preferences of new characters. Players change them in the setup wizard and Settings.
| Setting | Default | Values |
|---|---|---|
scale |
1.0 |
0.6 to 1.2 |
text |
'normal' |
'small', 'normal', 'large' |
position |
'right-bottom' |
'right-bottom', 'right-middle', 'left-bottom' |
language |
nil |
nil uses Config.Locale |
hints |
true |
Show hints |
sound |
Config.Notifications.Sound |
Notification sound id |
volume |
Config.Notifications.Volume |
0.0 to 1.0 |