Merge branch 'main' into feat/sponge_schem

Author: MrlnHi

Diff for: .github/ISSUE_TEMPLATE/bug_report.yml

@@ -6,26 +6,21 @@ body:
     attributes:
       label: Valence Version
       description: What version of Valence are you using? If you are targeting a specific commit or branch, put that instead.
-      placeholder: version, branch, or commit hash
+      placeholder: Version, branch, or commit hash.
     validations:
       required: true
   - type: textarea
     attributes:
       label: Current Behavior
-      description: A concise description of what you're experiencing.
+      description: A concise description of what you're experiencing. Include any screenshots or additional information here.
     validations:
       required: false
   - type: textarea
     attributes:
       label: Expected Behavior
-      description: A concise description of what you expected to happen.
+      description: A concise description of what you expected to happen. 
     validations:
       required: true
-  - type: textarea
-    attributes:
-      label: Minimal Reproducible Example
-      description: Do you have a playground to reproduce this bug? Paste it here. It should be a minimal example that exhibits the behavior. If the problem can be reproduced with one of the examples, just indicate which one instead.
-      render: Rust
   - type: textarea
     attributes:
       label: Steps To Reproduce
@@ -37,19 +32,10 @@ body:
         4. See error
     validations:
       required: true
-  - type: checkboxes
-    attributes:
-      label: Checklist
-      options:
-        - label: I have searched the issues of this repo and believe that this is not a duplicate.
-          required: true
-        - label: This used to work before.
   - type: textarea
     attributes:
-      label: Anything else?
-      description: |
-        Links? References? Version Numbers? Anything that will give us more context about the issue you are encountering!
-
-        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+      label: Minimal Reproducible Example
+      description: A minimal example that exhibits the behavior. If you have a playground, paste it here. If the problem can be reproduced with one of the examples, just indicate which one instead.
+      render: Rust
     validations:
       required: false

Diff for: .github/ISSUE_TEMPLATE/feature_request.yml

@@ -4,16 +4,14 @@ labels: [enhancement]
 body:
   - type: textarea
     attributes:
-      label: Is your feature request related to a problem? Please describe.
-      description: A clear and concise description of what the problem is.
-      placeholder: I'm always frustrated when...
+      label: Describe the problem related to your feature request.
+      description: A clear description of what the problem is.
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Describe the solution you'd like
-      description: A clear and concise description of what you want to happen.
-      placeholder: I would like to be able to...
+      label: Describe the solution you would like.
+      description: The solution you propose for the problem presented.
     validations:
       required: true
   - type: textarea

Diff for: .github/pull_request_template.md

@@ -1,14 +1,13 @@
-<!-- Please make sure that your PR is aligned with the guidelines in CONTRIBUTING.md to the best of your ability. -->
-<!-- Good PRs have tests! Make sure you have sufficient test coverage. -->
-
 ## Description
 
-<!-- Describe the changes you've made. You may include any justification you want here. -->
+Describe the changes you've made. Link to any issues that this PR fixes or addresses.
 
 ## Test Plan
 
-<!-- Explain how you tested your changes, and include any code that you used to test this. -->
-<!-- If there is an example that is sufficient to use in place of a playground, replace the playground section with a note that indicates this.  -->
+Explain the steps necessary to test your changes. If you used a playground, include the code in the details below.
+
+Steps:
+1.
 
 <details>
 
@@ -19,11 +18,3 @@ PASTE YOUR PLAYGROUND CODE HERE
 ```
 
 </details>
-
-<!-- You need to include steps regardless of whether or not you are using a playground. -->
-Steps:
-1.
-
-#### Related
-
-<!-- Link to any issues that have context for this or that this PR fixes. -->

Diff for: README.md

@@ -32,8 +32,8 @@ in Minecraft such as minigame servers.
 Valence aims to be the following:
 
 * **Complete**. Abstractions for the full breadth of the Minecraft protocol.
-* **Flexible**. Valence provides direct access to the lowest levels of Minecraft's protocol when necessary.
-* **Modular**. Pick and choose the features you actually need.
+* **Flexible**. Can easily extend Valence from within user code. Direct access to the Minecraft protocol is provided.
+* **Modular**. Pick and choose the components you need.
 * **Intuitive**. An API that is easy to use and difficult to misuse. Extensive documentation and examples are important.
 * **Efficient**. Optimal use of system resources with multiple CPU cores in mind. Valence uses very little memory and
   can
@@ -45,7 +45,7 @@ Valence aims to be the following:
 
 ## Current Status
 
-Valence is still early in development with many features unimplemented or incomplete. Expect to encounter bugs, limitations, and breaking changes. Here are some noteworthy achievements:
+⚠️ **Valence is still early in development with many features unimplemented or incomplete. Expect to encounter bugs, limitations, and breaking changes.** Here are some noteworthy achievements:
 
 - `valence_nbt`: A speedy new library for Minecraft's Named Binary Tag (NBT) format.
 - `valence_protocol`: A library for working with Minecraft's protocol. Does not depend on Valence and can be used in

Diff for: crates/valence/Cargo.toml

@@ -16,8 +16,8 @@ anyhow = "1.0.65"
 arrayvec = "0.7.2"
 async-trait = "0.1.60"
 base64 = "0.21.0"
-bevy_app = { git = "https://github.com/bevyengine/bevy/", rev = "2ea00610188dce1eba1172a3ded8244570189230" }
-bevy_ecs = { git = "https://github.com/bevyengine/bevy/", rev = "2ea00610188dce1eba1172a3ded8244570189230" }
+bevy_app = "0.10"
+bevy_ecs = "0.10"
 bitfield-struct = "0.3.1"
 bytes = "1.2.1"
 flume = "0.10.14"

Diff for: crates/valence/src/server/connect.rs

@@ -31,7 +31,7 @@ use valence_protocol::packet::s2c::login::{
     LoginCompressionS2c, LoginDisconnectS2c, LoginHelloS2c, LoginQueryRequestS2c, LoginSuccessS2c,
 };
 use valence_protocol::packet::s2c::status::{QueryPongS2c, QueryResponseS2c};
-use valence_protocol::raw_bytes::RawBytes;
+use valence_protocol::raw::RawBytes;
 use valence_protocol::text::Text;
 use valence_protocol::types::Property;
 use valence_protocol::username::Username;

Diff for: crates/valence_anvil/Cargo.toml

@@ -20,7 +20,7 @@ valence_nbt = { version = "0.5.0", path = "../valence_nbt" }
 
 [dev-dependencies]
 anyhow = "1.0.68"
-bevy_ecs = { git = "https://github.com/bevyengine/bevy/", rev = "2ea00610188dce1eba1172a3ded8244570189230" }
+bevy_ecs = "0.10"
 clap = "4.1.4"
 criterion = "0.4.0"
 flume = "0.10.14"

Diff for: crates/valence_protocol/src/lib.rs

@@ -95,7 +95,7 @@ pub mod ident;
 mod impls;
 pub mod item;
 pub mod packet;
-pub mod raw_bytes;
+pub mod raw;
 pub mod sound;
 pub mod text;
 pub mod tracked_data;
@@ -261,9 +261,9 @@ pub trait Decode<'a>: Sized {
 /// type must implement [`Encode`], [`Decode`], and [`fmt::Debug`].
 ///
 /// ```
-/// use valence_protocol::{Encode, Packet};
+/// use valence_protocol::{Decode, Encode, Packet};
 ///
-/// #[derive(Encode, Packet, Debug)]
+/// #[derive(Encode, Decode, Packet, Debug)]
 /// #[packet_id = 42]
 /// struct MyStruct {
 ///     first: i32,
@@ -282,6 +282,11 @@ pub trait Packet<'a>: Sized + fmt::Debug {
     /// The packet returned by [`Self::packet_id`]. If the packet ID is not
     /// statically known, then a negative value is used instead.
     const PACKET_ID: i32 = -1;
+    /// Returns the ID of this packet.
+    fn packet_id(&self) -> i32;
+    /// Returns the name of this packet, typically without whitespace or
+    /// additional formatting.
+    fn packet_name(&self) -> &str;
     /// Like [`Encode::encode`], but a leading [`VarInt`] packet ID must be
     /// written first.
     ///
@@ -292,14 +297,14 @@ pub trait Packet<'a>: Sized + fmt::Debug {
     ///
     /// [`VarInt`]: var_int::VarInt
     fn decode_packet(r: &mut &'a [u8]) -> Result<Self>;
-    /// Returns the ID of this packet.
-    fn packet_id(&self) -> i32;
 }
 
 #[allow(dead_code)]
 #[cfg(test)]
-mod derive_tests {
+mod tests {
     use super::*;
+    use crate::packet::c2s::play::HandSwingC2s;
+    use crate::packet::C2sPlayPacket;
 
     #[derive(Encode, Decode, Packet, Debug)]
     #[packet_id = 1]
@@ -359,18 +364,39 @@ mod derive_tests {
     }
 
     #[allow(unconditional_recursion)]
-    fn has_impls<'a, T>()
+    fn assert_has_impls<'a, T>()
     where
         T: Encode + Decode<'a> + Packet<'a>,
     {
-        has_impls::<RegularStruct>();
-        has_impls::<UnitStruct>();
-        has_impls::<EmptyStruct>();
-        has_impls::<TupleStruct>();
-        has_impls::<StructWithGenerics>();
-        has_impls::<TupleStructWithGenerics>();
-        has_impls::<RegularEnum>();
-        has_impls::<EmptyEnum>();
-        has_impls::<EnumWithGenericsAndTags>();
+        assert_has_impls::<RegularStruct>();
+        assert_has_impls::<UnitStruct>();
+        assert_has_impls::<EmptyStruct>();
+        assert_has_impls::<TupleStruct>();
+        assert_has_impls::<StructWithGenerics>();
+        assert_has_impls::<TupleStructWithGenerics>();
+        assert_has_impls::<RegularEnum>();
+        assert_has_impls::<EmptyEnum>();
+        assert_has_impls::<EnumWithGenericsAndTags>();
+    }
+
+    #[test]
+    fn packet_name() {
+        assert_eq!(UnitStruct.packet_name(), "UnitStruct");
+        assert_eq!(RegularEnum::Empty.packet_name(), "RegularEnum");
+        assert_eq!(
+            StructWithGenerics {
+                foo: "blah",
+                bar: ()
+            }
+            .packet_name(),
+            "StructWithGenerics"
+        );
+        assert_eq!(
+            C2sPlayPacket::HandSwingC2s(HandSwingC2s {
+                hand: Default::default()
+            })
+            .packet_name(),
+            "HandSwingC2s"
+        );
     }
 }

Diff for: crates/valence_protocol/src/packet.rs

@@ -41,6 +41,10 @@ macro_rules! packet_group {
                     $packet_id
                 }
 
+                fn packet_name(&self) -> &str {
+                    stringify!($packet)
+                }
+
                 #[allow(unused_imports)]
                 fn encode_packet(&self, mut w: impl std::io::Write) -> crate::Result<()> {
                     use ::valence_protocol::__private::{Encode, Context, VarInt};
@@ -73,6 +77,14 @@ macro_rules! packet_group {
                 }
             }
 
+            fn packet_name(&self) -> &str {
+                match self {
+                    $(
+                        Self::$packet(pkt) => pkt.packet_name(),
+                    )*
+                }
+            }
+
             fn encode_packet(&self, mut w: impl std::io::Write) -> crate::Result<()> {
                 use crate::Encode;
                 use crate::var_int::VarInt;
@@ -142,6 +154,10 @@ macro_rules! packet_group {
                     $packet_id
                 }
 
+                fn packet_name(&self) -> &str {
+                    stringify!($packet)
+                }
+
                 #[allow(unused_imports)]
                 fn encode_packet(&self, mut w: impl std::io::Write) -> crate::Result<()> {
                     use ::valence_protocol::__private::{Encode, Context, VarInt};
@@ -174,6 +190,14 @@ macro_rules! packet_group {
                 }
             }
 
+            fn packet_name(&self) -> &str {
+                match self {
+                    $(
+                        Self::$packet(pkt) => pkt.packet_name(),
+                    )*
+                }
+            }
+
             fn encode_packet(&self, mut w: impl std::io::Write) -> crate::Result<()> {
                 use crate::Encode;
                 use crate::var_int::VarInt;

Diff for: crates/valence_protocol/src/packet/c2s/login/login_query_response.rs

@@ -1,4 +1,4 @@
-use crate::raw_bytes::RawBytes;
+use crate::raw::RawBytes;
 use crate::var_int::VarInt;
 use crate::{Decode, Encode};
 

Diff for: crates/valence_protocol/src/packet/c2s/play/custom_payload.rs

@@ -1,5 +1,5 @@
 use crate::ident::Ident;
-use crate::raw_bytes::RawBytes;
+use crate::raw::RawBytes;
 use crate::{Decode, Encode};
 
 #[derive(Copy, Clone, Debug, Encode, Decode)]

Diff for: crates/valence_protocol/src/packet/s2c/login/login_query_request.rs

@@ -1,5 +1,5 @@
 use crate::ident::Ident;
-use crate::raw_bytes::RawBytes;
+use crate::raw::RawBytes;
 use crate::var_int::VarInt;
 use crate::{Decode, Encode};
 

Diff for: crates/valence_protocol/src/packet/s2c/play/custom_payload.rs

@@ -1,5 +1,5 @@
 use crate::ident::Ident;
-use crate::raw_bytes::RawBytes;
+use crate::raw::RawBytes;
 use crate::{Decode, Encode};
 
 #[derive(Copy, Clone, Debug, Encode, Decode)]

Diff for: crates/valence_protocol/src/packet/s2c/play/entity_tracker_update.rs

@@ -1,4 +1,4 @@
-use crate::raw_bytes::RawBytes;
+use crate::raw::RawBytes;
 use crate::var_int::VarInt;
 use crate::{Decode, Encode};
 

Diff for: crates/valence_protocol/src/raw_bytes.rs renamed to crates/valence_protocol/src/raw.rs

@@ -1,6 +1,7 @@
 use std::io::Write;
+use std::mem;
 
-use crate::{Decode, Encode, Result};
+use crate::{Decode, Encode, Packet, Result};
 
 /// While [encoding], the contained slice is written directly to the output
 /// without any length prefix or metadata.
@@ -10,7 +11,7 @@ use crate::{Decode, Encode, Result};
 ///
 /// [encoding]: Encode
 /// [decoding]: Decode
-#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Debug)]
 pub struct RawBytes<'a>(pub &'a [u8]);
 
 impl Encode for RawBytes<'_> {
@@ -21,9 +22,7 @@ impl Encode for RawBytes<'_> {
 
 impl<'a> Decode<'a> for RawBytes<'a> {
     fn decode(r: &mut &'a [u8]) -> Result<Self> {
-        let slice = *r;
-        *r = &[];
-        Ok(Self(slice))
+        Ok(Self(mem::take(r)))
     }
 }
 
@@ -38,3 +37,26 @@ impl<'a> From<RawBytes<'a>> for &'a [u8] {
         value.0
     }
 }
+
+/// A fake [`Packet`] which simply reads all data into a slice, or writes all
+/// data from a slice. The packet ID is included in the slice.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Debug)]
+pub struct RawPacket<'a>(pub &'a [u8]);
+
+impl<'a> Packet<'a> for RawPacket<'a> {
+    fn packet_id(&self) -> i32 {
+        -1
+    }
+
+    fn packet_name(&self) -> &str {
+        "RawPacket"
+    }
+
+    fn encode_packet(&self, mut w: impl Write) -> Result<()> {
+        Ok(w.write_all(self.0)?)
+    }
+
+    fn decode_packet(r: &mut &'a [u8]) -> Result<Self> {
+        Ok(Self(mem::take(r)))
+    }
+}