Skip to content

Commit 5bf5097

Browse files
committed
added host management stuff
1 parent 0fa4566 commit 5bf5097

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed

src/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
- [Getting Started](./getting-started/index.md)
66
- [Connecting](./getting-started/connecting.md)
7+
- [Competing](./getting-started/competing/index.md)
8+
- [Hosting](./getting-started/hosting/index.md)
79
- [Configuration](./config/index.md)
810
- [Runtime](./config/runtime.md)
911
- [Setup](./config/setup.md)

src/getting-started/competing/index.md

Whitespace-only changes.
40.9 KB
Loading
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Hosting a competition
2+
3+
To host a competition, you'll want to install the [Basalt CLI](../../cli/index.md).
4+
Next, you'll want to create a [Config](../../config/index.md) which includes
5+
server and competition configurations as well as all the questions in your packet.
6+
7+
When you have a configuration you're happy with, you can use the Basalt CLI to generate
8+
a [Docker](https://docs.docker.com/get-started/get-docker/) image that you can spin up
9+
like so:
10+
11+
```bash
12+
basalt-cli build <config.toml>
13+
```
14+
15+
Your docker images will be set up with the environment specified in your
16+
setup and init scripts if you provided them. If you simply provided a list of recognized
17+
languages, then it will perform all of the necessary setup at this build time.
18+
19+
20+
# Managing Your Competition
21+
22+
As a host, you'll have access to controls which allow you to pause and start the event.
23+
Note that the server will start in the paused state waiting for you to start it manually.
24+
Competitors cannot perform any actions after logging in until you start the event.
25+
26+
![Host view](./host-view.png)
27+
28+
If you pause the competition while it's running, all competitors will be instantly halted.
29+
Competitors will instantly resume competing as soon as you unpause the competition.
30+
31+
You can unpause the competition using the pause button to the left of the countdown. You
32+
can unpause the competition using the play button in the same location.

0 commit comments

Comments
 (0)