update readme

This commit is contained in:
2026-08-07 02:53:49 -05:00
parent f5d6c640ae
commit af012d06e8

100
README.md
View File

@@ -1,37 +1,67 @@
# # Running the Lobby Server
#
# Note that the lobby server is looking for a script local to it titled 'game.sh'
#
# Editor -> Debug > Customize Run Instance
#
#
# -- name_billiards server game_port_range 5000:5010
#
#
# CLI
#
# ./lobby_server.sh -- name_billiards server game_port_range 5000:5010
#
#
> **Note:** The lobby server looks for a local script named `game.sh`.
# ## From the Editor
#
# Editor -> Debug > Customize run instance **Debug Customize Run Instance**
#
# -- client host_snooker bobs_game ```text
# --name_billiards server game_port_range 5000:5010
# -- client join bobs_game ```
#
# ## From the Command Line
# CLI
# ```bash
# If going straight to game server: ./lobby_server.sh --name_billiards server game_port_range 5000:5010
# ./billiards.sh -- server_5001 game snooker ```
# ./billiards.sh -- join_server 127.0.0.1 5001
# ---
# If going through lobby server:
# ./billiards.sh -- client host_snooker bobs_game # Connecting Clients
# ./billiards.sh -- client join bobs_game
# ## From the Editor
#
**Debug → Customize Run Instance**
Host a game:
```text
--client host_snooker bobs_game
```
Join a game:
```text
--client join bobs_game
```
## From the Command Line
### Connect Directly to a Game Server
Start a server:
```bash
./billiards.sh --server_5001 game snooker
```
Join the server:
```bash
./billiards.sh --join_server 127.0.0.1 5001
```
### Connect Through the Lobby Server
Host a game:
```bash
./billiards.sh --client host_snooker bobs_game
```
Join a game:
```bash
./billiards.sh --client join bobs_game
```