Skip to content

Commit 2b06f69

Browse files
committed
update docs
1 parent 497d040 commit 2b06f69

3 files changed

Lines changed: 26 additions & 9 deletions

File tree

ARCHITECTURE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ Tiny Lobby provides a rich set of features, sent as messages that can be batched
4040

4141
### Lobby Management
4242

43-
Any peer can:
43+
- Write backend game logic in Lua that runs directly on the lobby server.
44+
45+
Peers can:
4446

4547
- Create a new lobby.
4648
- Join a lobby and receive its state.
@@ -53,7 +55,7 @@ Any peer can:
5355
- Receive notification when a peer is kicked.
5456
- Call lobby scripted functions.
5557

56-
Only the host of a lobby can:
58+
The host of a lobby can:
5759

5860
- Change lobby sealed (locked/open) state.
5961
- Change max players.

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
1-
# Tiny Lobby
1+
<p align="center">
2+
<img width="512px" src="tiny_lobby_banner.png"/>
3+
<h1 align="center">Tiny Lobby Server</h1>
4+
</p>
25

3-
|[Website](https://appsinacup.com)|[Discord](https://discord.gg/56dMud8HYn)|[Documentation](https://github.com/appsinacup/documentation_lobby)|[Build Locally](./BUILD_LOCALLY.md)|[Architecture](./ARCHITECTURE.md)
4-
|-|-|-|-|-|
6+
|[Website](https://appsinacup.com)|[Discord](https://discord.gg/56dMud8HYn)|[Starter Project](https://github.com/appsinacup/tiny_lobby_starter)|[Tiny Lobby Godot](https://github.com/appsinacup/addon_tiny_lobby_client)
7+
|-|-|-|-|
58

6-
![example](docs/example.gif)
9+
|[Documentation](https://github.com/appsinacup/documentation_lobby)|[Build Locally](./BUILD_LOCALLY.md)|[Architecture](./ARCHITECTURE.md)
10+
|-|-|-|
711

8-
Multiplayer C++ Lobby Server that starts a websocket server with scripting in Luau.
12+
Tiny Lobby is a lightweight multiplayer lobby system for WebSocket-based games, allowing peers to create, join, and manage lobbies, exchange data, and communicate in real time. It also supports backend scripting in Lua, enabling custom game logic directly on the server.
913

10-
- [addon_tiny_lobby_client](https://github.com/appsinacup/addon_tiny_lobby_client): Godot Tiny Lobby Client
14+
![example](docs/example.gif)
1115

12-
<img src="logo.png" height="128"/>
16+
## Features
17+
18+
- Write backend game logic in Lua that runs directly on the lobby server.
19+
- Create, join, or leave a lobby.
20+
- Get lobby public data, tags, and a list of lobbies.
21+
- Receive the lobby state and notifications for peer join/leave/kick events.
22+
- Call lobby scripted functions.
23+
- Lock/unlock the lobby.
24+
- Change max players, title, password, or tags.
25+
- Set ready state and update user data.
26+
- Send/receive chat messages.
27+
- Get notifications for peer reconnect/disconnect, user data changes, and public/private data updates.
1328

1429
## Usage
1530

tiny_lobby_banner.png

47.6 KB
Loading

0 commit comments

Comments
 (0)