Merge branch 'master' into master

Pumpkin-MC · Aug 21, 2024 · 1bbadf7 · 1bbadf7
2 parents 816215c + c02200c
commit 1bbadf7
Show file tree

Hide file tree

Showing 43 changed files with 107 additions and 126 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -2,23 +2,9 @@
 	"name": "Pumpkin",
 	"image": "mcr.microsoft.com/devcontainers/base:noble",
 	"features": {
-		// rust is needed for compiling the server's code
-		"ghcr.io/devcontainers/features/rust:1": {},
-		// java is needed for decompiling Mojang's server jar
-		"ghcr.io/devcontainers/features/java:1": {
-			"version": "21",
-			"jdkDistro": "oracle",
-			"installMaven": true,
-			"mavenVersion": "latest"
-		},
-		// python is needed for decompiling Mojang's server jar
-		"ghcr.io/devcontainers/features/python:1": {
-			"installTools": true,
-			"version": "3.7"
-		}
+		"ghcr.io/devcontainers/features/rust:1": {}
 	},
 	"mounts": [
-		// mount SSH config & public keys from host to enable SSH-based Git remotes
 		"source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/vscode/.ssh,readonly,type=bind"
 	],
 	"forwardPorts": [
@@ -28,8 +14,7 @@
 		"vscode": {
 			"extensions": [
 				"eamodio.gitlens",
-				"Swellaby.rust-pack",
-				"vscjava.vscode-java-pack"
+				"Swellaby.rust-pack"
 			]
 		}
 	}

diff --git a/.gitignore b/.gitignore
@@ -85,4 +85,7 @@ world/
 
 # project's binary configurations
 configuration.toml
-features.toml
+features.toml
+
+
+*.local.nbt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -25,6 +25,10 @@ There are several ways you can contribute to Pumpkin:
   Ensure your code adheres to the project's coding style guidelines (if any).
   Write clear and concise commit messages that describe your changes.
 
+### Project Structure
+
+Before contributing, it would be helpful to get to know the project structure, for further information, visit [STRUCTURE.md](STRUCTURE.md)
+
 ### Additional Information
 
 We encourage you to comment on existing issues and pull requests to share your thoughts and provide feedback.

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = [ "pumpkin-entity", "pumpkin-inventory", "pumpkin-macros/", "pumpkin-protocol/", "pumpkin-registry/", "pumpkin-world", "pumpkin/" ]
+members = [ "pumpkin-core", "pumpkin-entity", "pumpkin-inventory", "pumpkin-macros/", "pumpkin-protocol/", "pumpkin-registry/", "pumpkin-world", "pumpkin/"]
 
 [workspace.package]
 version = "0.1.0"
@@ -12,5 +12,6 @@ lto = true
 codegen-units = 1
 
 [workspace.dependencies]
-tokio = { version = "1.39.2", features = ["net", "macros", "rt-multi-thread", "fs", "io-util"] }
+tokio = { version = "1.39.2", features = ["net", "macros", "rt-multi-thread", "fs", "io-util", "sync"] }
 rayon = "1.10.0"
+uuid = { version = "1.10.0", features = ["serde", "v3"] }
diff --git a/STRUCTURE.md b/STRUCTURE.md
@@ -0,0 +1,17 @@
+# Project Structure
+
+## Overview
+
+Pumpkin is split into multiple crates, thus having a set project structure between contributors is essential.
+
+## Pumpkin-Core
+
+The core crate has some special rules that only apply to it:
+
+- It may not depend on any other pumpkin crate
+- There may not be any files directly under src/, except for the mod.rs file (this is to help with organisation)
+
+## Other crate rules
+
+- [`pumpkin-protocol`](/pumpkin-protocol/) - contains definitions for packet types **and** their serialization (be it through serde, or manually implementing `ClientPacket`/`ServerPacket`), only the `pumpkin` crate may depend on this
+- `pumpkin-macros` - similarly to `pumpkin-core`, it may not depend on any other pumpkin crate
diff --git a/mc-source-code/decompile.sh b/mc-source-code/decompile.sh
diff --git a/mc-source-code/pom.xml b/mc-source-code/pom.xml
diff --git a/pumpkin-command/src/lib.rs b/pumpkin-command/src/lib.rs
diff --git a/pumpkin-text/Cargo.toml → pumpkin-core/Cargo.toml b/pumpkin-text/Cargo.toml → pumpkin-core/Cargo.toml
@@ -1,9 +1,9 @@
 [package]
-name = "pumpkin-text"
+name = "pumpkin-core"
 version.workspace = true
 edition.workspace = true
 
 [dependencies]
 serde = { version = "1.0", features = ["derive"] }
 fastnbt = { git = "https://github.com/owengage/fastnbt.git" }
-uuid = "1.10"
+uuid.workspace = true
diff --git a/pumpkin-core/src/lib.rs b/pumpkin-core/src/lib.rs
@@ -0,0 +1 @@
+pub mod text;
diff --git a/pumpkin-text/README.md → pumpkin-core/src/text/_README.md b/pumpkin-text/README.md → pumpkin-core/src/text/_README.md
diff --git a/pumpkin-text/src/click.rs → pumpkin-core/src/text/click.rs b/pumpkin-text/src/click.rs → pumpkin-core/src/text/click.rs
diff --git a/pumpkin-text/src/color.rs → pumpkin-core/src/text/color.rs b/pumpkin-text/src/color.rs → pumpkin-core/src/text/color.rs
diff --git a/pumpkin-text/src/hover.rs → pumpkin-core/src/text/hover.rs b/pumpkin-text/src/hover.rs → pumpkin-core/src/text/hover.rs
@@ -2,7 +2,7 @@ use std::borrow::Cow;
 
 use serde::{Deserialize, Serialize};
 
-use crate::Text;
+use super::Text;
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(tag = "action", content = "contents", rename_all = "snake_case")]

diff --git a/pumpkin-text/src/lib.rs → pumpkin-core/src/text/mod.rs b/pumpkin-text/src/lib.rs → pumpkin-core/src/text/mod.rs
diff --git a/pumpkin-text/src/style.rs → pumpkin-core/src/text/style.rs b/pumpkin-text/src/style.rs → pumpkin-core/src/text/style.rs
@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::{
+use super::{
     click::ClickEvent,
     color::{self, Color},
     hover::HoverEvent,

diff --git a/pumpkin-protocol/Cargo.toml b/pumpkin-protocol/Cargo.toml
@@ -6,11 +6,11 @@ edition.workspace = true
 [dependencies]
 pumpkin-macros = { path = "../pumpkin-macros" }
 pumpkin-world =  { path = "../pumpkin-world" }
-pumpkin-text = { path = "../pumpkin-text" }
+pumpkin-core = { path = "../pumpkin-core" }
 
 bytes = "1.7"
 
-uuid = "1.10"
+uuid.workspace = true
 
 serde = { version = "1.0", features = ["derive"] }
 # to parse strings to json responses

diff --git a/pumpkin-protocol/src/bytebuf/mod.rs b/pumpkin-protocol/src/bytebuf/mod.rs
@@ -168,9 +168,8 @@ impl ByteBuffer {
     /// some, then it also calls the `write` closure.
     pub fn put_option<T>(&mut self, val: &Option<T>, write: impl FnOnce(&mut Self, &T)) {
         self.put_bool(val.is_some());
-        match val {
-            Some(v) => write(self, v),
-            None => {}
+        if let Some(v) = val {
+            write(self, v)
         }
     }
 

diff --git a/pumpkin-protocol/src/client/config/c_add_resource_pack.rs b/pumpkin-protocol/src/client/config/c_add_resource_pack.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 use crate::uuid::UUID;

diff --git a/pumpkin-protocol/src/client/play/c_actionbar.rs b/pumpkin-protocol/src/client/play/c_actionbar.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 #[derive(Serialize)]

diff --git a/pumpkin-protocol/src/client/play/c_disguised_chat_message.rs b/pumpkin-protocol/src/client/play/c_disguised_chat_message.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 use crate::VarInt;

diff --git a/pumpkin-protocol/src/client/play/c_open_screen.rs b/pumpkin-protocol/src/client/play/c_open_screen.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 use crate::VarInt;

diff --git a/pumpkin-protocol/src/client/play/c_play_disconnect.rs b/pumpkin-protocol/src/client/play/c_play_disconnect.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 #[derive(Serialize)]

diff --git a/pumpkin-protocol/src/client/play/c_player_chat_message.rs b/pumpkin-protocol/src/client/play/c_player_chat_message.rs
@@ -1,7 +1,7 @@
 use num_derive::{FromPrimitive, ToPrimitive};
 use num_traits::FromPrimitive;
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 use crate::{bytebuf::ByteBuffer, uuid::UUID, BitSet, ClientPacket, VarInt};

diff --git a/pumpkin-protocol/src/client/play/c_set_title.rs b/pumpkin-protocol/src/client/play/c_set_title.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 #[derive(Serialize)]

diff --git a/pumpkin-protocol/src/client/play/c_subtitle.rs b/pumpkin-protocol/src/client/play/c_subtitle.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 #[derive(Serialize)]

diff --git a/pumpkin-protocol/src/client/play/c_system_chat_message.rs b/pumpkin-protocol/src/client/play/c_system_chat_message.rs
@@ -1,5 +1,5 @@
+use pumpkin_core::text::TextComponent;
 use pumpkin_macros::packet;
-use pumpkin_text::TextComponent;
 use serde::Serialize;
 
 #[derive(Serialize)]

diff --git a/pumpkin-protocol/src/lib.rs b/pumpkin-protocol/src/lib.rs
@@ -188,8 +188,8 @@ pub struct StatusResponse {
     pub version: Version,
     pub players: Players,
     pub description: String,
-    pub favicon: String, // data:image/png;base64,<data>
-                         // Players, favicon ...
+    pub favicon: Option<String>, // data:image/png;base64,<data>
+                                 // Players, favicon ...
 }
 #[derive(Serialize)]
 pub struct Version {

diff --git a/pumpkin-protocol/src/slot.rs b/pumpkin-protocol/src/slot.rs
@@ -22,8 +22,8 @@ impl<'de> Deserialize<'de> for Slot {
     where
         D: de::Deserializer<'de>,
     {
-        struct VarIntVisitor;
-        impl<'de> Visitor<'de> for VarIntVisitor {
+        struct Visitor;
+        impl<'de> de::Visitor<'de> for Visitor {
             type Value = Slot;
 
             fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
@@ -73,7 +73,7 @@ impl<'de> Deserialize<'de> for Slot {
             }
         }
 
-        deserializer.deserialize_seq(VarIntVisitor)
+        deserializer.deserialize_seq(Visitor)
     }
 }
 
@@ -129,6 +129,7 @@ impl Serialize for Slot {
     }
 }
 
+
 impl Slot {
     pub fn to_item(self) -> Option<Item> {
         let item_id = self.item_id?.0.try_into().unwrap();

diff --git a/pumpkin-registry/Cargo.toml b/pumpkin-registry/Cargo.toml
@@ -5,7 +5,7 @@ edition.workspace = true
 
 [dependencies]
 pumpkin-protocol = { path = "../pumpkin-protocol"}
-pumpkin-text = { path = "../pumpkin-text"}
+pumpkin-core = { path = "../pumpkin-core"}
 
 # nbt
 fastnbt = { git = "https://github.com/owengage/fastnbt.git" }

diff --git a/pumpkin-registry/src/chat_type.rs b/pumpkin-registry/src/chat_type.rs
@@ -1,4 +1,4 @@
-use pumpkin_text::style::Style;
+use pumpkin_core::text::style::Style;
 use serde::Serialize;
 
 #[derive(Debug, Clone, Serialize)]