add docs for packet inspector: quick start w/ vanilla server in docker (#63)

This commit is contained in:
Carson McManus 2022-09-15 21:59:43 -04:00 committed by GitHub
parent 7cd3b6cd2d
commit 7c23d7a086
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -27,3 +27,34 @@ If you only want to see errors, direct `stdout` elsewhere.
```sh
cargo r -r -p packet_inspector -- 127.0.0.1:25566 127.0.0.1:25565 > log.txt
```
## Quick start with Vanilla Server via Docker
Start the server
```bash
docker run -e EULA=TRUE -e ONLINE_MODE=false -d -p 25565:25565 --name mc itzg/minecraft-server
```
View server logs
```bash
docker logs -f mc
```
Server Rcon
```bash
docker exec -i mc rcon-cli
```
In a separate terminal, start the packet inspector.
```sh
cargo r -r -p packet_inspector -- 127.0.0.1:25566 127.0.0.1:25565
```
Open Minecraft and connect to `localhost:25566`.
Clean up
```
docker stop mc
docker rm mc
```