feat(engine, tag): add book API

Author: andrewgazelka

crates/hyperion-item/src/builder.rs

@@ -1,8 +1,11 @@
 use flecs_ecs::core::Entity;
 use valence_protocol::{nbt, nbt::Value, ItemKind, ItemStack};
 
+mod book;
+pub use book::BookBuilder;
+
 /// A builder for creating Minecraft items with NBT data
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 #[must_use]
 pub struct ItemBuilder {
     kind: ItemKind,

crates/hyperion-item/src/builder/book.rs

@@ -0,0 +1,50 @@
+use hyperion::{ItemKind, ItemStack};
+use valence_protocol::nbt;
+
+use crate::builder::ItemBuilder;
+
+#[derive(Clone, Debug)]
+#[must_use]
+pub struct BookBuilder {
+    item: ItemBuilder,
+}
+
+// /give @p minecraft:written_book{author:"AuthorName",title:"BookTitle",pages:['{"text":"Page content"}']}
+
+impl BookBuilder {
+    pub fn new(author: impl Into<String>, title: impl Into<String>) -> Self {
+        let mut item = ItemBuilder::new(ItemKind::WrittenBook);
+
+        let author = author.into();
+        let title = title.into();
+
+        let mut nbt = nbt::Compound::new();
+
+        nbt.insert("author", nbt::Value::String(author));
+        nbt.insert("resolved", nbt::Value::Byte(1));
+        nbt.insert("title", nbt::Value::String(title));
+        nbt.insert("pages", nbt::Value::List(nbt::List::String(Vec::new())));
+
+        item.nbt = Some(nbt);
+
+        Self { item }
+    }
+
+    pub fn add_page(mut self, page: impl Into<String>) -> Self {
+        let page = page.into();
+        let json = format!(r#"{{"text":"{page}"}}"#);
+
+        if let Some(nbt) = &mut self.item.nbt {
+            if let nbt::Value::List(nbt::List::String(pages)) = nbt.get_mut("pages").unwrap() {
+                pages.push(json);
+            }
+        }
+
+        self
+    }
+
+    #[must_use]
+    pub fn build(self) -> ItemStack {
+        self.item.build()
+    }
+}

crates/hyperion-item/src/lib.rs

@@ -4,8 +4,8 @@ use flecs_ecs::{
     macros::Component,
     prelude::Module,
 };
-use hyperion::storage::{EventFn, GlobalEventHandlers};
-use valence_protocol::{nbt, Hand};
+use hyperion::storage::{ClickEvent, EventFn, GlobalEventHandlers};
+use valence_protocol::nbt;
 
 pub mod builder;
 
@@ -14,7 +14,7 @@ pub struct ItemModule;
 
 #[derive(Component, Constructor, Deref, DerefMut)]
 pub struct Handler {
-    on_click: EventFn<Hand>,
+    on_click: EventFn<ClickEvent>,
 }
 
 impl Module for ItemModule {
@@ -23,7 +23,7 @@ impl Module for ItemModule {
         world.component::<Handler>();
 
         world.get::<&mut GlobalEventHandlers>(|handlers| {
-            handlers.click.register(|query, hand| {
+            handlers.click.register(|query, event| {
                 let world = query.world;
                 let inventory = &mut *query.inventory;
 
@@ -51,7 +51,7 @@ impl Module for ItemModule {
 
                 handler.try_get::<&Handler>(|handler| {
                     let on_interact = &handler.on_click;
-                    on_interact(query, hand);
+                    on_interact(query, event);
                 });
             });
         });

crates/hyperion-rank-tree/src/inventory.rs

@@ -1,6 +1,6 @@
 use flecs_ecs::core::{World, WorldGet};
 use hyperion_inventory::PlayerInventory;
-use hyperion_item::builder::{AttackDamage, Color, ItemBuilder};
+use hyperion_item::builder::{AttackDamage, BookBuilder, Color, ItemBuilder};
 use valence_protocol::ItemKind;
 
 use crate::{Handles, Rank, Team};
@@ -22,7 +22,8 @@ pub const MAIN_SLOT: u16 = 0;
 pub const PICKAXE_SLOT: u16 = 1;
 pub const BLOCK_SLOT: u16 = 2;
 pub const UPGRADE_START_SLOT: u16 = 3;
-pub const GUI_SLOT: u16 = 8;
+pub const GUI_SLOT: u16 = 7;
+pub const HELP_SLOT: u16 = 8;
 
 impl Rank {
     pub fn apply_inventory(
@@ -32,9 +33,34 @@ impl Rank {
         world: &World,
         build_count: i8,
     ) {
+        inventory.clear();
         let upgrade_not_available = ItemBuilder::new(ItemKind::GrayDye);
 
-        inventory.clear();
+        let book = BookBuilder::new("§b@andrewgazelka", "§6§l10k Guide")
+            .add_page(
+                "§6Welcome to Hyperion!\n\n§7This is a §c10,000§7 player PvP battle to break the \
+                 Guinness World Record!\n\n§7Current record: §b8,825 players",
+            )
+            .add_page(
+                "§6§lTeams\n\n§cRed Team\n§9Blue Team\n§aGreen Team\n§6Yellow Team\n\n§7Teams are \
+                 identified by boot color!",
+            )
+            .add_page(
+                "§6§lProgression\n\n§7Gain XP by:\n§7- Mining ores\n§7- Killing players\n\n§7When \
+                 killed:\n§7- Keep §61/3§7 of XP\n§7- Killer gets §61/2§7 of your XP",
+            )
+            .add_page(
+                "§6§lClasses\n\n§7Everyone starts with the §dStick§7 class\n\n§7Unlock new \
+                 classes by gaining XP and defeating players!\n\n§7Upgrade your gear to become \
+                 stronger!",
+            )
+            .add_page(
+                "§6§lControls\n\n§7[1-4] §7Combat Items\n§7[5-6] §7Building Blocks\n§7[7] \
+                 §7Upgrades Menu\n§7[8] §7Help Book\n\n§6Good luck!",
+            )
+            .build();
+
+        inventory.set_hotbar(HELP_SLOT, book);
 
         let color = match team {
             Team::Red => Color(255, 0, 0),
@@ -49,7 +75,7 @@ impl Rank {
 
         inventory.set_boots(boots);
 
-        let upgrades = ["Speed", "Vision", "Health", "Armor", "Damage"];
+        let upgrades = ["Speed", "Health", "Armor", "Damage"];
 
         world.get::<&Handles>(|handles| {
             for (i, upgrade) in upgrades.into_iter().enumerate() {

crates/hyperion-rank-tree/src/lib.rs

@@ -4,8 +4,7 @@ use flecs_ecs::{
     macros::Component,
     prelude::Module,
 };
-use hyperion::storage::EventFn;
-use valence_protocol::Hand;
+use hyperion::storage::{ClickEvent, EventFn};
 
 pub mod inventory;
 pub mod skin;
@@ -51,7 +50,7 @@ impl Module for RankTree {
         world.component::<Rank>();
         world.component::<Handles>();
 
-        let handler: EventFn<Hand> = |query, _| {
+        let handler: EventFn<ClickEvent> = |query, _| {
             let cursor = query.inventory.get_cursor();
             println!("clicked {cursor:?}");
         };

crates/hyperion/src/simulation/handlers.rs

@@ -8,7 +8,10 @@ use geometry::aabb::Aabb;
 use glam::{IVec3, Vec3};
 use hyperion_utils::EntityExt;
 use tracing::{info, instrument, trace, warn};
-use valence_generated::block::{BlockKind, BlockState, PropName};
+use valence_generated::{
+    block::{BlockKind, BlockState, PropName},
+    item::ItemKind,
+};
 use valence_protocol::{
     Decode, Hand, ItemStack, Packet, VarInt,
     packets::play::{
@@ -28,7 +31,7 @@ use super::{
 use crate::{
     net::{Compose, NetworkStreamRef, decoder::BorrowedPacketFrame},
     simulation::{Pitch, Yaw, aabb, event, event::PluginMessage, metadata::entity::Pose},
-    storage::{CommandCompletionRequest, Events, GlobalEventHandlers},
+    storage::{ClickEvent, CommandCompletionRequest, Events, GlobalEventHandlers},
     system_registry::SystemId,
 };
 
@@ -334,9 +337,25 @@ pub fn player_interact_item(
     mut data: &'static [u8],
     query: &mut PacketSwitchQuery<'_>,
 ) -> anyhow::Result<()> {
-    let packet = play::PlayerInteractItemC2s::decode(&mut data)?;
+    let play::PlayerInteractItemC2s { hand, sequence } =
+        play::PlayerInteractItemC2s::decode(&mut data)?;
+
+    let event = ClickEvent {
+        hand,
+        sequence: sequence.0,
+    };
+
+    let cursor = query.inventory.get_cursor();
+
+    if !cursor.is_empty() && cursor.item == ItemKind::WrittenBook {
+        let packet = play::OpenWrittenBookS2c { hand };
+
+        query
+            .compose
+            .unicast(&packet, query.io_ref, SystemId(0), query.world)?;
+    }
 
-    query.handlers.click.trigger_all(query, &packet.hand);
+    query.handlers.click.trigger_all(query, &event);
 
     Ok(())
 }

crates/hyperion/src/storage/event/sync.rs

@@ -10,9 +10,14 @@ pub struct CommandCompletionRequest<'a> {
     pub id: i32,
 }
 
+pub struct ClickEvent {
+    pub hand: Hand,
+    pub sequence: i32,
+}
+
 #[derive(Component, Default)]
 pub struct GlobalEventHandlers {
-    pub click: EventHandlers<Hand>,
+    pub click: EventHandlers<ClickEvent>,
 
     // todo: this should be a lifetime for<'a>
     pub completion: EventHandlers<CommandCompletionRequest<'static>>,