Aligning with game upcomming shell project node structure; update readme
This commit is contained in:
54
README.md
54
README.md
@@ -1,69 +1,25 @@
|
|||||||
# Running the Lobby Server
|
# Running the Lobby Server
|
||||||
|
|
||||||
> **Note:** The lobby server looks for a local script named `game.sh`.
|
> **Note:** The lobby server looks for a local script named `game.sh` that actually handles loading a game server instance.
|
||||||
|
> **Note:** The lobby server defines its base node through 'name_' where past the underscore is whatever name you want the base node name to be. This is important for aligning node names paths especially when using RPC.
|
||||||
|
|
||||||
## From the Editor
|
## From the Editor
|
||||||
|
|
||||||
**Debug → Customize Run Instance**
|
**Debug → Customize Run Instance**
|
||||||
|
|
||||||
```text
|
```text
|
||||||
--name_billiards server game_port_range 5000:5010
|
-- name_shell server game_port_range 5000:5010
|
||||||
```
|
```
|
||||||
|
|
||||||
## From the Command Line
|
## From the Command Line
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./lobby_server.sh --name_billiards server game_port_range 5000:5010
|
./lobby-server.sh -- name_shell server game_port_range 5000:5010
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
# Connecting Clients
|
# Connecting Clients
|
||||||
|
|
||||||
[Billiards Game](https://code.itdominator.com/itdominator/Billiards)
|
[Billiards Game](https://code.itdominator.com/itdominator/Billiards)
|
||||||
|
|
||||||
## 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
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ custom_features=""
|
|||||||
export_filter="all_resources"
|
export_filter="all_resources"
|
||||||
include_filter=""
|
include_filter=""
|
||||||
exclude_filter=""
|
exclude_filter=""
|
||||||
export_path="../../builds/desktop/billiards/lobby_server.x86_64"
|
export_path="../../builds/desktop/billiards/lobby-server.x86_64"
|
||||||
patches=PackedStringArray()
|
patches=PackedStringArray()
|
||||||
encryption_include_filters=""
|
encryption_include_filters=""
|
||||||
encryption_exclude_filters=""
|
encryption_exclude_filters=""
|
||||||
|
|||||||
4
lobby.gd
4
lobby.gd
@@ -8,12 +8,12 @@ extends Node
|
|||||||
# Editor -> Debug > Customize Run Instance
|
# Editor -> Debug > Customize Run Instance
|
||||||
#
|
#
|
||||||
#
|
#
|
||||||
# -- name_billiards server game_port_range 5000:5010
|
# -- name_shell server game_port_range 5000:5010
|
||||||
#
|
#
|
||||||
#
|
#
|
||||||
# CLI
|
# CLI
|
||||||
#
|
#
|
||||||
# ./lobby_server.sh -- name_billiards server game_port_range 5000:5010
|
# ./lobby-server.sh -- name_shell server game_port_range 5000:5010
|
||||||
#
|
#
|
||||||
#
|
#
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user