aboutsummaryrefslogtreecommitdiff
path: root/codegen/README.md
diff options
context:
space:
mode:
authormat <github@matdoes.dev>2022-05-24 20:28:08 -0500
committermat <github@matdoes.dev>2022-05-24 20:28:08 -0500
commit0a314bca16f6de199c319ffb0d84a5d5c3a61387 (patch)
treeaf5293d0eafb86e12653719b2af0c3f36e8f5663 /codegen/README.md
parent04aea6afaf6819a66181d5d544356764d118b1bb (diff)
downloadazalea-drasl-0a314bca16f6de199c319ffb0d84a5d5c3a61387.tar.xz
rename code-generator to codegen
Diffstat (limited to 'codegen/README.md')
-rw-r--r--codegen/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/codegen/README.md b/codegen/README.md
new file mode 100644
index 00000000..fa00b63f
--- /dev/null
+++ b/codegen/README.md
@@ -0,0 +1,13 @@
+Tools for automatically generating code to help with updating Minecraft versions.
+
+The directory name doesn't start with `azalea-` because it's not a Rust crate.
+
+## Usage
+
+Generate packet:\
+`python newpacket.py [packet id] [clientbound or serverbound] \[game/handshake/login/status\]`\
+This will create a new file in the `azalea-protocol/src/packets/\[state\] directory`. You will probably have to manually fix up the auto generated code.
+
+Migrate to a new Minecraft version:\
+`python migrate.py [new version]`\
+This updates all the packet ids in `azalea-protocol/src/packets/mod.rs` and creates all the new packets.