Tiny Lobby Documentation

Website	Discord	tiny_lobby Server	Godot Client	Starter Project

This is a documentation for getting started with the Tiny Lobby Service.

1. Server Config

• Run locally
• Config file
• Game Config file

2. Scripting Backend

• Lua Backend
• AngelsScript Backend
• Relay Backend

3. Test Script

Check also:

LUA SCRIPTING

1. Server Config

Run locally

In order to run it, you need to run the tiny_lobby binary from command line from this repo:

tiny_lobby -h

Will print:

Usage: ./lobby_server [--verbose] [--disable-metrics] [--skip-login] [--logout] [--generate-config]

Config file

The tiny_lobby uses an optional config.ini file. The config.ini file contains override configurations that are specific to the tiny_lobby. Check config_template.ini for a template.

Game Config file

The optional scripts/<game_id>/config.ini config file located inside the script folder for your game can have the following settings:

• disband on leave (should the game disband when host leaves?):

disband_on_leave=true # Default is false

• tickrate (If you enable this the _on_lobby_tick callback will be enabled):

tickrate=100 # In ms. Default is 0, disabled.

• sendrate (How often should messages be sent. If you enable this messages will be batched):

sendrate=100 # In ms. Default is 0, disabled.

• max_afk_time (How much can a lobby be afk before it is destroyed):

max_afk_time=360000 # In ms. Default is 0, disabled.

• seal (Default seal state).

seal=true # bool, default is false

• example

[game]
disband_on_leave=true
tickrate=100
sendrate=100
max_afk_time=360000

2. Scripting Backend

Lua Backend

See LUA_SCRIPTING.md for details on using Lua scripting with the Lobby Service.

Relay Backend

If you set lobby_control as relay, then there is no scripting backend and you are not required to set the folder.