Change Title's inner value and message type to Text (#518)

* Change Title's inner value to Text

* Change title and message serialization to serde_json

Author: Iaiao

Cargo.lock

@@ -25,6 +25,7 @@ tempfile = "3"
 vec-arena = "1"
 wasmer = { version = "2", default-features = false, features = [ "jit" ] }
 wasmer-wasi = { version = "2", default-features = false, features = [ "host-fs", "sys" ] }
+serde_json = "1"
 
 [features]
 llvm = [ "wasmer/llvm" ]

feather/plugin-host/Cargo.toml

@@ -328,6 +328,20 @@ impl PluginContext {
         }
     }
 
+    /// Accesses a `json`-encoded value in the plugin's memory space.
+    pub fn read_json<T: DeserializeOwned>(
+        &self,
+        ptr: PluginPtr<u8>,
+        len: u32,
+    ) -> anyhow::Result<T> {
+        // SAFETY: we do not return a reference to these
+        // bytes.
+        unsafe {
+            let bytes = self.deref_bytes(ptr.cast(), len)?;
+            serde_json::from_slice(bytes).map_err(From::from)
+        }
+    }
+
     /// Deserializes a component value in the plugin's memory space.
     pub fn read_component<T: Component>(&self, ptr: PluginPtr<u8>, len: u32) -> anyhow::Result<T> {
         // SAFETY: we do not return a reference to these

feather/plugin-host/src/context.rs

@@ -17,12 +17,11 @@ pub fn entity_send_message(
     message_ptr: PluginPtr<u8>,
     message_len: u32,
 ) -> anyhow::Result<()> {
-    let message = cx.read_string(message_ptr, message_len)?;
+    let message = cx.read_json(message_ptr, message_len)?;
     let entity = Entity::from_bits(entity);
-    let _ = cx.game_mut().send_message(
-        entity,
-        ChatMessage::new(ChatKind::System, Text::from(message)),
-    );
+    let _ = cx
+        .game_mut()
+        .send_message(entity, ChatMessage::new(ChatKind::System, message));
     Ok(())
 }
 
@@ -33,7 +32,7 @@ pub fn entity_send_title(
     title_ptr: PluginPtr<u8>,
     title_len: u32,
 ) -> anyhow::Result<()> {
-    let title = cx.read_bincode(title_ptr, title_len)?;
+    let title = cx.read_json(title_ptr, title_len)?;
     let entity = Entity::from_bits(entity);
     cx.game_mut().send_title(entity, title);
     Ok(())

feather/plugin-host/src/host_calls/entity.rs

@@ -485,11 +485,15 @@ impl Client {
             self.send_packet(Title::Reset);
         } else {
             if let Some(main_title) = title.title {
-                self.send_packet(Title::SetTitle { text: main_title });
+                self.send_packet(Title::SetTitle {
+                    text: main_title.to_string(),
+                });
             }
 
             if let Some(sub_title) = title.sub_title {
-                self.send_packet(Title::SetSubtitle { text: sub_title })
+                self.send_packet(Title::SetSubtitle {
+                    text: sub_title.to_string(),
+                })
             }
 
             self.send_packet(Title::SetTimesAndDisplay {

feather/server/src/client.rs

@@ -1,10 +1,11 @@
+use crate::Text;
 use serde::{Deserialize, Serialize};
 
 // Based on https://wiki.vg/index.php?title=Protocol&oldid=16459#Title
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
 pub struct Title {
-    pub title: Option<String>,
-    pub sub_title: Option<String>,
+    pub title: Option<Text>,
+    pub sub_title: Option<Text>,
     pub fade_in: u32,
     pub stay: u32,
     pub fade_out: u32,

libcraft/text/src/title.rs

@@ -17,4 +17,5 @@ quill-common = { path = "../common" }
 thiserror = "1"
 uuid = "0.8"
 itertools = "0.10.0"
+serde_json = "1"
 

quill/api/Cargo.toml

@@ -1,3 +1,4 @@
+use libcraft_text::Text;
 use std::{marker::PhantomData, ptr};
 
 use quill_common::{Component, Pointer, PointerMut};
@@ -92,16 +93,16 @@ impl Entity {
     ///
     /// The message sends as a "system" message.
     /// See [the wiki](https://wiki.vg/Chat) for more details.
-    pub fn send_message(&self, message: impl AsRef<str>) {
-        let message = message.as_ref();
+    pub fn send_message(&self, message: impl Into<Text>) {
+        let message = message.into().to_string();
         unsafe {
             quill_sys::entity_send_message(self.id.0, message.as_ptr().into(), message.len() as u32)
         }
     }
 
     /// Sends the given title to this entity.
     pub fn send_title(&self, title: &libcraft_text::Title) {
-        let title = bincode::serialize(title).expect("failed to serialize Title");
+        let title = serde_json::to_string(title).expect("failed to serialize Title");
         unsafe {
             quill_sys::entity_send_title(self.id.0, title.as_ptr().into(), title.len() as u32);
         }

quill/api/src/entity.rs

@@ -27,8 +27,8 @@ fn title_system(plugin: &mut TitleExample, game: &mut Game) {
 
         // Create a title to send to the player
         let title = Title {
-            title: Some(Text::from(title_component).to_string()),
-            sub_title: Some(Text::from(component).to_string()),
+            title: Some(Text::from(title_component)),
+            sub_title: Some(Text::from(component)),
             fade_in: 5,
             stay: 400,
             fade_out: 5,

quill/example-plugins/titles/src/lib.rs

@@ -97,7 +97,7 @@ extern "C" {
     /// The given `Title` should contain at least a `title` or a `sub_title`
     ///
     /// Does nothing if the entity does not exist or if it does not have the `Chat` component.
-    pub fn entity_send_title(entity: EntityId, title_ptr: Pointer<u8>, title_len: u32);
+    pub fn entity_send_title(entity: EntityId, title_json_ptr: Pointer<u8>, title_len: u32);
 
     /// Creates an empty entity builder.
     ///