Features
Messaging
Messages, Wisp, Mail, Darkchat and the GIF search.
fx-phone has four apps for writing to other players. They share one chat engine on the server but follow different rules.
| App | Who you write to | Config |
|---|---|---|
| Messages | Phone numbers. Text, pictures, voice notes, locations, money | Config.Limits |
| Wisp | Phone numbers. A full messenger with groups, communities, status and polls | Config.Wisp |
Mail addresses the players open themselves (name@domain) |
Config.Mail |
|
| Darkchat | Hashtag channels. Members only see aliases, never numbers | Config.Darkchat |
Calls are on their own page: Calls. Company chats in the Services app are on Services.
#1. Messages
The phone's SMS app. A chat belongs to the phone number, so with Config.Sim.Enabled = true it moves with the SIM (see SIM cards). A phone with no number cannot write; the app says No SIM.
A phone with two SIMs has two lines. The threads of both lines are in the same list, each tagged with its slot number (1 or 2). A new message goes out on the primary line, or the phone asks which line when the player chose Ask Every Time for New Messages in Settings > SIM; the New Message screen also has a switch to pick the line. A phone cannot text its own other line. See SIM cards.
#What a player can do
- Write to any number that belongs to a character. A number nobody has is refused.
- Send pictures, videos, GIFs, voice notes, their current location, a contact card or an invite to a live stream.
- Reply to a message, react to it, delete their own message, mute or clear a chat, mark it unread.
- Search chats and messages (two letters or more).
- Make a group with a name and a picture. A Messages group holds at most 25 people, the creator included. The creator can remove members; when the creator leaves, the group passes to another member.
- Send money and request money in a one-to-one chat (see below).
Blocking a number in Contacts stops chats in both directions.
#Money in a chat
| Action | What happens |
|---|---|
| Send | The amount leaves the sender's bank and lands in the other player's bank at once. A bubble shows it was paid |
| Request | A bubble asks for the amount. The other player pays it with one tap; it is then marked paid and cannot be paid twice |
Rules:
- Only in one-to-one Messages chats, not in groups and not in Wisp.
- The other player must be online, both to receive money and to be paid for a request.
- At most
Config.Limits.CashMessageMaxper payment. The admin tablet can change it while the server runs. - Both sides get a line in their Bank history.
#Messages from scripts
Scripts can send a text to a number in a player's name or from a label such as a company name. See Server exports: messages.
#Options
| Option | Default | What it does |
|---|---|---|
Config.Limits.MessageLength |
1000 |
Characters per message. Also used by Wisp |
Config.Limits.CashMessageMax |
50000 |
Largest payment or request in a chat |
Config.Retention.messages |
30 |
Days before chat messages are deleted (Messages, Wisp, social DMs, Services, Flame) |
#2. Wisp
A WhatsApp-style messenger on the phone number. The number is the identity. How an account is tied to a phone depends on Registration, see Wisp accounts below.
#Wisp accounts
Config.Wisp.Registration decides who has a number's Wisp account.
Registration = true (as shipped). A Wisp account belongs to a number and is set up on one phone at a time, as on WhatsApp.
- The first time a player opens Wisp, it shows a set-up screen instead of the app. The player picks one of the numbers that are in the phone. Without a working SIM in the phone Wisp cannot be set up, and the screen offers a button to Settings > SIM.
- A 6-digit code arrives on that line as a text message, in the Messages app, from "Wisp". It is valid for 5 minutes and can be tried 5 times; after that the player asks for a new one.
- The player enters the code and a name for the profile (the character name is filled in), and Wisp opens.
From then on that phone has the account, with the SIM in or out, until another phone sets the same number up. That needs the SIM in the other phone, because the code goes to the line. The first phone is then signed out: it gets a notification "Your account for ... was opened on another phone." and Wisp shows the set-up screen again.
Change Number in Wisp Settings moves the account (profile, chats, groups and settings) to another number that is in the phone. The same code step runs for the new number. The player can choose to tell the people in their direct chats; each of them then gets a message with the new number. The new number must not already have Wisp chats of its own: two accounts cannot be merged.
Accounts that existed before registration was switched on are claimed by their phone automatically the first time Wisp is opened there, with no set-up. A number that never used Wisp has no account, so nobody can write to it on Wisp.
Registration = false. The account is simply the phone's own (primary) number and follows its SIM. A phone with no number has no Wisp, and a second line has no Wisp account of its own.
Scripts can read the number of the Wisp account on a player's phone with the server export GetWispNumber, see Server exports: users.
#What a player can do
- One-to-one chats and groups. Edit a message for
EditWindowseconds after sending, delete it for everyone forDeleteWindowseconds. - Pin chats (up to
PinnedChats), archive and star messages, forward messages, set a chat wallpaper. - Disappearing messages: each chat can pick one of the
Disappearingtimers. - Polls with 2 to
PollOptionsoptions. - Live location for one of the
LiveLocationDurations. The sharing phone sends its position everyLiveLocationIntervalseconds (5 at the least). - Status: a post that stays up
StatusHourshours. One player can have at mostStatusActiveup at once. - Broadcast lists: one message sent as a private chat to everyone on the list. Up to
BroadcastListslists ofBroadcastMembersnumbers each. Only people who saved the sender's number receive it. - Communities: an announcements group only its admins post in, with groups linked to it. Members of a linked group join the announcements. At most
CommunityLimitmembers. - Export a chat as text (the newest
ExportMessagesmessages). - Profile name, picture and "about", plus privacy settings: who sees last seen, the photo, the about text and the status, read receipts, and who may add them to groups.
#Online and last seen
A player shows as online while their phone is open, and for PresenceGrace seconds after they put it away, so a quick close and reopen does not flicker. After that their last seen time is shown: the moment they put the phone away (or left the server with it open). A player who hides their own last seen sees nobody else's either.
#Group settings
Group admins can let only admins send, let only admins edit the group info, ask for approval before people join through a link, and allow every member to add people. Groups hold at most GroupLimit members.
#Options
| Option | Default | What it does |
|---|---|---|
Registration |
true |
A Wisp account belongs to a number and is set up on one phone with a code. false: the account is the phone's primary number and follows its SIM |
GroupLimit |
1024 |
Members per group, admins included |
CommunityLimit |
5000 |
Members of a community's announcements |
PinnedChats |
3 |
Chats one player can pin |
EditWindow |
15 * 60 |
Seconds in which a sent message can be edited |
DeleteWindow |
60 * 60 |
Seconds in which a sent message can be deleted for everyone |
ForwardTargets |
5 |
Chats one forward can reach |
ForwardMessages |
10 |
Messages in one forward |
ForwardedMany |
5 |
A message forwarded this many times or more is marked "Forwarded many times" |
PresenceGrace |
20 |
Seconds a player still shows as online after putting the phone away |
Disappearing |
{ 0, 86400, 7 86400, 90 86400 } |
Timers offered, in seconds. 0 is off |
LiveLocationDurations |
{ 15 60, 60 60, 8 60 60 } |
Live location lengths offered, in seconds |
LiveLocationInterval |
10 |
Seconds between two position updates |
PollOptions |
12 |
Most options in a poll |
BroadcastLists |
20 |
Broadcast lists per player |
BroadcastMembers |
256 |
Numbers per broadcast list |
StatusHours |
24 |
Hours a status stays up |
StatusActive |
30 |
Statuses one player can have up at once |
ReceiptMembers |
32 |
Groups up to this size keep a delivered and read time per member. Larger groups show ticks only |
ExportMessages |
2000 |
Messages written into one chat export |
Defaults.about |
'Hey there! I am using Wisp.' |
The about text of a new profile |
Defaults.privacy |
see below | Privacy of a new profile |
Defaults.privacy starts as: lastSeen, photo, about = 'everyone', status = 'contacts', readReceipts = true, groups = 'everyone'. Players change their own in the app.
#3. Mail
Players open their own mail addresses and write to each other. Scripts can also drop mail into a player's phone inbox.
#How it works
- Opening an address. The player picks a name (3 to 24 letters, digits,
.,_or-) and one of theDomains. Each address can be owned by one character only. A character can ownMaxAccountsaddresses and can delete them again. - Writing. A mail goes from one of the player's addresses to up to
MaxRecipientsaddresses, separated by commas or spaces. Every address must exist, or nothing is sent. A character can sendMaxPerDaymails in 24 hours. - Boxes. Inbox, Sent and Trash, per address. Mail from scripts lands in the phone's own inbox, which every phone has without opening an address.
- Each new mail gives the receiver a notification.
#Mail from scripts
SendMail puts a mail into a player's phone inbox, and the console command fxphone:mail can send one to a player or to everyone. See Server exports: messages.
#Options
| Option | Default | What it does |
|---|---|---|
Domains |
{ 'lsmail.com', 'eyefind.info', 'weazel.news' } |
Domains players can open addresses on |
MaxAccounts |
3 |
Addresses one character may own |
MaxRecipients |
5 |
Addresses one mail may go to |
MaxPerDay |
60 |
Mails one character may send in 24 hours |
Two retention keys apply:
| Option | Default | What it does |
|---|---|---|
Config.Retention.mail |
3 |
Days before mail from scripts in the phone inbox is deleted |
Config.Retention.mailbox |
30 |
Days before mail between players' addresses is deleted |
#4. Darkchat
Anonymous channels. A channel has a hashtag, a name and an optional password. Members see each other as aliases such as anon-3fa91c, never as names or numbers.
#How it works
- A player creates a channel: a name, and a hashtag (3 to 20 letters, digits or
_) or a random one. A password of 4 to 32 characters is optional. - Others join by typing the hashtag, and the password if there is one.
- In each channel a member can set a nickname instead of the alias. Nicknames are unique per channel and cannot start with
anon-.
The alias of a member is the same every time in that channel, and different in every other channel. It is worked out with a secret kept in the database, so nobody can find out who is behind an alias.
#Setup
Darkchat is in the App Store and not installed by default. It is open to everyone: no GhostNet card is needed. To put it behind the card, add 'darkchat' to Config.SecondSim.Apps (default { 'anon' }); it then only opens while the player has a working GhostNet card in the phone. See SIM cards.
#Options
| Option | Default | What it does |
|---|---|---|
BlacklistedJobs |
an example list of police and justice jobs | Jobs that cannot use Darkchat at all, e.g. { 'police', 'sheriff' }. Set it to your server's jobs. The admin tablet can change it |
MemberLimit |
25 |
Members per channel. The admin tablet can change it |
Config.Retention.darkchat |
15 |
Days before Darkchat messages are deleted. Channels nobody wrote in for that long are deleted too |
#5. GIF search
Messages, Wisp and Chirp have a GIF picker. The search runs on the server, so the key never reaches the players.
Set it in config_server.lua: ServerConfig.Gif.Provider ('giphy', 'tenor', 'klipy' or 'none') and ServerConfig.Gif.Key. With 'none', or a provider without a key, the picker finds nothing. Klipy returns no results in this version. Searches are cached for 10 minutes.
GIF links must come from a host in ServerConfig.Upload.AllowedHosts. tenor.com and giphy.com are on that list by default.
#Good to know
- "Unknown number" in Messages. A one-to-one chat or a group can only include numbers that belong to a character. Typos and made-up numbers are refused.
- Money does not arrive. Payments in chats need the other player online. Use Bank transfers for offline players.
- Image or link refused. Every picture, video and avatar in a chat must be on an allowed host (
ServerConfig.Upload.AllowedHosts). Discord attachment links are always refused because they expire. - Messages shows "No SIM". With
Config.Sim.Enabled = trueand no SIM in the phone there is no number, so Messages cannot be used. Emergency calls still work. - Wisp asks to be set up, or says a SIM is needed. With
Config.Wisp.Registration = truea phone needs a Wisp account set up with a number that is in it. Once set up, Wisp keeps working with the SIM out. A player who was signed out set the same number up on another phone. WithRegistration = falseWisp needs a number in the phone, like Messages. - Darkchat says "SIM Not Authorized". You added
'darkchat'toConfig.SecondSim.Appsand the player has no working GhostNet card. See SIM cards. - Old chats vanish. The daily clean-up at 04:00 deletes messages older than
Config.Retention.messagesdays. Set it to0to keep everything.