Skip to content

Commit 0fa4566

Browse files
committed
add connection docs
1 parent f098b15 commit 0fa4566

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
---
44

55
- [Getting Started](./getting-started/index.md)
6+
- [Connecting](./getting-started/connecting.md)
67
- [Configuration](./config/index.md)
78
- [Runtime](./config/runtime.md)
89
- [Setup](./config/setup.md)

src/getting-started/connecting.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Connecting to a competition
2+
3+
When the basalt application opens, you will be prompted for a game code
4+
or IPv4 address. This is how the application knows how to connect to
5+
the competition.
6+
7+
You can get your ip address and game code using the following command if
8+
you have the [Basalt CLI](https://github.com/basalt-rs/basalt-cli)
9+
installed:
10+
11+
```sh
12+
basalt game-code -c <path-to-config>
13+
```
14+
15+
which will output something like
16+
17+
![basalt cli output](./game-code.png)
18+
19+
You may enter either blue section as the game code when connecting to
20+
your server.

src/getting-started/game-code.png

9.92 KB
Loading

0 commit comments

Comments
 (0)