From 62f7a039cc285913ffe286bda0de05de7e72ea40 Mon Sep 17 00:00:00 2001 From: Ryan Johnson Date: Mon, 5 Sep 2022 18:33:27 -0700 Subject: [PATCH] Create README for packet_inspector --- packet_inspector/src/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 packet_inspector/src/README.md diff --git a/packet_inspector/src/README.md b/packet_inspector/src/README.md new file mode 100644 index 0000000..940a3cc --- /dev/null +++ b/packet_inspector/src/README.md @@ -0,0 +1,29 @@ +# 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 two 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. + +```sh +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 `stderr` elsewhere. + +```sh +cargo r -r -p packet_inspector -- 127.0.0.1:25566 127.0.0.1:25565 > log.txt +```