Relevant source files

The following files were used as context for generating this wiki page: - [src/main/java/net/noyji/thequestforge/content/item/custom/GuildBookItem.java](https://github.com/Noyji/TheQuestForge-1.21.1/blob/main/src/main/java/net/noyji/thequestforge/content/item/custom/GuildBookItem.java) - [src/main/java/net/noyji/thequestforge/content/block/TheQuestForgeBlocks.java](https://github.com/Noyji/TheQuestForge-1.21.1/blob/main/src/main/java/net/noyji/thequestforge/content/block/TheQuestForgeBlocks.java) - [src/main/java/net/noyji/thequestforge/content/item/ItemsHooks.java](https://github.com/Noyji/TheQuestForge-1.21.1/blob/main/src/main/java/net/noyji/thequestforge/content/item/ItemsHooks.java) - [src/main/java/net/noyji/thequestforge/config/CommonConfig.java](https://github.com/Noyji/TheQuestForge-1.21.1/blob/main/src/main/java/net/noyji/thequestforge/config/CommonConfig.java) - [src/main/resources/assets/thequestforge/lang/en_us.json](https://github.com/Noyji/TheQuestForge-1.21.1/blob/main/src/main/resources/assets/thequestforge/lang/en_us.json) - [src/main/java/net/noyji/thequestforge/utils/QuestUtils.java](https://github.com/Noyji/TheQuestForge-1.21.1/blob/main/src/main/java/net/noyji/thequestforge/utils/QuestUtils.java)

# Custom Items & Blocks The Quest Forge mod introduces specialized items and blocks designed to facilitate the questing system and NPC management. These elements serve as the primary interface for players to interact with quest data and for world-builders to initialize quest-related entities. The system leverages NeoForge's registry system to ensure proper integration with the Minecraft engine. Key components include the **Guild Book**, which acts as a portable quest log, and the **Spawn Guild Master Block**, used for utility purposes within the mod's infrastructure. These items are often tied to client-side hooks and configuration settings that determine their behavior and appearance. Sources: [src/main/java/net/noyji/thequestforge/content/item/custom/GuildBookItem.java](), [src/main/java/net/noyji/thequestforge/content/block/TheQuestForgeBlocks.java]() ## Custom Items Architecture The project implements custom items by extending the standard Minecraft `Item` class and utilizing `DeferredRegister` for safe registration. The most significant item is the `GuildBookItem`, which serves as a trigger for opening the quest interface. ### Guild Book System The Guild Book is a functional item that, when used by a player, triggers a client-side hook to open the Quest GUI. This involves a check for the execution side to prevent server-side crashes when attempting to open UI elements. ```mermaid sequenceDiagram participant P as Player participant I as GuildBookItem participant H as ItemsHooks participant G as GuildBookPlayerQuestsGui P->>I: Right-Click (use) I->>I: check level.isClientSide I->>H: openGuildBook() H->>G: setScreen(new GuildBookPlayerQuestsGui) G-->>P: Display Quest UI ``` The diagram shows the flow from a player using the item to the final rendering of the Quest GUI. Sources: [src/main/java/net/noyji/thequestforge/content/item/custom/GuildBookItem.java:18-24](), [src/main/java/net/noyji/thequestforge/content/item/ItemsHooks.java:16-21]() ### Custom Item Registry Items are registered within a dedicated registry system. For blocks, the system automatically generates a corresponding `BlockItem` so they can be held and placed by players. | Registry Name | Class | Description | | :--- | :--- | :--- | | `guild_book` | `GuildBookItem` | Portable quest log used to view active and available quests. | | `spawn_guild_master_block` | `BlockItem` | Item form of the Guild Master spawn block. | | `guild_master_spawn_egg` | `Item` | Special egg for spawning the Guild Master NPC. | Sources: [src/main/java/net/noyji/thequestforge/content/block/TheQuestForgeBlocks.java:30-33](), [src/main/resources/assets/thequestforge/lang/en_us.json:101]() ## Custom Blocks Architecture The block system uses a centralized registry in `TheQuestForgeBlocks`. Every block registered through this system is paired with a `BlockItem` automatically using a supplier-based registration pattern. ### Block Registration Logic The `registerBlock` helper method handles both the block registration and the subsequent item registration to ensure consistency. ```java private static DeferredBlock registerBlock(String name, Supplier block){ DeferredBlock toReturn = BLOCKS.register(name, block); registerBlockItem(name, toReturn); return toReturn; } private static void registerBlockItem(String name, DeferredBlock block){ TheQuestForgeItems.ITEMS.register(name, () -> new BlockItem(block.get(), new Item.Properties())); } ``` Sources: [src/main/java/net/noyji/thequestforge/content/block/TheQuestForgeBlocks.java:25-33]() ### Registry Details | Block ID | Implementation Class | Purpose | | :--- | :--- | :--- | | `spawn_guild_master_block` | `SpawnGuildMasterBlock` | Specific block used to initialize or summon the Guild Master entity. | Sources: [src/main/java/net/noyji/thequestforge/content/block/TheQuestForgeBlocks.java:17-18]() ## Item Utilities and Matching Logic Items in The Quest Forge are not just decorative; they are integrated into the quest task system. The `QuestUtils` class provides "smart matching" capabilities to verify if items in a player's inventory satisfy quest requirements. ### Smart Matching Logic The system compares items based on several criteria beyond just the item ID: 1. **Item Identity**: Checks if the basic item types match. 2. **Custom Names**: If a quest requires an item with a specific name, the system validates the `DataComponents.CUSTOM_NAME`. 3. **Enchantments**: Validates that the item has the required enchantments and minimum levels. 4. **Potion Contents**: Matches specific potion types if applicable. ```mermaid flowchart TD Start[Match Item] --> IDCheck{Same Item ID?} IDCheck -- No --> Fail[Return False] IDCheck -- Yes --> NameCheck{Requirement has Name?} NameCheck -- Yes --> NameMatch{Names Match?} NameMatch -- No --> Fail NameMatch -- Yes --> EnchCheck{Requirement has Enchants?} NameCheck -- No --> EnchCheck EnchCheck -- Yes --> EnchLevel{Levels sufficient?} EnchLevel -- No --> Fail EnchLevel -- Yes --> Success[Return True] EnchCheck -- No --> Success ``` The flow represents the logic used in `QuestUtils.smartMatch` to ensure players provide exactly what a quest requires. Sources: [src/main/java/net/noyji/thequestforge/utils/QuestUtils.java:76-116]() ## Configuration and Currency The custom item system is influenced by global configurations, particularly regarding rewards and economy. * **Currency Item**: The item used as currency is configurable via `CommonConfig.currency`, defaulting to `minecraft:emerald`. * **Item Handling**: The utility system provides methods to `giveItems` (adding to inventory or dropping at feet if full) and `removeItems` (searching both main inventory and offhand). Sources: [src/main/java/net/noyji/thequestforge/config/CommonConfig.java:125](), [src/main/java/net/noyji/thequestforge/utils/QuestUtils.java:44-65](), [src/main/java/net/noyji/thequestforge/utils/QuestUtils.java:118-132]() ## Summary Custom Items and Blocks in The Quest Forge provide the essential physical components for the questing lifecycle. The **Guild Book** acts as the primary UI bridge for players, while the **Spawn Guild Master Block** handles entity initialization. Underpinning these is a robust utility system that ensures quest-related items are matched accurately based on metadata like enchantments and custom names, allowing for complex "collection" tasks.