update readme
This commit is contained in:
100
README.md
100
README.md
@@ -1,37 +1,67 @@
|
||||
#
|
||||
#
|
||||
# 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
|
||||
#
|
||||
#
|
||||
# Running the Lobby Server
|
||||
|
||||
> **Note:** The lobby server looks for a local script named `game.sh`.
|
||||
|
||||
#
|
||||
#
|
||||
# Editor -> Debug > Customize run instance
|
||||
#
|
||||
# -- client host_snooker bobs_game
|
||||
#
|
||||
# -- client join bobs_game
|
||||
#
|
||||
#
|
||||
# CLI
|
||||
#
|
||||
# If going straight to game server:
|
||||
# ./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
|
||||
# ./billiards.sh -- client join bobs_game
|
||||
#
|
||||
#
|
||||
## From the Editor
|
||||
|
||||
**Debug → Customize Run Instance**
|
||||
|
||||
```text
|
||||
--name_billiards server game_port_range 5000:5010
|
||||
```
|
||||
|
||||
## From the Command Line
|
||||
|
||||
```bash
|
||||
./lobby_server.sh --name_billiards server game_port_range 5000:5010
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Connecting Clients
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user