Start
FX Pocketbook
What FX Pocketbook is, its 29 apps, what it needs, what is in the three resources and where to go next.
#What it is
FX Pocketbook (fx-pocketbook) is a pocket notebook for RedM servers, the 1899 version of a phone. The character takes a leather notebook out of the pocket, turns the cover and uses its pages: telegrams, a bank, a ledger of bills, a newspaper, a map, a phonograph and 29 apps in all.
It runs on VORP or RSG, keeps its data in its own fx_pocketbook_* database tables and sets up those tables by itself on start. Signal comes from towns and from relay poles players set up; the separate fx-radio back radio adds signal anywhere. Fifteen notebook colours are sold in a store with its own NPC and wagon, and the radio set too while fx-radio runs.
Other resources connect to it through exports and the custom app SDK. See All exports.
#The 29 apps
Grouped as the App Store groups them. Names are the English names the book shows. Every app is described on Apps overview.
| Category | Id | Name | What it does |
|---|---|---|---|
| Communication | telegram |
Telegraph | Send and receive telegrams from your own telegraph address. Parcels and mail birds live here too |
| Communication | contacts |
Contacts | Your telegraph address book |
| Communication | darkchat |
Night Post | Secret chat channels under an alias |
| Communication | cagri |
Call Desk | Call a doctor, the sheriff, a smith, the coach, a vet or the undertaker |
| Communication | pano |
Town Board | Read every town's notices and pin a paid notice on the board of the town you stand in |
| Finance | bank |
Bank | Your real bank balance, deposits and withdrawals in town, extra and shared accounts, money requests |
| Finance | billing |
Ledger | See and pay your bills; write bills for your business |
| Finance | borsa |
Stock Bulletin | Buy and sell shares in railway, mining, oil and bank companies |
| Daily | notes |
Notes | Personal notes |
| Daily | stables |
Stables | Your horses and wagons, which stable they are in, and choosing or calling a horse when the stable script allows it |
| Daily | kartlarim |
My Cards | Identity papers, licences and deeds in one wallet. Show a paper to someone nearby, hand out or take back deed keys |
| Daily | takvim |
Calendar | Your own events and reminders, and town events such as the rodeo, the fair and train times |
| Daily | hekim |
Physician | Your health cores as a doctor's chart, a route to the nearest doctor and a way to call one |
| Daily | almanak |
Almanac | Today's weather, sunrise and sunset, the moon and the best hours for hunting and fishing |
| Daily | eskiz |
Sketch | Hand drawing with pencil, ruler and stamps. Keep sketches and give them to someone nearby |
| Daily | katalog |
Catalogue | Mail order from shop catalogues; a courier brings it to you, or it waits at a post office or stable |
| Work | company |
Business | Employees, announcements and the business till for the jobs you configure |
| Work | mdt |
Official Ledger | Records for sheriffs, doctors, the railway and the court |
| Map | atlas |
Atlas | Map, saved places, directions and location sharing with friends |
| News | news |
Gazette | Read the news; journalists write and publish |
| Entertainment | music |
Phonograph | Listen to music, make playlists and play it to people around a placed phonograph |
| Entertainment | album |
Album | Keep photographs as links, in collections |
| Entertainment | kartmasasi |
Card Table | Poker dice, faro, blackjack and dominoes against the house |
| Tools | calculator |
Calculator | Add, subtract, multiply and divide. Needs no signal |
| Tools | pusula |
Compass | A live compass and the direction and distance of the towns |
| Tools | saat |
Pocket Watch | Game or real time, a stopwatch, a kitchen timer and alarms |
| System | faq |
FAQ | Short help for players. You write the questions |
| System | settings |
Settings | Cover colour, wallpaper, text size, position, language and sounds |
| System | store |
App Store | Install and remove apps |
FAQ, Settings and App Store cannot be removed. Which apps a new character starts with is set in Config.Store.Apps (preinstalled). See App Store and home page.
#Requirements
| Requirement | Notes |
|---|---|
| oxmysql | Required. Listed in the manifest's dependencies |
| fx-pocketbook-assets | Required. Listed in the manifest's dependencies. The second resource of the package |
| VORP or RSG | vorp_core with vorp_inventory, or rsg-core with rsg-inventory |
| InnoDB tables | pocketbook_health reports any fx_pocketbook_* table that is not InnoDB |
How the framework is chosen: Config.Framework = 'auto' uses VORP when vorp_core is started and RSG when rsg-core is started. If both are started, no framework is selected and you must set Config.Framework = 'vorp' or 'rsg' yourself. A named framework that is not started is not used. The same rule is used on the server (server/framework.lua) and in framework/frameworks.lua.
Adapters in framework/frameworks.lua, picked by 'auto' unless you set a mode:
| Part | Setting | Adapters | What 'auto' picks |
|---|---|---|---|
| Bank | Config.Bank.Mode |
vorp (vorp_banking), rsg (rsg-banking), internal, custom |
VORP with vorp_banking started: vorp. RSG with rsg-banking started: rsg. Otherwise internal, the book's own bank table |
| Stables | Config.Stables.Mode |
gum (gum_stables), vorp (vorp_stables), rsg (rsg-horses, wagons from rsg-wagons), internal, custom |
RSG with rsg-horses: rsg. VORP with gum_stables: gum, else with vorp_stables: vorp. Otherwise internal, which means no stable script is connected |
| Store money and items | FXShop |
VORP and RSG | Follows the framework |
custom is an empty adapter with comments that you fill in for any other bank or stable script. See Finance apps and Daily apps.
Optional resources the code looks for:
| Resource | What it adds |
|---|---|
| ox_target, murphy_interact, pc_interaction or rsg-target | Target interaction at the store NPC and the phonograph. Without one, a hold prompt is shown |
| fx-hud | Hidden while the store camera is open |
| fx-toolbag | Needed only for /pocketbook_hold, the in-game tool that places the notebook in the hand |
#What is in the package
| Resource | What it is |
|---|---|
fx-pocketbook |
The notebook: client, server and shared scripts, the interface (preview/), the 29 apps (apps/<id>/), config files, framework/frameworks.lua, locales in 10 languages, the custom app SDK (sdk/), setup/ and sql/install.sql |
fx-pocketbook-assets |
Large images and sounds, kept apart so a code update does not make players download them again: cover and paper themes, wallpapers, store plates, Eskiz papers, notification sounds, the pictures of the News, Bank, Telegraph, Town Board and Card Table apps, the Atlas map tiles and road network. Its stream/ folder holds the 15 notebook models, closed and open |
fx-pocketbook-anims |
The animations of holding and writing in the notebook (fx_phone@base, fx_phone_write@base and their female versions). The client prints is fx-pocketbook-anims started? when it cannot load them |
The interface reads the second resource at https://cfx-nui-fx-pocketbook-assets/<path>. Its folder name must stay fx-pocketbook-assets, or <pocketbook resource name>-assets if you renamed the notebook.
#Files you can edit
These files are not encrypted (escrow_ignore in the manifest):
| File | What it holds |
|---|---|
config.lua |
General settings: framework, language, opening, notebook items, look, holding, signal, notifications, wallpapers, App Store, home page |
config_shops.lua |
The notebook store: NPC, blip, hours, preview, wagon, items and prices, store texts |
config_server.lua |
Logs and the Discord webhook. Server only |
apps/<id>/config.lua |
Settings of one app |
apps/<id>/config_server.lua |
Server-only settings of one app: its logs and keys |
apps/telegram/*_config.lua |
Parcels, mail birds, post offices, office business and postal work |
framework/frameworks.lua |
Bank, stable and store adapters, and the short game notice |
locales/.json, apps/<id>/locales/.json |
Texts in de, en, es, fr, it, nl, pl, pt, ru and tr |
#Where to go next
- Install it: Installation, Items.
- Change settings: config.lua and the other Configuration pages.
- Something is wrong: Troubleshooting.
- Write scripts against it: All exports.