valence/packet_inspector
2022-09-15 18:59:43 -07:00
..
src Move packet_inspector README.md to correct directory 2022-09-05 22:18:13 -07:00
Cargo.toml Prepare for public release 2022-09-03 16:48:11 -07:00
README.md add docs for packet inspector: quick start w/ vanilla server in docker () 2022-09-15 18:59:43 -07:00

What's This?

The packet inspector is a very simple Minecraft proxy for viewing the contents of packets as they are sent/received. It uses Valence's protocol facilities to print packet contents. This was made for three purposes:

  • Check that packets between Valence and client are matching your expectations.
  • Check that packets between vanilla server and client are parsed correctly by Valence.
  • Understand how the protocol works between the vanilla server and client.

Usage

First, start a server

cargo r -r --example conway

In a separate terminal, start the packet inspector.

cargo r -r -p packet_inspector -- 127.0.0.1:25566 127.0.0.1:25565

The client must connect to localhost:25566. You should see the packets in stdout.

If you only want to see errors, direct stdout elsewhere.

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

docker run -e EULA=TRUE -e ONLINE_MODE=false -d -p 25565:25565 --name mc itzg/minecraft-server

View server logs

docker logs -f mc

Server Rcon

docker exec -i mc rcon-cli

In a separate terminal, start the packet inspector.

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