diff options
Diffstat (limited to 'codegen/README.md')
| -rw-r--r-- | codegen/README.md | 13 |
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. |