Configuration

Daily apps

Settings of Stables, My Cards, Calendar, Catalogue, Physician, Almanac, Compass, Pocket Watch, Sketch and FAQ.

Every app here has Enabled = true in its file; false switches it off. The texts in these files are shown to players. Several of them say not to use Turkish letters, because the book's font does not show them.

#Stables: apps/stables/config.lua

The connection to your stable script is in framework/frameworks.lua (FXStables).

Setting Default What it does
Mode 'auto' 'auto', 'vorp', 'rsg', 'gum', 'internal' or 'custom'. Auto: RSG with rsg-horses is 'rsg', VORP with gum_stables is 'gum', VORP with vorp_stables is 'vorp', otherwise 'internal' (no stable script connected)
RequireSignal false The app needs signal
CallCooldown 15 Seconds before the same character can call a horse again
ModelLabels {} Names for horse models: { A_C_Horse_Arabian_White = 'Arap Beyaz' }. Without one, the name is made from the model
Wagons true The wagons tab: the character's wagons from gum_stables, vorp_stables or rsg-wagons. List only
WagonLabels {} Names for wagon models: { cart04 = 'Ciftlik arabasi' }
Gum.AllowSetActive false Choosing the active horse by SQL. gum_stables is closed code and may keep its own copy in memory; do not turn this on before you test it in game. Calling a horse is not possible with gum
Gum.StableNames nil { [1] = 'Valentine', ... }. nil: read from gum_stables/cfg/configCoords.lua
Vorp.AllowSetActive true Changes the default horse of vorp_stables and asks it to reload
Rsg.AllowCall true Calling the active horse through rsg-horses
Rsg.StableNames {} { valentine = 'Valentine Ahiri' }

For another stable script set Mode = 'custom' and fill in the custom adapter in framework/frameworks.lua.

#My Cards: apps/kartlarim/config.lua

Documents (identity papers, licences) and deeds are issued by other scripts through the exports listed in setup/EXPORTS.md. This file sets only how each type looks and its default texts.

Setting Default What it does
ShowDistance 5.0 "Show" and "Give key" reach players this close. The server measures again
PickerDistance 15.0 Players further than ShowDistance but within this are listed as "far" and cannot be picked
ShowCooldown 3 Seconds between two "Show"
SeenSeconds 120 A shown document can be opened by the other player for this long
MaxKeys 8 Key holders per deed
YearOffset -127 The year printed is the real year plus this. -127 turns 2026 into 1899. 0: the real year
Waypoint { RouteColor = 'COLOR_YELLOW', ArrivalDistance = 15.0 } "Mark location": the route line, removed on arrival
AutoIdentity { Enabled = true, Type = 'kimlik' } An identity document is created the first time a character opens the wallet, with the framework name. If an office sells identity cards, set Enabled = false
DocumentTypes kimlik, avci, balikci, silah, saglik, at Document types, see below
DeedTypes ev, ciftlik, dukkan, ahir { label, icon, color, prefix }. prefix starts the parcel number when the export gives none
Registrar { name = 'E. Fontaine', role = 'Tapu memuru' } Signature under a deed

A document type:

luaavci = { label = 'Avci Ruhsati', icon = 'bow-arrow', color = 'green', prefix = 'AV', days = 30,
    office = 'Serif Dairesi, Valentine', signer = 'L. Malloy', role = 'Serif', class = 'Buyuk av',
    terms = 'Geyik, ayi ve bizon avina izin verir. ...' },

label is the card name, office the issuing office, signer and role the signature, class the line under it, prefix the start of the document number, days the validity (0: no end), terms the conditions text. Colours: blue, green, teal, plum, red, ochre. An export can change every field, and a type that is not in the list can also be issued; it looks plain.

With AutoIdentity on, a revoked identity card is created again the next time the player opens My Cards. Use SetDocumentStatus(id, 'hold') instead, or turn AutoIdentity off.

#apps/kartlarim/config_server.lua

Setting Default What it does
API.AllowedResources {} Resources allowed to call the My Cards exports: { ['my-housing'] = true }. Empty: every resource
Identity function Extra lines on the automatic identity document. Returns { birth, class, terms }. The shipped one writes the RSG birth date, or the VORP age as '<age> yas'

#Calendar: apps/takvim/config.lua

Date and time are the server machine's real calendar; only the year printed is shifted.

Setting Default What it does
YearOffset -127 As in My Cards
MaxEvents 60 Events and town reminders one character can keep
KeepDays 60 Past events are deleted after this many days
AgendaDays 45 How far ahead the Agenda tab shows town events
ReminderMinutes { 0, 10, 60, 1440 } Reminder choices in minutes. 0: none
Waypoint { RouteColor = 'COLOR_YELLOW', ArrivalDistance = 15.0 } "Mark location"
TownEvents 4 events Events every player sees. Players cannot change them; they can set a reminder and mark the place
lua{ id = 'rodeo', title = 'Valentine Rodeosu', place = 'Valentine meydani', icon = 'horse-human',
  note = 'Yabani at binme ve kement yarisi. ...',
  every = 'week', days = { 6 }, time = '21:00', coords = vector3(-281.0, 793.0, 119.0) },
Field What it is
id Short unique name: lower case, digits, _. Changing it drops reminders already set
every 'day', or 'week' with days (1 = Monday ... 7 = Sunday)
dates One-off days { 'YYYY-MM-DD', ... } on the real calendar, in place of every
time 'HH:MM', server time
coords vector3. Without it "Mark location" is off
icon Icon name

#apps/takvim/config_server.lua

PaymentDays is a function you can write to show things the player must pay (bills, taxes, rent) in the calendar, read only. The calendar never pays anything. It returns at most 20 rows { title, place, note, at = <unix time> }; an error counts as an empty list. The file has a commented example that reads the open Ledger bills. Default: nil.

#Catalogue: apps/katalog/config.lua

Mail order. The player picks products and pays; a courier brings the order, or it waits at a post office or stable.

Setting Default What it does
MaxLines 12 Different products in one order
MaxQty 20 Most of one product, unless the product has its own max
MaxActive 3 Orders waiting for delivery per player
OrdersShown 20 Rows in My Orders
ImagePath 'auto' Product pictures from the inventory's image folder, by the product's item. 'auto': VORP nui://vorp_inventory/html/img/items/<item>.png, RSG nui://rsg-inventory/html/images/<item>.png. Another inventory: a path with %s for the item name, such as 'nui://my_inventory/html/images/%s.png'. false: no pictures, the drawings are shown. A missing picture also falls back to the drawing
Payments { cash = true, bank = true } Cash on hand, or the bank the book is connected to (FXBank)
Places.here { enabled = true, fee = 2.50, prep = 60, travel = 120 } Delivery to where the player stands. travel is only an estimate; the courier really rides there
Places.post { enabled = true, fee = 1.00, prep = 60, travel = 240, points = nil } Delivery to a post office. points = nil: the Telegraph offices
Places.stable { enabled = true, fee = 1.50, prep = 60, travel = 180, points = { ... } } Delivery to a stable. 7 stables; replace them with your stable script's points
Pickup { Distance = 2.5, Control = 0xCEFD9220, KeepDays = 14, Blip = true } Collecting at an office or stable. An uncollected parcel waits KeepDays, then closes without a refund. 0: waits forever
Courier.Type 'horse' 'horse' or 'wagon'
Courier.PedModels, HorseModels, WagonModel 3 peds, 3 horses, 'cart06' Courier models
Courier.SpawnDistance 110.0 Metres away the courier appears
Courier.Speed 2.0 1.0 walk, 2.0 trot, 3.0 gallop
Courier.HandoverDistance 3.5 Distance for the "Collect" key
Courier.Control 0xCEFD9220 E
Courier.TimeoutSeconds 600 If the courier cannot deliver in this time, the parcel is left at the nearest post office
Courier.RetrySeconds 20 Retry when the courier could not spawn (player inside, loading)
Courier.LeaveSeconds 15 Time before the courier rides off and disappears
Courier.Blip true Courier blip, for the receiver only
Courier.Names 5 names Courier names
Shops 6 shops { id, name, town, icon, color }
Items 30 products See below

fee is in dollars, prep (time in which the order can still be cancelled) and travel in seconds.

lua{ id = 7, shop = 'general', name = 'Bira ficisi', icon = 'barrel', price = 9.00, unit = 'fici', item = 'beer',
  amount = 5, max = 5, text = 'Mese ficida koyu bira.' },

id is a number that never changes. item is the inventory item on your server: replace the shipped names with yours, because a product whose item does not exist cannot be delivered. price is per unit in dollars, amount how many items one unit gives, max the most of this product per order.

#Physician: apps/hekim/config.lua

Shows the health, stamina and dead-eye cores from the game, and hunger and thirst from the framework when it keeps them.

Setting Default What it does
Fahrenheit true Weather line in Fahrenheit. false: Celsius
Offices 6 offices { name, coords } of doctors' offices for the route. Approximate doors; correct them for your map

#Almanac: apps/almanak/config.lua

Weather and temperature are read from the game where the player stands; sun and moon are worked out from the game's date. No server request, no database.

Setting Default What it does
Year 1899 Year printed on the page. Day and month are the game's
Fahrenheit true false: Celsius
Latitude 38.0 Latitude used for sunrise and sunset

#Compass: apps/pusula/config.lua

The heading is read on the player's own game only while the compass page is open. Nothing goes to the server.

Setting Default What it does
Heading 'camera' 'camera': the way the player looks. 'body': the way the character faces
Towns nil Towns on the dial. nil: the Bank's CashInTown.Towns. Or your own { { town, coords, radius } }
TownRadius 220 Metres. Nearer than this to a town (or its own radius) reads "you are here"

#Pocket Watch: apps/saat/config.lua

Alarms are kept per character in fx_pocketbook_alarms and ring as a notification, book open or not.

Setting Default What it does
MaxAlarms 8 Alarms per character, 1 to 8
TimerPresets { 1, 3, 5, 10, 15 } Minutes offered by the kitchen timer

#Sketch: apps/eskiz/config.lua

Sketches are saved as drawing steps (JSON), not as pictures. Ctrl shortcuts (Z undo, Shift+Z or Y redo, C copy, X cut, V paste, A select all) work with any keyboard layout and need no setting.

Setting Default What it does
Year 1899 Year next to the date on a sketch
MaxOps 600 Drawing steps per sketch (line, shape, stamp, text)
MaxPoints 1500 Points in one free line
MaxBytes 200000 Largest saved sketch in bytes
MaxSketches 24 Sketches per character
MaxInbox 24 Sketches in the received box. When full, new ones are refused
ListBytes 300000 Drawing data sent at once when the list opens. Bigger sketches are fetched one by one
ShareDistance 5.0 A sketch can be given only to a player this close
SaveCooldown, ShareCooldown 2, 8 Seconds between two saves and two shares

#FAQ: apps/faq/config.lua

Config.FAQ.Items is the list of questions. Rewrite it for your server.

lua{ category = 'Baslarken', q = 'Defteri nasil acarim?',
  a = 'Envanterinizdeki Pocketbook esyasini kullanin ya da F1 tusuna basin. ...' },

Optional: icon = 'bank-outline' on a row sets the icon of that category's box. Without it, the built-in categories use their own icon.