Configuration
Other settings
Admin, retention and limits, AirDrop, Arcade, Calendar, Darkchat, Mail, 3D map, Marketplace, News, Pets, Voice Memos and Weather.
The smaller files in configs/, one section per file.
#Config.Admin
File: configs/config_admin.lua. Roles are explained on Admin.
| Setting | Type | Default | What it does |
|---|---|---|---|
Admin.TrashDays |
number | 3 |
Deleted accounts, posts, comments, stories, listings and news can be restored for this many days |
Admin.BackupDays |
number | 3 |
Daily database snapshots kept in backups/ |
Admin.Command |
string | 'phoneadmin' |
Command that opens the admin tablet |
Admin.Ace |
table | god = 'fxphone.god', admin = 'fxphone.admin', moderator = 'fxphone.mod' |
ACE permission per role |
Admin.FrameworkAdminsAre |
string or false |
'admin' |
Role given to framework admins: 'god', 'admin', 'moderator' or false |
Admin.AuditDays |
number | 90 |
Days the admin audit log is kept. 0 keeps it forever. An audit entry in Config.Retention overrides it |
#Config.Retention
File: configs/config_retention.lua. Days before old data is deleted by the daily clean-up at 04:00 server time. 0, or leaving a key out, keeps everything of that kind. The admin tablet can change each value while the server runs.
| Key | Default | What is deleted |
|---|---|---|
messages |
30 |
Chat messages |
mail |
3 |
Mail from scripts in the phone inbox, and mail in the trash |
listings |
3 |
Marketplace listings |
posts |
90 |
Social posts |
invoices |
90 |
Paid and cancelled invoices. Unpaid ones are money owed and stay |
darkchat |
15 |
Darkchat messages |
notifications |
7 |
Stored notifications |
voicemail |
30 |
Voicemail messages |
mailbox |
30 |
Mail between players' addresses |
snaps |
30 |
Snaps, opened or not |
news |
90 |
News stories |
stories |
1 |
Expired and deleted stories |
swipes |
30 |
Flame swipes, so those people show up again |
reports |
90 |
Handled reports. Open ones stay |
wallet |
7 |
Wallet cards from scripts, this many days after they expired |
audit |
not set | The admin audit log. It follows Config.Admin.AuditDays unless you add audit = <days> |
#Config.Limits
File: configs/config_retention.lua.
| Setting | Type | Default | What it does |
|---|---|---|---|
Limits.MessageLength |
number | 1000 |
Characters per message |
Limits.UploadBytes |
number | 6 1024 1024 |
Largest upload, in bytes |
Limits.TransferMax |
number | 1000000 |
Largest bank transfer and invoice |
Limits.CashMessageMax |
number | 50000 |
Largest cash amount or request in a chat |
Limits.AppPriceMax |
number | 100000 |
Highest App Store price a custom app registered by another resource may ask. Higher prices are lowered to it |
Limits.VideoSeconds |
number | 30 |
Longest video recording |
#Config.Airdrop
File: configs/config_airdrop.lua.
| Setting | Type | Default | What it does |
|---|---|---|---|
Airdrop.Enabled |
boolean | true |
AirDrop on or off |
Airdrop.Range |
number | 12.0 |
Metres. Only players this close show up as AirDrop devices |
Airdrop.OfferSeconds |
number | 30 |
An offer nobody answers is withdrawn after this many seconds |
#Config.Arcade
File: configs/config_arcade.lua. The Arcade app has Hop, Merge, Mines, Serpent, Stack, Drop Four and Tic Tac, with city records and leaderboards. Drop Four and Tic Tac are played on the server, against the phone or a friend (by phone number, both online).
| Setting | Type | Default | What it does |
|---|---|---|---|
Arcade.Enabled |
boolean | true |
Arcade on or off |
Arcade.Leaderboard |
number | 20 |
Players shown per game |
Arcade.AiSlip |
number | 0.2 |
How often the phone misses a block or plays a loose move. 0: never |
#Config.Calendar
File: configs/config_calendar.lua.
| Setting | Type | Default | What it does |
|---|---|---|---|
Calendar.PublicApproval |
boolean | true |
Public events wait in the Approvals list until phone staff accept them |
Calendar.MaxEvents |
number | 200 |
Upcoming events one character may keep |
Calendar.MaxPublicPerDay |
number | 3 |
Public events one character may announce per day |
#Config.Darkchat
File: configs/config_darkchat.lua.
| Setting | Type | Default | What it does |
|---|---|---|---|
Darkchat.BlacklistedJobs |
string list | an example list | Players with these jobs cannot use Darkchat at all, for example { 'police' }. Set it to your server's jobs |
Darkchat.MemberLimit |
number | 25 |
Members per channel. The admin tablet can change it while the server runs |
#Config.Mail
File: configs/config_mail.lua. Mail addresses players open in Mail (name@domain) and write to each other with.
| Setting | Type | Default | What it does |
|---|---|---|---|
Mail.Domains |
string list | lsmail.com, eyefind.info, weazel.news |
Domains players can pick for an address |
Mail.MaxAccounts |
number | 3 |
Addresses one character may own |
Mail.MaxRecipients |
number | 5 |
Addresses one mail may go to |
Mail.MaxPerDay |
number | 60 |
Mails one character may send in 24 hours |
#Config.Map3D
File: configs/config_map.lua. With fx-3dmap running, the phone reports its blips to it: the phone shops and the Anon trace zone. The blips on the game's own map stay as they are. Without fx-3dmap none of this does anything. See Map integration.
| Setting | Type | Default | What it does |
|---|---|---|---|
Map3D.Enabled |
boolean | true |
Reporting to fx-3dmap on or off |
Map3D.ShopCategory |
string | a category id | Category id from fx-3dmap's Config.Categories used for the phone shops. Set it to an id that exists on your server |
Map3D.TempCategory |
string | 'other' |
Category for short-lived markers such as the Anon trace zone |
Map3D.Category |
string | 'other' |
Category for everything else |
#Config.Marketplace
File: configs/config_marketplace.lua. PostPrice, DailyLimit and MaxImages are defaults; the admin tablet can change them while the server runs.
| Setting | Type | Default | What it does |
|---|---|---|---|
Marketplace.Categories |
string list | vehicle, food, house, item, job, service |
Category ids. Labels are in the locale |
Marketplace.PostPrice |
number | 250 |
Taken from the bank when a listing is posted. 0 makes posting free |
Marketplace.DailyLimit |
number | 5 |
Listings one character may post in 24 hours, deleted ones included |
Marketplace.MaxImages |
number | 3 |
Images per listing |
Marketplace.MaxPrice |
number | 100000000 |
Highest asking price |
#Config.News
File: configs/config_news.lua.
| Setting | Type | Default | What it does |
|---|---|---|---|
News.Jobs |
table | weazel = 0, lifeinvader = 0 |
Job name = minimum grade allowed to publish. Anyone with the job and grade can also edit or delete stories of that job; authors can always edit their own |
News.Categories |
string list | city, crime, politics, economy, traffic, weather, sports, entertainment |
Sections a story is filed under (labels: news.categories.<id>). The first one is the default |
News.LiveHours |
number | 3 |
A story marked live keeps its LIVE badge this many hours, unless the newsroom ends it sooner |
#Config.Pets
File: configs/config_pets.lua. Virtual pets. Prices come out of the bank; supplies are bought in packs.
| Setting | Type | Default | What it does |
|---|---|---|---|
Pets.Enabled |
boolean | true |
Pets on or off |
Pets.MaxPets |
number | 3 |
Pets per character |
Pets.AdoptPrice |
number | 500 |
Cost of adopting a pet |
Pets.SleepMinutes |
number | 10 |
How long an exhausted pet sleeps until its energy is full again, in real minutes |
Pets.MaxMembers |
number | 1 |
How many other players one pet can be shared with. 0 turns sharing off |
Pets.MaxShared |
number | 3 |
How many shared pets one player can look after besides their own |
Pets.Shop |
table | 5 supplies | { price, amount } per supply: food, water, soap, medicine, toy |
Families: two grown pets of the same kind, a girl and a boy, can be brought together. Every meeting fills a heart; with all hearts full the mother lays an egg, which hatches into a baby if its owner has room for one more pet.
| Setting | Default | What it does |
|---|---|---|
Pets.Family.Enabled |
true |
Families on or off |
Pets.Family.BabyDays |
2 |
A pet is a baby for its first days |
Pets.Family.AdultDays |
5 |
A pet is grown from this many days on |
Pets.Family.Hearts |
3 |
Meetings needed for an egg |
Pets.Family.DateCooldown |
3600 |
Seconds between two meetings of the same pair |
Pets.Family.HatchHours |
6 |
Hours until an egg can be hatched |
Pets.Family.SameSpecies |
true |
false: any two kinds can have a baby, which takes after one of them |
#Config.VoiceMemos
File: configs/config_voicememos.lua.
| Setting | Type | Default | What it does |
|---|---|---|---|
VoiceMemos.MaxMemos |
number | 100 |
Recordings one character keeps |
VoiceMemos.MaxSeconds |
number | 600 |
Longest recording. The upload host must accept this size: about 2.4 MB at 10 minutes |
#Config.Weather
File: configs/config_weather.lua.
| Setting | Type | Default | What it does |
|---|---|---|---|
Weather.Sync |
string | 'auto' |
Where the Weather app reads the current weather from: 'auto', 'native', 'Renewed-Weathersync', 'qb-weathersync' or 'cd_easytime'. The forecast is derived from it |
Weather.Units |
string | 'metric' |
'metric' (°C, km/h, km, hPa) or 'imperial' (°F, mph, mi, inHg) |