Features
Post office
Parcels between post offices, post birds, and the post office as a business: licences, revenue share, delivery rounds, the stamp counter and staff doors.
These parts live inside the Telegraph app. Their settings are in separate files next to it: apps/telegram/parcels_config.lua, birds_config.lua, offices_config.lua, business_config.lua and operations_config.lua.
#Post offices
The post offices are Config.Telegram.Parcels.Offices. Twelve are set: Valentine, Rhodes, Saint Denis, Van Horn, Annesburg, Wallace Station, Riggs Station, Flatneck Station, Armadillo, Tumbleweed, Strawberry and Emerald Ranch. Each has a label, coordinates and a routing bucket.
luavalentine = { label = 'Valentine', x = -178.9489, y = 626.83941, z = 114.08961, bucket = 0 },
A location can be given its own hours, closed with enabled = false, or have its map marker hidden with showBlip = false:
luaConfig.Telegram.Parcels.Offices.valentine.hours = { Enabled = true, Open = 8, Close = 20, UtcOffset = 3 }
offices_config.lua (Config.Telegram.Office) sets the markers and the prompt at the counter:
| Key | Default | What it does |
|---|---|---|
ShowBlips / BlipSprite / BlipScale |
true / 'blip_post_office' / 0.2 |
Map markers |
ShowPrompt / PromptControl / PromptDistance |
true / 0xCEFD9220 (E) / 2.5 |
The counter prompt |
StreamDistance / PollInterval |
60 / 15000 |
When the counter is loaded near the player |
Hours |
{ Enabled = false, Open = 8, Close = 20, UtcOffset = 0 } |
Opening hours on the real server clock. Off: always open |
Atlas lists the post offices on its map when Config.Atlas.IncludePostOffices = true.
#Parcels
The player packs items from the bag (and optionally cash, or cash on delivery) at a post office, addresses the parcel to a telegraph address and sends it to another office. The recipient collects it at that office. Weapons, money items and items listed in BlockItems / BlockTypes cannot be posted. An unclaimed parcel goes back to the sender.
parcels_config.lua (Config.Telegram.Parcels):
| Key | Default | What it does |
|---|---|---|
MaxLines / MaxQuantity |
8 / 100 |
Different items per parcel, count per item |
MaxWeight |
25 |
Weight limit |
MaxOpen |
20 |
Parcels a character may have open |
MaxCash |
10000 |
Cash in a parcel or cash on delivery, in dollars |
BaseFee / FeePerKg |
0.25 / 0.10 |
Postage in dollars |
TravelSeconds / ReturnSeconds |
300 / 120 |
Travel time to the office and back |
ExpiryHours |
72 |
How long a parcel waits to be collected |
AutoReturn |
true |
Send expired parcels back |
Notices |
true |
Telegrams that tell about a parcel |
RemoteHandover |
false |
true: pack and collect without standing at the office |
OfficeDistance |
4 |
Metres from the office point |
WeightMultipliers |
{ vorp = 1, rsg = 0.001 } |
Converts the inventory's weight unit |
BlockItems |
money, cash, gold |
Item names that cannot be posted |
BlockTypes |
weapon, item_weapon |
Item types that cannot be posted |
BlockDegradable |
true |
VORP items with decay cannot be posted |
Item names that start with weapon_ are always refused.
#Post birds
Players buy an owl or a hawk at an open post office, feed, heal and train it, and send a telegram with it. A bird flies to the recipient when they are in the game, otherwise to the recipient's home post office. Sending with a bird needs no telegraph signal. Birds get hungry, tired and older; with DeathEnabled = true they can die. A bird can be renamed, marked as favourite, sold back at a post office or released.
The whistle brings the favourite bird to the player. It is used with the command /pocketbird and needs the birdwhistle item.
birds_config.lua (Config.Telegram.Birds):
| Key | Default | What it does |
|---|---|---|
MaxOwned |
3 |
Birds per character |
MaxAgeDays / DeathEnabled |
90 / true |
Life span, whether birds can die |
HungerPerHour / StarvationDamagePerHour / RestPerHour |
1 / 1 / 8 |
How the gauges change |
MinHealth / MinHunger / MinStamina |
25 / 20 / 25 |
Below these a bird will not fly |
FlightHunger / FlightStamina |
10 / 20 |
Cost of one flight |
XPPerLevel / MaxLevel / FlightXP / TrainXP |
100 / 10 / 20 / 35 |
Experience |
TrainCooldown / RestSeconds |
600 / 120 |
Seconds |
MinFlightSeconds / MaxFlightSeconds |
30 / 900 |
Flight time limits |
BypassReceiveSignal |
true |
The recipient gets a bird letter without signal |
MarketHours / StockPerSpecies / ReservationSeconds / ResaleRatio |
12 / 10 / 300 / 0.5 |
The bird market: offer period, stock, hold time, buy-back share |
FeedItem / HealItem / TrainItem |
birdseed / birdmedicine / birdtraining |
Care items, one used per action |
WhistleItem / WhistleCommand / WhistleCooldown |
birdwhistle / pocketbird / 20 |
The whistle |
HomeOffice |
'valentine' |
Default home post office |
ShowNearbyBirds / VisualRange / VisualLifetime / FlightBlip |
true / 50 / 20000 / true |
What other players see |
Species |
owl (price 15, speed 14), hawk (price 20, speed 19) |
Bird kinds: label, model, price, speed |
Set Config.Telegram.Services.Birds = false to turn birds off, and Config.Telegram.Services.Parcels = false to turn parcels off.
#The post office as a business
A company can hold a licence on a post office. It is set in business_config.lua (Config.Telegram.OfficeBusiness). The job must already exist in your framework and in Config.Company.Jobs. No office is licensed by default.
luaOffices = {
valentine = { Job = 'postoffice', PurchasePrice = 500, TaxPrice = 25, PeriodSeconds = 604800, GraceSeconds = 86400 },
},
A manager buys the licence and pays the period tax at the office, from the company till. While the licence is active, the company receives Revenue.SharePercent (default 100) of the fees taken at that office for the services switched on in Revenue.Services: parcel dispatch, board notices, address registration and bird sales.
With a licence, operations_config.lua (Config.Telegram.Operations) gives the staff work:
| Key | Default | What it does |
|---|---|---|
Missions |
Enabled = true, Stops = 2, Reward = 10, CooldownSeconds = 900, LifetimeSeconds = 7200 |
Delivery rounds from the licensed office. The reward in dollars goes to the company till when the round is finished |
Missions.Destinations |
{} |
Empty: the nearest offices in the same bucket |
Missions.Visual |
p_mailbags01x |
The mail bag shown at stops |
Workshop |
Enabled = true, MaxPurchase = 20, ReservationSeconds = 900 |
The stamp counter |
Workshop.Recipes.stamp |
1 pocketbook_paper -> 5 pocketbook_stamp, 30 s, price 0.25 |
Staff craft stamps into office stock; players buy them |
Wardrobe |
{ Enabled = false, Script = 'auto' } |
Optional staff wardrobe |
Doors |
{} |
Map door hashes per office that staff can open |
DoorAccessSeconds |
15 |
How long a door stays open |
Staff rights come from the company permissions postalWork and postalDoors (see Business).