Configuration

Telegraph

Settings of the Telegraph app: addresses, letters, the notice board, parcels, mail birds, post offices, office businesses, postal work and government telegrams.

The Telegraph reads seven files in apps/telegram/: config.lua, parcels_config.lua, birds_config.lua, offices_config.lua, business_config.lua, operations_config.lua and the server-only config_server.lua. Money amounts on this page are in dollars.

#Config.Telegram: config.lua

Setting Default What it does
Enabled true The app
PageSize 12 Telegrams per page
MaxSubject, MaxBody 120, 6000 Subject and message length
MaxContacts 200 Contacts per mailbox
MaxMailbox 2000 Telegrams a mailbox can hold. A full mailbox refuses new mail
MaxPending 100 Telegrams one player can have waiting for delivery
ContactTransfer { Enabled = true, BatchSize = 25, MaxBytes = 100000 } Handing a copy of your contacts to another player. Existing notes are never overwritten
DeliveryInterval 5000 ms between delivery runs
BatchSize 50 Telegrams delivered per run
AllowAnonymous true Unsigned telegrams
AllowCustomAddress true Players choose their own address
AddressMin, AddressMax 3, 24 Address length. Capital letters, digits, - and _
ReservedAddresses { 'ADMIN', 'POLICE', 'SYSTEM', 'POSTMASTER' } Addresses players cannot take
Registration.Fee 0 Price of an address
Registration.Terms '' Terms text shown when registering
Registration.BlockedWords {} Words an address may not contain
Registration.CancelPending true An unpaid, unresolved registration can be cancelled by its owner
Closure.Enabled true Players can close their own mailbox. The public address is released, history is kept
Closure.RefundPercent 0 Share of the registration fee paid back on closing, 0 to 100
Closure.CooldownSeconds 3600 Wait before the character can register again
Services { Drafts = true, Directory = true, Board = true, Profile = true, Shared = true } Entries of the services menu. false hides one. Birds and Parcels are set in their own files
SharedMailboxes Enabled = true, Jobs = { sheriff = { Address = 'SHERIFF-POST' }, newspaper = { Address = 'PRESS-POST' } } One mailbox per business job. Match the job names to Config.Company.Jobs
Official { Enabled = true, SharedMailboxes = true, Entries = {} } Contacts > Official records: read-only boxes every player sees. SharedMailboxes = true lists the business boxes. Entries adds your own, see below. Only addresses that exist are shown
MaxDrafts 20 Drafts per mailbox
DirectoryCategories { 'Kişisel', 'Ticaret', 'Hizmet', 'Meslek' } Categories of the public directory
ProfileImageHosts {} Hosts allowed for profile pictures. Empty: any
Stationery { Enabled = true, Images = true, CustomStamps = true, Drawing = true, MaxStrokes = 32, MaxPoints = 100, AllowedHosts = {} } Letter paper: pictures, custom stamps and drawings on the letter
DrawnSignature { Enabled = true, MaxStrokes = 16, MaxPoints = 80 } A hand-drawn signature saved on the profile and copied onto each letter sent
Papers { Enabled = true, BlankItem = 'pocketbook_paper', LetterItem = 'pocketbook_letter', PageSize = 12 } Letters on paper items that can be handed over
Postage { Enabled = false, Item = 'pocketbook_stamp' } true: sending a telegram over the network uses up a stamp item, also for queued mail
Board.MaxBody, Board.MaxTitle 1200, 100 Notice board text lengths
Board.MaxActive 5 Active notices per mailbox
Board.DurationHours 72 Hours a notice stays
Board.PostFee 0 Price of a notice
Board.AllowAnonymous true Unsigned notices
Board.ClearOnRestart false Expire every active notice on start
Board.ModeratorJobs { sheriff = 4, newspaper = 4 } Job and lowest grade that can remove notices. The ACE fx-pocketbook.postmaster can too

An Official.Entries row:

lua{ address = 'VAL-POST', name = 'Valentine Posta Dairesi', icon = 'email-outline', note = '...' }

#Parcels: parcels_config.lua

Config.Telegram.Services.Parcels = true turns parcels on.

Setting Default What it does
MaxLines 8 Different items in one parcel
MaxQuantity 100 Most of one item
MaxWeight 25 Most weight
MaxOpen 20 Parcels one player can have waiting
MaxCash 10000 Largest cash-on-delivery or gift amount
BaseFee, FeePerKg 0.25, 0.10 Postage: base plus per kg
TravelSeconds 300 Time to the destination office
ReturnSeconds 120 Time back to the sender
ExpiryHours 72 A parcel not collected in this time expires
AutoReturn true Expired parcels go back to the sender
Notices true Notices about parcels
SweepInterval, SweepBatch 15000, 20 ms between checks and parcels per check
RemoteHandover false true: hand in and collect without standing at an office
OfficeDistance 4 How close to an office the player must stand
WeightMultipliers { vorp = 1, rsg = 0.001 } Converts the inventory's item weight to kg
BlockItems { money = true, cash = true, gold = true } Items that cannot be sent
BlockTypes { weapon = true, item_weapon = true } Item types that cannot be sent
BlockDegradable true VORP items that degrade cannot be sent, because their fields cannot be restored on delivery
Offices 12 offices valentine = { label = 'Valentine', x = -178.9489, y = 626.83941, z = 114.08961, bucket = 0 }. Also used by mail birds, the Catalogue, Atlas and postal work

Per office you can also set hours = { Enabled = true, Open = 8, Close = 20, UtcOffset = 3 }, enabled = false to close it completely, showBlip = false to hide its marker, and an optional clerk npc = { model = '...', x = ..., y = ..., z = ..., h = ... }. No clerk is spawned by default.

#Mail birds: birds_config.lua

Config.Telegram.Services.Birds = true turns mail birds on. A bird carries a telegram to the receiver's home office.

Setting Default What it does
MaxOwned 3 Birds per character
MaxAgeDays, DeathEnabled 90, true With DeathEnabled, a bird dies at 0 health or after this many days
HungerPerHour, StarvationDamagePerHour, RestPerHour 1, 1, 8 Hourly change of hunger, health while starving and stamina while not flying
MinHealth, MinHunger, MinStamina 25, 20, 25 A bird below any of these cannot fly
FlightHunger, FlightStamina 10, 20 Taken by each flight
XPPerLevel, MaxLevel 100, 10 Levels. Each level makes the bird 5% faster
FlightXP, TrainXP, TrainCooldown 20, 35, 600 XP per flight and per training; seconds between trainings
RestSeconds 120 Rest after a flight
MinFlightSeconds, MaxFlightSeconds 30, 900 Flight time is distance divided by speed, kept between these
DeliveryInterval, DeliveryBatch 5000, 30 ms between arrival checks and flights per check
BypassReceiveSignal true A bird delivers even when the receiver has no signal
MarketHours, StockPerSpecies 12, 10 The bird market changes every 12 hours with 10 of each species
ReservationSeconds 300 How long a purchase in progress holds a bird
ResaleRatio .5 Share of the price paid when a bird is sold back
FeedItem, HealItem, TrainItem 'birdseed', 'birdmedicine', 'birdtraining' Care items
WhistleItem, WhistleCommand, WhistleCooldown 'birdwhistle', 'pocketbird', 20 Calling the bird. '' removes the item or the command
HomeOffice 'valentine' Office used when the receiver has none set
ShowNearbyBirds, VisualRange, VisualLifetime true, 50, 20000 Other players within the range also see a player's bird when it is sent or called. The bird is shown for that many ms
FlightBlip true The owner sees a blip of the flying bird
Species owl, hawk { label, model, price, speed }. Owl: A_C_Owl_01, 15, speed 14. Hawk: A_C_Hawk_01, 20, speed 19

#Post offices: offices_config.lua

Setting Default What it does
ShowBlips, BlipSprite, BlipScale true, 'blip_post_office', .2 Office blips
ShowPrompt, PromptControl, PromptDistance true, 0xCEFD9220 (E), 2.5 The prompt at an office
StreamDistance 60 Clerks are spawned within this distance
PollInterval 15000 ms between office state checks
Hours { Enabled = false, Open = 8, Close = 20, UtcOffset = 0 } Opening hours on the real server time, with an explicit UTC offset. Each office can override it with its own hours

#Office businesses: business_config.lua

A player business can buy the licence of a post office and earn from its services. Office ids are the keys of Parcels.Offices; the jobs must exist in your framework and in Config.Company.Jobs.

Setting Default What it does
Enabled true Office businesses
SweepSeconds 60 Seconds between licence checks. At least 15
Revenue.Enabled true Fees of the office's services go to the licensed business
Revenue.SharePercent 100 Share of the fee paid to the business
Revenue.PollSeconds, Revenue.BatchSize 15, 20 Payment runs
Revenue.Services { parcel_dispatch = true, telegram_board = true, telegram_registration = true, bird_buy = true } Which fees are shared. Refundable fees stay reserved until the mailbox is closed or the bird retired
Offices {} One entry per office, see below
luaOffices = {
    valentine = { Job = 'postoffice', PurchasePrice = 500, TaxPrice = 25, PeriodSeconds = 604800, GraceSeconds = 86400 },
}

PeriodSeconds is the tax period (1 hour to 1 year), GraceSeconds the time allowed after it.

#Postal work: operations_config.lua

Postal work does not need signal.

Setting Default What it does
Enabled true Postal work
Missions.Enabled true Delivery runs between offices
Missions.Stops, Missions.Reward 2, 10 Stops per run and pay
Missions.CooldownSeconds, Missions.LifetimeSeconds 900, 7200 Wait between runs; time to finish one
Missions.MaxTravelSpeed, Missions.MinLegSeconds 35, 15 A leg must take at least distance / speed, and at least this many seconds
Missions.DeliveryDistance 4 How close to the stop
Missions.Destinations {} Empty: the closest offices in the same routing bucket, then back
Missions.Visual { Enabled = true, Model = 'p_mailbags01x', StreamDistance = 45, GroundOffset = -1.0 } Mail bag at the stop
Workshop.Enabled true Making goods at the office
Workshop.MaxPurchase 20 Most bought at once
Workshop.ReservationSeconds 900 Unpaid, untouched reservations expire. 0: never
Workshop.Recipes stamp { Label = 'Posta pulu', Input = 'pocketbook_paper', InputCount = 1, Item = 'pocketbook_stamp', OutputCount = 5, Seconds = 30, Price = 0.25 }. The input must be a single stack that does not degrade. Output goes into the office stock
Wardrobe { Enabled = false, Script = 'auto' } Opens a clothing store from the office. 'auto' uses jo_clothingstore or murphy_clothing, whichever is started
Doors {} Door hashes per office: valentine = { { id = <door hash>, label = 'Giriş' } }. Only doors you list
DoorAccessSeconds 15 Seconds a door stays open for an employee, 5 to 60

#Server only: config_server.lua

Setting Default What it does
Administration.Enabled true Government telegrams and forced mailbox closing
Administration.AllowedResources {} Resources allowed to use the administration exports: { ['my-government'] = true }
Administration.SenderAddress, SenderName 'SYSTEM', 'Resmî Telgraf Dairesi' Sender of government telegrams
Administration.MaxActiveBroadcasts 3 Broadcasts running at once
Administration.MaxBroadcastRecipients 10000 Most mailboxes one broadcast reaches
Administration.BroadcastBatchSize 25 Mailboxes per delivery step
Administration.ForcedClosure { Enabled = true, RefundPercent = 0, CooldownSeconds = 86400 } Closing a mailbox by an admin, also when its owner is offline. Items in custody and unresolved money still block it
Administration.BroadcastTemplates {} The only texts a broadcast can send: ['notice'] = { subject = '...', body = '...' }
Logs See config_server.lua

Send a template from the console with pocketbook_broadcast notice <nonce>. See Installation.