Skip to content

Commit a8933fb

Browse files
authored
docs: clean up readme (#15)
* docs(readme): fix alert * docs(readme): move alert below title * docs(readme): expand wip * docs(readme): add description to resource section * docs(readme): organize dev instructions * docs(readme): add showcase image * docs(readme): make the last step more clear
1 parent e7ba9ff commit a8933fb

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
> [!WARN]
2-
>
3-
> This repository is a WIP and subject to ongoing updates.
1+
![showcase](./showcase.png)
42

53
# Multiplayer
64

5+
> [!WARNING]
6+
>
7+
> This repository is a work-in-progress and subject to ongoing updates.
8+
79
Multiplayer online game from scratch.
810

911
## Development
1012

1113
1. [Install ebitengine dependencies][ebitengine_install].
1214

13-
2. Run the server:
15+
2. Run the server.
1416

1517
```bash
1618
go run ./cmd/server
1719
```
1820

19-
3. In the server logs, there will be a line similar to the one below that
20-
telling you what address the server is bound to:
21+
3. In the server logs, there will be a line similar to the one below. Copy the
22+
text that is in the place of `[ADDRESS]` for the next step.
2123

2224
```
2325
11:10:53 INF bound udp/mcp listener address=[ADDRESS]
2426
```
2527
26-
Take note of `[ADDRESS]`.
27-
28-
3. Run the following. Replace `<n>` with the number of clients you'd like to
29-
run and also replace `[ADDRESS]` with the one you took note of in the
30-
previous step.
28+
3. In the following command, replace `<n>` with the number of clients you would
29+
like to spawn. Also, paste what you copied from the previous step, replacing
30+
`[ADDRESS]`, and then execute it.
3131
3232
```bash
3333
./spawn_clients.sh <n> -remote=[ADDRESS]
@@ -37,6 +37,8 @@ Multiplayer online game from scratch.
3737

3838
## Resources
3939

40+
I have used the following materials during the development of this project.
41+
4042
- [Networked Physics](https://gafferongames.com/categories/networked-physics)
4143
- [Sneaky Race Conditions and Granular Locks](https://blogtitle.github.io/sneaky-race-conditions-and-granular-locks)
4244
- [Network Programming with Go](https://www.amazon.com/Network-Programming-Go-Adam-Woodbeck/dp/1718500882)

showcase.png

16.8 KB
Loading

0 commit comments

Comments
 (0)