aboutsummaryrefslogtreecommitdiff
path: root/codegen/README.md
diff options
context:
space:
mode:
authormat <27899617+mat-1@users.noreply.github.com>2022-06-08 23:37:54 +0000
committerGitHub <noreply@github.com>2022-06-08 23:37:54 +0000
commit601637bd48fcba826da01725430268f706181449 (patch)
tree5b58723b931450d358d7e4387d87cc8e8b9166b2 /codegen/README.md
parentea7249fb77a8e07d232600081c9c3df5f698d70f (diff)
parentfb1d419a3d4207a293a1ad6001253192f1b4d12f (diff)
downloadazalea-drasl-601637bd48fcba826da01725430268f706181449.tar.xz
Merge pull request #7 from mat-1/1.19
1.19
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.