Features

Live

Live streams with chat, gifts, guests, PK battles and channels.

Live is a streaming app; on the phone it is called FXLive (its id is still live, so Config.Apps, exports and saved data keep that name). A player goes live from the phone camera, other players watch the picture on their own phone, write in the chat, send hearts and buy gifts that pay the streamer. A streamer can bring up to three viewers on screen as guests and can challenge another stream to a PK battle. Every streamer has a channel that keeps their followers and their past streams.

Part What it is
Streams The live picture, the chat, hearts and gifts
Guests Up to three viewers on screen beside the streamer, the screen split between them
PK battles Two streams side by side for a few minutes; gifts and hearts are points, the higher score wins
Channels A streamer's profile: name, @username, picture, cover, bio, followers and past streams
Studio The channel owner's own numbers: totals, a 14-day chart, gifts and supporters

Everything is in Config.Live.

#How a stream works

The picture does not go through the game server. The streamer's phone opens one video connection to each viewer through the video relay, the same relay video calls use (see Calls). The server only keeps track of who is in which stream and carries the chat, the hearts and the gifts.

So the streamer sends one copy of the picture per viewer. With MaxViewers = 6 and MaxBitrate = 1000 a full stream uses up to 6000 kbit/s of the streamer's upload and of your relay. The picture size and frame rate are Config.Video.Size and Config.Video.Fps.

Guests and battles work the same way: everyone on screen sends their own picture to everyone else in the room. That multiplies the connections, so while more than one person is on screen each of them sends SeatBitrate kbit/s per receiver instead of MaxBitrate.

Room Who sends Receivers per sender Upload per sender at the defaults
Streamer alone, 6 viewers 1 6 6 × 1000 = 6000 kbit/s
Streamer + 3 guests, 6 viewers 4 9 9 × 500 = 4500 kbit/s
Battle, two full rooms, nobody else on screen 2 13 13 × 500 = 6500 kbit/s

All of it goes through your relay. If the relay or the players' upload cannot carry it, lower SeatBitrate, MaxViewers or MaxGuests.

#The voice

With Voice = true everyone on screen (the streamer, the guests and, in a battle, the people on screen in the other room) is heard by everyone in the room wherever they are, the way a phone call works. Viewers are heard by nobody. A guest the streamer has muted is not carried. This works on pma-voice and mumble-voip. On SaltyChat, or with Voice = false, only players standing near a speaker hear them.

#How it works for the player

#Going live

  1. The player opens Live and taps Go Live.
  2. The first time, they are sent to Open Your Channel: a channel name, a @username, a picture, a cover and a bio. A stream always runs under a channel.
  3. They type a stream title (up to 60 characters), pick a category and tap Start.
  4. The camera opens and the stream appears in everyone's list. Flip camera switches between the front and the rear lens.

The picture only goes out while the phone is open on the Live app. If the streamer closes the phone, locks it or opens another app, the stream is paused: viewers see "The streamer paused" until the streamer comes back. The voice keeps going while the picture is paused.

The stream ends when the streamer taps End Stream, or when they leave the server. The streamer then gets a Stream Summary: time live, peak viewers, total viewers, likes, earnings, gifts and new followers, with a button to the Studio.

#Watching

The home screen lists every live stream, the most watched first, with a category filter. Each card shows the viewer count against the limit, for example 4/6. A star marks streams of channels the player follows.

Inside a stream a viewer can:

  • write in the chat (up to 150 characters; the last 40 lines are kept),
  • tap the heart,
  • follow the channel and switch its bell on or off,
  • send a gift,
  • Invite contacts: each one gets a message from the viewer's number with a card that opens the stream.

The streamer can chat and invite too. People write under their channel name if they have opened one, otherwise under their character name.

A player can be in one stream at a time. Joining another stream leaves the first; a streamer cannot watch.

#Gifts

Gifts are paid from the viewer's bank. The streamer receives the price minus GiftCut, the platform's share. That share is not paid to anyone: it leaves the economy. Both sides see the gift in their bank history.

  • The gift drawer sends ×1, ×5 or ×10 of a gift at once.
  • Sending the same gift again within GiftComboSeconds seconds keeps the sender's combo going (×2, ×3 ...).
  • tier decides how big the gift looks: every gift slides in as a banner at the side, in a stronger colour from tier 2 on, and tier 3 and 4 also fill the screen for a moment.
  • A send that costs 1000 or more asks for confirmation first (the first send of a combo only).
  • The three biggest supporters of the stream, by money sent, are shown to everyone in the room.

With the default GiftCut = 0.2 a gift of 100 gives the streamer 80.

When guests are on screen the gift drawer asks who the gift is for. A gift for a guest is paid to the guest, minus the same GiftCut; it does not count in the streamer's channel numbers.

#Guests

A streamer can share the screen with up to MaxGuests viewers (3 at most, so 4 people on screen).

  • A viewer taps the hand button to ask for a seat. The streamer sees the request as a prompt and in the Guests sheet, and accepts or declines it.
  • The streamer can also invite any viewer from the Guests sheet. The viewer gets a prompt and has 30 seconds to join or decline.
  • Coming on screen opens the guest's camera and makes their voice heard in the room. A guest leaves the screen with one tap and stays in the room as a viewer.
  • The streamer can mute a guest or take them off the screen at any time.
  • The screen splits by itself: two side by side, three with the streamer tall on the left, four in a square. The chat, the gift banners and the buttons move under the pictures.
  • A guest who closes the phone or opens another app shows as "Camera off" until they are back.
  • A guest does not count as a viewer while on screen: a full room is MaxViewers viewers plus the guests.

#PK battles

A battle puts two streams side by side for Pk.Seconds seconds (5 minutes by default).

  1. A streamer opens the PK sheet (the lightning button), sees the streams that can be challenged, their own wins, losses and winning streak, and taps Challenge. The other streamer has 30 seconds to accept.
  2. Both rooms now see and hear both sides. This room is on the left in red, the other on the right in blue. A stream can battle with at most one guest on screen, so a battle shows two to four people.
  3. Every gift is worth Pk.GiftPoints points per unit of money, and every heart Pk.LikePoints, for the room it was sent in. Viewers of one room cannot send gifts into the other.
  4. In the last Pk.RushSeconds seconds everything counts Pk.RushMultiplier times; the clock turns orange.
  5. When the time is up the higher score wins. Equal scores are a draw. Each side's three best supporters are shown under the score bar during the whole battle.
  6. The result stays on screen for Pk.ResultSeconds seconds. If both streamers tap Rematch a new battle starts at once; otherwise the rooms part and each stream goes on alone.

A streamer can end a battle early: that counts as giving up, and the other side wins. Gifts are paid as always during a battle: the points decide the winner, the money goes to whoever the gift was for.

Wins, losses and the winning streak are counted per channel until the next server restart; they are not saved.

#Channels

A channel is who the player is in Live. What they pick there shows instead of their character name.

Field Rules
Channel name 2 to 30 characters
@username 3 to 20 characters: lowercase letters, digits, _ and ., no dot at the start or end, no two dots in a row. Must be unique
Picture, cover Taken with the camera or picked from Photos. The link must be on an allowed upload host
Bio Up to 160 characters

Some usernames are reserved and cannot be taken: admin, staff, live, canli, system, moderator, support, official.

#Changing the @username

The first @username is free to pick. After that it can be changed once every HandleChangeDays days, so nobody can wear another streamer's name for a minute and drop it again. With HandleChangeDays = 0 it can be changed any time. The name, pictures and bio can always be changed.

#Followers and the bell

  • Follow on a channel or in a stream. Following switches the bell on.
  • With the bell on, the follower gets a notification "{name} is live" when the channel starts a stream (NotifyFollowers). Tapping it opens the stream, or the channel if the stream is already over. A follower who is offline finds it in their notifications when they next join.
  • The bell can be switched off while still following.
  • The streamer gets a "New follower" notification (NotifyNewFollower). During a stream the follow shows in the stream's chat instead.

The home screen shows the channels the player follows in a row at the top, the live ones first. Discover (the search button) finds channels by name or @username; with an empty search it shows the 20 most followed channels.

#The verified badge

There is no way to buy or earn it in the app. Give it from a script with SetLiveVerified, and read a channel's numbers with GetLiveChannel: see Server exports: other.

#Studio and past streams

The channel owner opens Studio from their channel or from the stream summary.

Section What it shows
Totals Streams, total viewers, peak viewers, likes, time live, earnings, gifts
Followers Total, and how many joined in the last 7 days
Last 14 Days A chart of viewers, earnings, minutes and new followers per day, also as a table
Gift History The last gifts received, and under Sent the gifts this player sent to others
Top Supporters The five people who sent the most
Past Streams The last 20 finished streams

A channel's page shows its last 20 finished streams to everyone. Earnings are only shown to the owner. Opening one of their own past streams shows who sent what in it.

#Options

Option Default What it does
Enabled true false: nobody can go live
MaxViewers 6 Viewers per stream
MaxStreams 10 Streams running at the same time on the server
MaxBitrate 1000 kbit/s the streamer sends to each viewer
Voice true Everyone on screen is heard by the whole room wherever they are (pma-voice, mumble-voip)
MaxGuests 3 Seats beside the streamer, 0 to 3. 0 switches guests off
SeatBitrate 500 kbit/s per receiver while more than one person is on screen (guests or a battle)
Pk.Enabled true false: no battles
Pk.Seconds 300 Length of a battle
Pk.ResultSeconds 60 How long the result stays up, and the time to agree on a rematch
Pk.GiftPoints 10 Points per unit of money of a gift
Pk.LikePoints 1 Points per heart
Pk.RushSeconds 30 Length of the final rush. 0: no rush
Pk.RushMultiplier 2 What points are multiplied by during the rush
Categories irl, music, driving, racing, gaming, news Stream categories. The first one is picked when a player goes live
Gifts 12 gifts from pig (1) to yacht (25000) { id, price, tier } per gift
GiftCut 0.2 Share of every gift kept by the platform (0.2 = 20 %)
GiftComboSeconds 4 Seconds in which the same gift again keeps the combo
InviteMax 8 Numbers per invite
NotifyFollowers true Followers with the bell on are told when the channel goes live
NotifyNewFollower true The streamer is told about a new follower
HandleChangeDays 7 Days between two @username changes. 0: any time

#Adding a category or a gift

A category or gift id needs a label in every locale file: live.categories.<id> and live.gifts.<id>. A gift id may only use letters, digits and _, its price must be a whole number of at least 1, and tier is 1 to 4. A gift the app has no picture for shows a plain gift box.

#Setting it up

  1. Make sure video calls work: Config.Video.Enabled = true and a relay. By default the Fixitfy relay is used and nothing has to be set; your own TURN server is set in config_server.lua. See Calls.
  2. Make sure an upload provider is set, or players cannot add a channel picture or cover.
  3. Live is not installed on new phones (default = false in Config.Apps). Players install it from the App Store.

#Good to know

  • "Video connections are off on this server." on the Live screen means the video relay is not available: Config.Video.Enabled is false, or the relay refused or did not answer. Calls work without the camera in that case; Live does not work at all.
  • Enabled = false does not remove the app. It only stops new streams. To take Live off the phones, add hidden = true to its entry in Config.Apps.
  • "Open your channel before going live." A player must open a channel once before the first stream.
  • "The stream is full" means MaxViewers is reached. Raising it raises the streamer's upload by MaxBitrate per extra viewer.
  • Guests and battles need the relay even more than a plain stream. See the table under How a stream works before raising MaxGuests, MaxViewers or SeatBitrate.
  • A streamer with two or three guests cannot start or accept a battle. One guest at most; the others have to leave the screen first.
  • A guest's picture stops when they close the phone, exactly like the streamer's. Their voice keeps going.
  • The Go Live sheet starts on the first category in Categories. Put the one you want first at the front.
  • Gifts need money in the bank, not cash. Another resource can also refuse a gift through AddCheck.
  • Config.Video.RequireItem does not apply to Live. It only limits the camera in calls.
  • A stream cut by a crash or restart is kept in Past Streams with the numbers it had at the last minute: a running stream's time, viewers, likes and earnings are saved every minute, so at most a minute is lost. Its gifts are counted from the Gift History, which is written as each gift arrives.
  • The live notification goes to at most 300 followers per stream, the oldest follows first.
  • Past streams and gifts are never deleted. Config.Retention has no entry for them.
  • A player who has not opened a channel writes in stream chats under their character name.