TypeWriter Extensions

Back

🧬 MythicMob NPC Extension

Seamlessly use MythicMobs as cinematic NPCs in TypeWriter.

✨ Overview

This extension integrates MythicMobs as NPCs inside TypeWriter. It focuses on definition, control, and cinematic usage of MythicMob-based NPCs.

🎭 Turn MythicMobs into reusable NPC definitions and instances.
🎥 Drive camera focus, look-at interactions and scripted cinematics.
🧠 Read NPC facts & variables for conditions, UI and logic.
⚙️ Control speed, stance, skills and behavior within quests.

🎭 NPC Control

Spawn / hide MythicMob NPCs when entering a scene.
Attach interactions when the player clicks on them.
Use NPCs as persistent “story characters”.

🎥 Cinematic Integration

Focus the camera on a specific MythicMob.
Force the player to look at the NPC at key moments.
Cast MythicMob skills during cutscenes.

📊 Gameplay Logic

Check NPC presence, distance and visibility.
Read health, level, faction, stance, animations.
Build conditions based on combat or threat table.

🧩 Core Entries

📍 NPC Definitions & Visibility

mythicmob_npc_definition – Defines a MythicMob that can be used as an NPC.
mythicmob_npc_instance – Represents a concrete instance of a MythicMob NPC.
mythicmob_npc_show – Shows a MythicMob NPC.
mythicmob_npc_hide – Hides a MythicMob NPC.

🤝 Interactions & Camera

mythicmob_npc_interact – Triggered when a player interacts with a MythicMob NPC.
mythicmob_npc_look_at_interaction_bound – Forces the player to look at a specific MythicMob NPC.
mythicmob_look_at_interaction_bound – Forces the player to look at a specific MythicMob around the player.
mythicmob_npc_camera_cinematic – Focuses the camera on a MythicMob NPC during a cinematic.
mythicmob_npc_skill_cinematic (v0.4) – Casts a MythicMob skill from a specific position in a cinematic.

🏃‍♂️ Movement, Stance & Skills

mythicmob_speed_data (v0.3) – Speed data of a MythicMob NPC.
modelengine_stance_data (v0.6) – Configure MythicMob NPC stances (idle, walk, etc.) with day/night variants for idle and walk.
mythicmob_skill_objective (v2.5) – Objective focused on skills from mobs (breed, interact, etc.).

📌 Facts (v2.0)

Facts are used in conditions to query the current state of a MythicMob NPC.

Fact	Description
`mythicmob_npc_presence_fact`	Checks if a specific MythicMob NPC is present within a defined radius.
`mythicmob_npc_distance_fact`	Returns the distance between the player and a MythicMob NPC (optionally limited by a radius).
`mythicmob_npc_visibility_fact`	Determines whether a MythicMob NPC is visible to the player.
`mythicmob_npc_health_percentage_fact`	Checks the current health percentage of a MythicMob NPC.
`mythicmob_npc_animation_playing_fact`	Checks if a MythicMob NPC is currently playing a specific ModelEngine animation.
`mythicmob_npc_threat_table_size_fact`	Returns the size of the NPC’s threat table; can optionally require the NPC to be in combat.

📊 Variables (v2.0)

Variables expose dynamic data about MythicMob NPCs to dialogs, conditions and UI.

Variable	Description
`mythicmob_npc_health_variable`	Returns the current health of a MythicMob NPC (Double).
`mythicmob_npc_max_health_variable`	Returns the maximum health of a MythicMob NPC (Double).
`mythicmob_npc_health_percentage_variable`	Returns the health percentage of a MythicMob NPC (Int, 0–100).
`mythicmob_npc_level_variable`	Returns the level of a MythicMob NPC (Double).
`mythicmob_npc_power_variable`	Returns the power value of a MythicMob NPC (Float).
`mythicmob_npc_faction_variable`	Returns the faction name of a MythicMob NPC (String).
`mythicmob_npc_stance_variable`	Returns the current stance of a MythicMob NPC (String).
`mythicmob_npc_active_animations_variable`	Returns the list of active animations currently playing on the NPC (String, supports separator).
`mythicmob_npc_variable`	Generic variable getter for MythicMob NPC custom data. Supports String, Int, Float or Double.

🎬 Cinematics & TypeWriter Integration

For everything related to artifact capture, camera paths, and other cinematic logic, you can keep using the existing TypeWriter entries. This extension is designed to plug MythicMob NPCs into that system:

Use mythicmob_npc_definition and mythicmob_npc_instance as targets for your cinematics.
Combine with TypeWriter’s artifact system for advanced camera work.
Drive narrative by syncing NPC presence, stance and skills with dialog pages.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

💬 TextDisplay Dialogue Extension

Use Minecraft TextDisplay entities as immersive dialogues inside TypeWriter.

✨ Overview

This extension adds support for TextDisplay-based dialogues in TypeWriter. Instead of using only chat or classic UI, you can render dialogues directly in the world using TextDisplay entities – perfect for in-world captions, holograms, and cinematic subtitles.

🪧 Show in-world dialogue lines via TextDisplay.
🎛 Configure options, spoken lines and cinematic flows.
⏱ Control display duration via a TypeWriter placeholder.
🎬 Combine with cinematics for fully diegetic story moments.

🪧 World-Space Dialogues

Show text directly above NPCs, objects or locations.
Keep the player immersed without relying on chat spam.
Use it for signs, floating captions, holograms, and more.

🎙 Spoken & Cinematic Lines

Display spoken lines during a dialogue sequence.
Time your text with camera movements and sounds.
Perfect for cutscenes and key story beats.

⏱ Timer Integration

Control how long text remains visible.
Drive pacing with a dedicated timer placeholder.
Keep multi-line dialogues clean and readable.

🧩 Entries

These entries expose different ways to use TextDisplay dialogues in your TypeWriter flows.

textdisplay_option – Add an Option TextDisplay Dialogue.
Use this to show choice-based or menu-like options via TextDisplay.
textdisplay_spoken – Add a Spoken TextDisplay Dialogue.
Ideal for character lines, short speech bubbles or NPC “talking” text.
textdisplay_cinematic – Add a Cinematic TextDisplay Dialogue.
Designed for cutscenes and scripted sequences, synchronized with camera and events.

⏱ Timer Placeholder

The extension provides a dedicated placeholder to control and/or display the dialogue timer.

Placeholder	Description
`%typewriter_textdisplaydialogue_timer%`	Represents the remaining or configured time for the current TextDisplay dialogue.

You can use this placeholder in UI elements or other text fields to show a countdown or simply to drive logic based on remaining time.

🧪 Usage Ideas

Show floating subtitles during boss fights or major events.
Display “thoughts” of the player or NPCs above their head.
Create tutorial panels in the world with short, readable text.
Combine with cinematics to sync text with camera pans and sound effects.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

🧱 ItemsAdder Integration Extension

Link TypeWriter with ItemsAdder to react to custom blocks and furniture.

✨ Overview

This extension connects TypeWriter with ItemsAdder by introducing new node entries for custom blocks and furniture. You can now trigger quests, objectives and story events when players build, break or interact with your ItemsAdder content.

🧱 Track placement and destruction of custom blocks.
🪑 React when furniture is placed or broken.
🎯 Use objectives to build progression around building / breaking actions.
📜 Integrate ItemsAdder blocks directly into TypeWriter quests.

🧱 Custom Blocks

Detect when players place specific ItemsAdder blocks.
Listen for break events on custom blocks.
Use block interactions as quest progression steps.

🪑 Furniture

React when furniture is placed in the world.
Detect when furniture is broken or removed.
Use furniture as decorative quest objectives (tables, chairs, props, etc.).

🎯 Quest Objectives

Create “build this structure”–type quests with custom blocks.
Require players to place or break certain furniture items.
Combine with other TypeWriter objectives for complex quest chains.

🧩 Entries

The extension adds both event triggers and objectives, covering placement and breaking of ItemsAdder blocks and furniture.

📡 Events

on_furniture_place_event – Triggers when a furniture is placed.
Use this to start dialogues, give rewards or update quest steps when a furniture is placed.
on_furniture_break_event – Triggers when a furniture is broken.
Ideal for cleanup logic, penalties, or destruction-based events.
on_customblock_place_event – Triggers when a custom block is placed.
Perfect for building quests or structure completion checks.
on_customblock_break_event – Triggers when a custom block is broken.
Useful for sabotage mechanics, mining tasks or cleanup phases.

🎯 Objectives

break_customblock_objective – An objective to break custom blocks.
Require players to mine or destroy specific ItemsAdder blocks as part of a quest.
place_customblock_objective – An objective to place custom blocks.
Ideal for construction objectives, building outposts or decorating areas.
break_furniture_objective – An objective to break furniture.
Can be used for “cleanup” tasks, raids, or destruction sequences.
place_furniture_objective – An objective to place furniture.
Great for furnishing houses, decorating player rooms or setting up scenes.

🧪 Usage Ideas

Create a quest where players must build a custom shrine using ItemsAdder blocks.
Ask players to furnish an NPC’s house with specific ItemsAdder furniture.
Track progressive construction of a town, outpost or base using custom blocks.
Use destruction objectives for siege events or raid-like scenarios.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

⚔️ MMOCore Integration Extension

Link TypeWriter to MMOCore to drive classes, professions, skills, waypoints and guilds directly from your stories.

✨ Overview

This extension connects TypeWriter with MMOCore by adding new node entries for actions, facts, groups, objectives and variables. You can read and manipulate the player’s class, professions, skills, waypoints, stats and guild as part of your quests.

📈 Control and reward professions & class levels directly from TypeWriter.
📍 Manage waypoints (lock, unlock, warp) in quest flows.
🧪 Use MMOCore facts (stats, attributes, skills) in conditions and branches.
👥 Target parties and guilds as groups for shared events.

🎓 Classes & Professions

Grant profession experience as quest rewards.
Check class level and profession progress.
Trigger events when players reach specific levels.

📍 Waypoints & Travel

Unlock waypoints as quest milestones.
Lock or revoke access when needed.
Teleport players using stellium-based warps.

👥 Parties & Guilds

Target entire MMOCore parties or guilds at once.
Read party member counts for scaling encounters.
Use guild info for faction-based stories.

⚙️ Actions

Actions modify the player's MMOCore profile or teleport them based on your quest logic.

add_profession_experience – Adds a quantity of experience to the specified MMOCore profession (or to the main class if empty).
mmocore_leave_skill_casting – Forces the player to leave MMOCore casting mode if a spell chain is in progress.
mmocore_lock_waypoint – Removes a player's access to a given MMOCore waypoint.
mmocore_unlock_waypoint – Unlocks a MMOCore waypoint for the targeted player.
mmocore_warp_waypoint – Teleports the player to a MMOCore waypoint, consuming the specified amount of stellium.

📌 Facts

Facts expose read-only values from the MMOCore profile for use in conditions and branching.

Fact	Description
`class_level_fact`	Returns the player's current MMOCore class level.
`party_members_fact`	Returns the number of members in the player's MMOCore party.
`mmocore_attribute_value_fact`	Returns the number of points invested in a specific MMOCore attribute.
`mmocore_player_boolean_fact`	Exposes boolean states (max level reached, casting spell, etc.).
`mmocore_player_number_fact`	Returns numerical values (level, experience, points, resources).
`mmocore_skill_fact`	Reads the level or unlock status of an MMOCore class skill.
`mmocore_stat_value_fact`	Returns the total or base value of an MMOCore stat.
`mmocore_profession_fact`	Provides the level or experience of a specific MMOCore profession.
`profession_level_fact`	Returns the MMOCore level achieved for a given profession (or the main class if empty).
`mmocore_skill_slot_bound_fact`	Indicates whether a MMOCore skill slot currently contains a skill.
`mmocore_skill_tree_node_fact`	Checks the level, unlock status, or maxed status of an MMOCore skill tree node.
`mmocore_waypoint_unlocked_fact`	Checks whether a specific MMOCore waypoint is unlocked by the player.
`guild_member_fact`	Returns the number of members in the player's MMOCore guild.
`guild_online_member_fact`	Returns the number of online members in the player's MMOCore guild.

👥 Groups

Groups let you target multiple players at once based on their MMOCore party or guild.

party_group – Groups players by their MMOCore party to address the entire party simultaneously.
guild_group – Groups players by their MMOCore guild to reach the entire guild at once.

🎯 Objectives

Objectives track the player's MMOCore progress and fire when your conditions are met.

profession_level_objective – Tracks a player's progress toward reaching a given MMOCore profession (or class) level, with a trigger upon completion.
mmocore_skill_cast_objective – Tracks when a player casts specific MMOCore skills, then triggers on completion.

📊 Variables

Variables provide string or list outputs you can display in UI, dialogues, or use in logic.

Variable	Description
`mmocore_active_casting_skills_variable`	Lists the skill IDs available in the current casting chain.
`mmocore_bound_skill_variable`	Returns the skill ID bound to a specific MMOCore slot.
`mmocore_friends_list_variable`	Lists the UUIDs of all of the player's MMOCore friends.
`mmocore_guild_name_variable`	Returns the name of the player's MMOCore guild or an empty string.
`player_class_variable`	Returns the readable name of the player's current MMOCore class.
`mmocore_player_class_variable`	Returns the internal ID of the player's MMOCore class.
`mmocore_unlocked_nodes_variable`	Lists the IDs of MMOCore skill tree nodes that have already been unlocked.
`mmocore_unlocked_skills_variable`	Lists the MMOCore skills unlocked for the current class.
`mmocore_waypoints_variable`	Returns all MMOCore waypoint IDs unlocked by the player.
`mmocore_guild_id_variable`	Returns the internal identifier of the player's MMOCore guild.
`mmocore_guild_tag_variable`	Returns the tag of the player's MMOCore guild.
`mmocore_guild_owner_variable`	Returns the UUID of the owner of the player's MMOCore guild.
`mmocore_guild_members_variable`	Lists the UUIDs of the members of the player's MMOCore guild.

💾 Download

🔗 Click to Download

🧿 MMOItems Integration Extension

Connect TypeWriter to MMOItems with events, objectives and variables for crafting, gems and item usage.

✨ Overview

This extension links TypeWriter to MMOItems by adding new node entries for crafting events, gem application, item consumption, and more. You can use these entries to drive quests and logic based on how players create and use MMOItems.

🛠 Track crafting in MMOItems crafting stations.
💎 React when players apply gem stones to their gear.
🧪 Detect item usage/consumption for potions, scrolls and more.
📊 Count MMOItems and expose them via facts & variables.

🛠 Crafting Flow

Trigger events when players craft specific MMOItems.
Open crafting stations directly from TypeWriter actions.
Track crafting station usage as quest objectives.

💎 Gem & Upgrade Logic

Detect when players apply gem stones to MMOItems.
Use gem application as progression or unlock gates.
Reward players for fully socketed or upgraded gear.

🧪 Item Usage & Checks

Track when players use or consume MMOItems.
Count items in hand or inventory for conditions.
Use a variable to check for specific MMOItems on players.

🧩 Entries

📡 Events

mmoitems_item_craft_event – Triggered when a player crafts an MMOItem using a crafting station.
mmoitems_gem_stone_apply_event – Triggered when a player applies a gem stone to an MMOItem.
use_mmoitem_event – Triggered when a player uses/consumes specific MMOItems.
open_crafting_table_event (via open_crafting_table_action) – Can be used to react when a player opens a crafting station.

🎯 Objectives

mmoitems_craft_objective – Tracks crafting of specific MMOItems.
use_mmoitem_objective – Tracks the usage/consumption of specific MMOItems.
mmoitems_gem_stone_apply_objective – Tracks applying gem stones to MMOItems.
open_crafting_table_objective – Tracks how often players open crafting stations.

⚙️ Actions

open_crafting_table_action – Opens an MMOItems crafting station for the player.
give_mmoitem_action – Gives MMOItems to a player (e.g. quest rewards, starting gear).

📌 Facts

mmoitems_count_fact – Counts the number of one or multiple MMOItems in hand or in inventory.
Useful for “bring X items” objectives or inventory checks.

📊 Variables

mmoitem_variable (v0.8) – Variable to check MMOItems for a player.
For example, to verify which item is in hand, or to check if a revision/specific item is present.

🧪 Usage Ideas

Create crafting quests where players must forge specific MMOItems in crafting stations.
Require players to socket gems into their weapons/armor to advance the story.
Track potion or scroll consumption as part of rituals, trials or boss preparations.
Use mmoitems_count_fact to validate that a player collected enough special items.
Use mmoitem_variable to branch dialogues based on the item currently held by the player.

💾 Download

🔗 Click to Download

🛒 Shops Extension

Dynamic marketplace system for TypeWriter with real-time economy, stock and smart pricing.

✨ Overview

The Shops Extension allows creation of fully dynamic, interactive marketplaces integrated into TypeWriter. It introduces a living economy with real-time stock tracking, dynamic price variations and multi-currency support.

📈 Dynamic pricing based on supply & demand
📦 Real-time stock persistence & scheduled resets
💰 Multi-currency support (Vault, PlayerPoints, Placeholder)
🧠 Fully customizable GUI & dialogues
🎛 Deep TypeWriter action & trigger integration

📊 Dynamic Economy

Prices rise as stock decreases
Player-driven demand system
Fully configurable price strategies

🖥 Custom GUI

Dynamic buttons & navigation
Dialog-based amount input
Fully themed interfaces

🔄 Reset & Limits

Daily / weekly / interval resets
Per-player purchase limits
Anti-monopoly protection

📈 Dynamic Pricing System

Each shop item uses a PriceStrategy which calculates buy & sell prices based on current stock.

soldRatio = (stockMax - currentStock) / stockMax
steppedRatio = (soldRatio / step) * step
finalPrice = basePrice + (maxPrice - basePrice) * steppedRatio

💸 Price increases as items become rare
📉 Price drops when stock refills
⚙️ Fully configurable limits & rounding

💰 Multi-Currency Support

VAULT – Standard economy plugin integration
PLAYERPOINTS – Point-based economy
PLACEHOLDER – Custom currency via PlaceholderAPI

Custom currencies are managed through commands: addCommand / removeCommand with placeholders.

🧩 Shop Definition

title – GUI name
rows – Slot rows (1-6)
items – Shop item configs
currency – Economy type
strategy – Price rules
resetPolicy – Auto-restock system
limitPerPlayer – Purchase limits

Over 40+ configuration fields available for fine-tuned behavior.

🔄 Transaction Flow

Player selects item
Checks: stock, balance, permissions
Dialog confirmation (custom amount)
Currency deducted / added
Stock updated & saved

🔗 TypeWriter Integration

Open shops via open_shop action
Trigger from NPCs, Regions, Dialogue or Events
Full Placeholder support
Commandless architecture

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

✨ EnchantmentCreator Extension

Design, balance and distribute custom enchantments directly through TypeWriter.

🔮 Overview

The EnchantmentCreator extension provides a complete system for defining custom enchantments inside TypeWriter. Each enchantment is fully configurable: name, lore, icon, applicable items, cost, max level, weight, triggers, conditions and cooldowns.

🎨 Custom enchantment names, colors, lore and icons.
⚙️ Control max level, cost, weight and eligible items.
⚡ activeTriggers, conditions & cooldowns for in-depth behavior.
📚 Distribute enchanted books via TypeWriter actions.
🧱 Restrict or remove vanilla enchantments for full control.

🎨 Custom Enchantment Design

Unique names with color formatting.
Custom lore to explain effects and rarity.
Icon configuration for books and tooltips.

⚔️ Behavior & Balance

Choose which items the enchantment applies to.
Configure max level, cost curves and weight.
Use triggers, conditions and cooldowns to tune power level.

📚 Distribution & Vanilla Control

Give enchanted books as quest rewards or loot.
Style each book (name & lore) per enchantment/level.
Disable vanilla enchantments to enforce your custom system.

🧩 Available Entries

📜 enchantment_definition

enchantment_definition – Defines a new custom enchantment and all its properties.

Name & color – Custom formatted enchantment name.
Lore – Descriptive lines to explain the effect and flavor.
Applicable items – Which tools, weapons, armor or items can receive it.
Cost & max level – Enchantment cost rules and maximum attainable level.
Weight – Controls rarity and roll chances in your system.
activeTriggers – When the enchantment should activate (e.g. on hit, on damage, on move).
Conditions – Extra requirements for activation (player state, target, region, etc.).
Cooldowns – Defines how frequently the effect can trigger.

📚 give_enchantment_book

give_enchantment_book – Gives the player an enchanted book containing a specified custom enchantment.

Select which custom enchantment to embed.
Set a specific enchantment level.
Override book name and book lore for cosmetic or contextual reasons.
Use in loot tables, quest rewards, NPC shops or event chests.

🧱 vanilla_enchantment_restriction

vanilla_enchantment_restriction – Removes or restricts vanilla enchantment(s).

Disable specific vanilla enchantments globally.
Prevent conflicts with your custom enchantment system.
Enforce a curated progression fully built with EnchantmentCreator.

🧪 Usage Ideas

Create legendary enchants tied to boss drops or long questlines.
Build class- or element-based enchant trees (fire, frost, void, etc.).
Replace vanilla enchanting with a fully scripted system controlled by TypeWriter.
Use unique enchanted books as collectible artifacts with lore and story hooks.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

📍 Player Tracking Extension

Advanced session recording and visualization system for TypeWriter.

✨ Overview

This extension introduces a complete player movement tracking system for TypeWriter. It automatically records player positions into distinct sessions and allows admins to replay or visualize these paths both in-game (via particles) and on the web (via BlueMap).

🧭 Automatic session management (Join/Quit)
🧬 High-precision coordinate & timestamp logging
🗺️ Native BlueMap Integration
✨ In-game animated particle inspection
💾 JSON-based Artifact storage

💾 Data Recording

Records X, Y, Z, World, and Time.
Configurable recording interval (default: 20s).
Smart session handling (persists across restarts).

🎨 Visual Inspection

Visualize past movement with /tracking.
Animated "moving dot" particle effects.
Color-coded path segments.

🌍 Web Integration

Draws player paths directly on BlueMap.
Toggle points and path lines via manifest.
Real-time updates during inspection.

🧩 Entries & Artifacts

tracking_manifest – Master configuration (interval, BlueMap settings, particle types).
tracking_artifact – Database artifact storing all player sessions and points.

🖥 Commands

/tracking <player> <session_id>  - Start visualizing a specific session
/tracking                        - Stop current inspection

🧪 Usage Scenarios

Moderation: Review suspicious player movement or verify "I was at X" claims.
Analysis: Understand player flow in cities or dungeons (heatmaps).
Debugging: Trace exact paths taken during testing sessions.

💾 Download

🔗 Click to Download

🧭 Companion Extension

Sidekick NPCs that follow, react, and animate alongside players – fully compatible with ModelEngine.

✨ Overview

The Companion Extension adds smart, scriptable companions to TypeWriter. Each player can have a dedicated sidekick (NPC or ModelEngine entity) that follows them, reacts to interactions, and stays synchronized with their movement and animations.

👤 One companion per player, controlled through a dedicated invocation entry.
🧠 Smart following logic with min/max distance, teleport failsafe and world-change handling.
🎭 Optional ModelEngine integration to keep idle/walk animations in sync with movement.
🖱 Interaction events when the player right/left-clicks their own companion.

🧩 Entries

📡 companion_invocation (Audience filter)

companion_invocation – Spawns or removes a companion for players inside the audience filter.

Summons a companion when a player enters the filter, despawns it when they leave.
Automatically re-summons after teleports or world changes.
Accepts:
- definition – Entity definition tagged as npc_definition or modelengine_definition.
- activity – Activity/behavior to use (movement, idle logic, etc.).
- minDistance, maxDistance – Following distance thresholds.

🔁 companion_follow_mode (Action)

companion_follow_mode – Toggles the companion’s follow mode.

Switches between Follow and Wait.
Updates internal distance logic to either keep following or hold position.
Perfect for “stay here / follow me” style interactions.

🖱 companion_interact (Event)

companion_interact – Fired when a player interacts with their own companion using their main hand.

Triggers configured TypeWriter actions (dialogues, menus, effects, etc.).
Ensures that only the owner’s clicks on their companion invoke the event.

📊 companion_active (Fact)

companion_active – Returns whether the player currently has an active companion.

Returns 1 if the player’s companion is active, 0 otherwise.
Useful for conditions such as “summon only if none active”, or gating dialogues/quests on companion presence.

⚙️ Control & Animation

Companion behavior is driven by a server-side tick loop handled by the extension’s manager.

🚶 Movement:
- Moves toward the target follow position each tick.
- Speeds up when lagging behind the player.
- Attempts to climb simple block steps and applies basic gravity.
🎞 ModelEngine Animation (optional):
- Automatically switches between idle and walk animations based on movement state.
- Can be expanded with custom stances through your ModelEngine configuration.
🌀 Teleport & World Handling:
- Teleports the companion if it is too far from the player or cannot catch up.
- Re-summons or relocates companions after PlayerTeleport and PlayerChangedWorld events.
🚫 Cleanup:
- Companions are properly despawned when the player disconnects.

💡 Usage Ideas

🐾 Pet Quest – A pet companion that follows the player and reacts to quest steps.
🧙 Guide NPC – A guide that starts dialogues or opens menus when clicked, leading players through tutorials or story arcs.
🌟 Cosmetic Companions – Animated ModelEngine companions as VIP perks or event rewards.
🛡 Bodyguard Mode – A guard that follows in dangerous zones, and switches to Wait in safe hubs.

Prerequisites: depends on the Entity, Basic, Quest and RoadNetwork extensions. ModelEngine is optional but fully supported when present.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

🗨️ DialogMenu Extension

Native GUI & Dialog system for TypeWriter powered by PaperMC’s Dialog API.

✨ Overview

The DialogMenu extension allows TypeWriter to leverage the modern Paper Dialog API (introduced in Minecraft 1.21.6) to create rich, interactive in-game windows with zero client modifications.

🖼 Native Minecraft UI dialogs (no resource pack required)
✅ Yes / No confirmation boxes
📋 Multi-choice selection menus
✍ Text input windows with validation
🎯 Ideal for quests, interactions & narrative flows

📦 Dialog Types

Simple message dialogs
Yes / No confirmations
Choice-based menus
Text input prompts

🎮 Player Interaction

Clickable buttons with actions
Multiple response paths
Custom labels & formatting

🔗 TypeWriter Triggering

Invoke from dialogues & nodes
Triggered via events or actions
Full narrative integration

🧩 Available Entry

🗂 paper_dialog

paper_dialog – Opens a configured dialog or menu for the player.

Displays dialog windows using Paper’s native GUI system.
Supports configurable buttons and actions.
Allows multiple layout types: choices, confirmations, text input.
Can be used within quests, story nodes, NPC interactions or automated events.

🧪 Usage Ideas

Ask players to confirm important choices (faction, class, destiny).
Create immersive quest decisions with branching paths.
Use text input to name items, characters or locations.
Display tutorial prompts with guided buttons.
Replace traditional chat commands with visual menus.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

🛡️ Region Protection Extension

Advanced region system for TypeWriter, inspired by WorldGuard and built natively for Paper.

✨ Overview

This extension introduces a complete region protection framework for TypeWriter with full control over flags, members, groups, priorities and global regions. It allows server owners to define precise behavioral rules per zone, replacing traditional WorldGuard usage.

🧭 Hierarchical priority & inheritance system
📜 Fully scriptable via TypeWriter manifests
🌍 Support for global & world-spanning regions
🚫 Dynamic message control & visual inspection UI
🧠 Flag-driven behavior engine

📐 Region Logic

Region shape, parent, priority & ownership
Dynamic flags and inheritance behavior
Global region overlays

🎮 Player Interaction

Entry/exit restrictions
Teleport on region entry
Dynamic bossbar/actionbar overlays

⚙️ Administrative Tools

Live inspection via /tw protection inspect
In-game selection & WorldEdit imports
Priority debugging & visual indicator stack

🧩 Entries & Artifacts

region_definition – Defines a protected region.
protection_region_artifact – Stores region data (flags, shape, priority).
global_protection_region_artifact – Region spanning multiple worlds.
in_protection_region_fact – Returns 1 if the player is inside.
protection_region_group – Links players to the region stack.
protection_settings – Controls UI messages and inspection display.

🔗 PlaceholderAPI Integration

Using the %typewriter_regions: prefix, multiple placeholders allow full access to live region data:

%typewriter_regions:count% – Active region count
%typewriter_regions:list% – Active region IDs
%primary:priority% – Highest region priority
%primary:flags_list% – Effective flags
%typewriter_regions:has:<ids>% – Boolean region presence

🚩 Flag System

Boolean – build, pvp, mob-spawning, item-drop, godmode, entry...
Location-based – teleport, spawn-location...
Numeric – heal-amount, walk-speed...
Commands – console-command-on-entry...
Text – message-on-entry, chat-prefix...

🖥 Administration Commands

/tw protection list
/tw protection select <manifest>
/tw protection import-we
/tw protection apply
/tw protection info <region>
/tw protection inspect

🧪 Usage Scenarios

Protect cities, dungeons, PvP zones or holy sanctuaries.
Define safe zones immune to damage or building.
Create scripted teleport gates and message-driven entry logic.
Use inspection mode to debug region conflicts visually.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

🌐 CommunityExtension

The complete bridge for your Minecraft & Discord community.

👋 Welcome

Stop struggling with complex configurations. this guide will walk you through setting up Account Linking, Bug Reports, and Chat Sync step-by-step.

We have removed the complex technical docs to focus on what you actually need to do.

🚀 1. The Basics (Bot Setup)

Before configuring the extension, you need a Discord Bot.

Go to the Discord Developer Portal.
Click New Application and give it a name (e.g., "ServerBot").
Go to the Bot tab and click Add Bot.
Important: Under "Privileged Gateway Intents", enable Presence Intent, Server Members Intent, and Message Content Intent.
Copy the Token (Reset it if you can't see it). You will need this for the config.
Invite the bot to your server using the OAuth2 tab (Select 'bot' and 'Administrator' for easiest setup).

🔑 2. How to find IDs?

You will often need a Channel ID or Role ID. Here is the trick:

Open Discord User Settings (the cogwheel).
Go to Advanced.
Enable Developer Mode.

Now you can Right Click on any Channel, Role, or User and select Copy ID.

🔗 3. Setting up Account Linking

This module links a Minecraft player to a Discord User.

How it works for players:

Player types /DiscordLink in-game.
They get a code (e.g., 123456).
They send this code in your specific Discord Channel.
Done! They get their roles.

Key Configuration:

Role Mappings: Decide which Minecraft Group gets which Discord Role ID.
Channel: Ensure the bot can see the channel where players send codes.

📝 4. Creating Report Forms

You can create multiple forms (e.g., one for Bugs, one for Suggestions).

Important Change:

We no longer use a fixed /report command. You MUST define a commandName for each form.

Example: Set commandName: "bug" → Players uses /bug.
Categories: These are the clickable options in the menu (e.g., "Glitch", "Typos").

💬 5. Chat Bridges

Want Minecraft chat to appear in Discord?

Copy the Channel ID of your Discord chat channel.
Paste it into the discordChannelIds list in the config.
Tip: You can have multiple bridges (e.g., one for global chat, one for staff chat).

🖥️ 6. Remote Console (Optional)

Execute standard console commands (like /kick, /whitelist) from a private Discord channel.

⚠️ Security Warning:

Create a Private Channel visible ONLY to you.
Copy that Channel ID into the config.
Add your Role ID to the allowedRoles list.
Only these roles in this channel can send commands.

❓ Still stuck?

If you followed the "Finding IDs" section and still have issues, check your server logs for "CommunityExtension" errors.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

📖 Quest Codex Extension

Category-based quest browser for TypeWriter with menus, sorting and full progress tracking.

✨ Overview

The Quest Codex extension adds a category-based quest system to TypeWriter. It lets you organize quests into categories and sub-categories, and provides dedicated GUIs for browsing, sorting and tracking progress.

📂 Group quests into categories and sub-categories.
🧭 In-game inventories to browse, filter and sort quests.
📊 Built-in progress tracking and status-based lores.
🎨 Fully configurable GUIs, sounds and snippets.
🔗 PlaceholderAPI integration for stats and category progress.

📂 Category Structure

Create main categories and sub-categories.
Assign quests to one or more categories.
Use custom icons and titles per category.

🖼 Quest Menus

Open inventories to browse quest lists.
Display quest status, rewards and details.
Customize look & feel via snippets and settings.

📊 Progress & Placeholders

Track total, completed, in progress and not started quests.
Get per-category statistics via PlaceholderAPI.
Show formatted progress in menus, scoreboards and HUDs.

🧩 Entries

📁 quest_category_definition

quest_category_definition – Adds a new quest category.

Configure menu icon for the category.
Set menu title (supports formatting).
Define rows and layout for the category inventory.

📂 quest_category

quest_category – Assigns quests to a category.

Link existing quests into category or sub-category lists.
Drives which quests appear in the codex menus.

📜 quest_additional_lore

quest_additional_lore – Adds extra lore lines for quests in the menu.

Show reward information or hints.
Customize lore per quest status (not started, in progress, completed).

🔒 quest_category_restriction

quest_category_restriction – Adds lore for not-started/locked quests inside a category.

Display locked messages when quests are unavailable.
Perfect for gated content or requirement-based categories.

⚙️ quest_codex_settings

quest_codex_settings – Central configuration for the Quest Codex.

Controls GUIs layout (titles, size, icons).
Defines default lores, sounds and visual behavior.
Mandatory: this entry must be configured or the extension will not function properly.

🔗 PlaceholderAPI Integration

Quest Codex registers multiple placeholders under the %typewriter_...% namespace. Note: category names in placeholders use underscores instead of spaces.

Placeholder	Description
`%typewriter_total_quests%`	Total number of quests.
`%typewriter_total_completed%`	Number of completed quests.
`%typewriter_total_in_progress%`	Number of active quests.
`%typewriter_total_not_started%`	Number of inactive quests.
`%typewriter_total_progress%`	Formatted `completed/total` value.
`%typewriter_category_<name>%`	Quests in the given category.
`%typewriter_category_<name>_completed%`	Completed quests in the category.
`%typewriter_category_<name>_in_progress%`	Active quests in the category.
`%typewriter_category_<name>_not_started%`	Inactive quests in the category.
`%typewriter_category_<name>_progress%`	Formatted progress for the category.

Replace spaces in <name> with _. Sub-categories use the same convention.

🧱 Snippets & Command

Visual behavior of quest menus is controlled by snippets.yml. These snippets define how items, borders and status indicators are rendered.

Default player command:

/tw questcodex (category) (sort)

Optional category and sort parameters let players jump directly to a specific category or apply a predefined sorting mode.

🧪 Usage Ideas

Group quests into Main Story, Side Quests, Daily, Events, etc.
Use additional lore to show rewards, difficulty or recommended level.
Lock entire categories behind story progression or permissions.
Expose overall quest progress on scoreboards, menus or HUDs via placeholders.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

🏹 Archery Minigame Extension

Fully configurable archery arena system for TypeWriter with lobbies, scoreboards and persistent stats.

✨ Overview

The Archery Minigame extension adds a complete, reusable archery game framework to TypeWriter. It lets you define arenas, manage lobbies, control game modes, and track persistent player statistics per definition and mode.

📍 Arena definitions with targets, shooting zones and teleports.
⏱ Two game modes: MAX_TARGET & TIME_ATTACK.
📊 Scoreboards (none / solo / multi) + optional hardcore one-life mode.
🧭 Lobby & countdown handling with inventory management.
💾 Persistent stats stored per arena definition and mode.

🎯 Arena System

Define target positions and spawn points.
Configure shooting zones and safe areas.
Custom messages per arena (join, start, end).

⏱ Game Modes

MAX_TARGET – hit a fixed number of targets as fast as possible.
TIME_ATTACK – hit as many targets as possible within a time limit.
Optional hardcore mode (one life, stricter rules).

🧭 Lobbies & Stats

Lobby join/quit flow with auto-start countdown.
Player limit per arena, inventory save/restore.
Persistent per-definition statistics for leaderboards.

🧩 Entries & Artifacts

The archery minigame is primarily driven by an arena definition entry and its persistent artifacts.

🏹 Arena Definition

archery_game_definition – Defines an archery arena and its behavior.

Targets positions and hit zones.
Teleport locations for lobby, game start and end.
Game mode configuration (MAX_TARGET / TIME_ATTACK).
Scoreboard display mode (none / solo / multi).
Optional hardcore settings (one-life behavior).
Local messages for join/start/finish and failure states.

💾 Persistent Artifacts

Dedicated artifacts store:

Arena configuration (internal serialized data for each definition).
Per-definition and per-mode player statistics (scores / times).
Historical bests used by PlaceholderAPI expansions.

🚪 Join / Quit Actions

The extension also provides actions to:

Add players to a lobby or running match.
Handle leaving mid-game or at the end of a run.
Restore inventories and teleport players back safely.

🔗 TypeWriter Placeholders

These placeholders can be used inside TypeWriter entries (dialogs, HUDs, messages, etc.) to reflect live game state:

Placeholder	Description
`archery_score`	Current score of the player in the ongoing match.
`archery_time_remaining`	Time left in the current match (for TIME_ATTACK or timed modes).

📊 PlaceholderAPI Expansions

The extension exposes leaderboard-related placeholders via PlaceholderAPI:

Placeholder	Description
`%typewriter_archery_top_<definitionId>_<mode>%`	Global top score for the given arena definition and mode.
`%typewriter_archery_player_top_<definitionId>_<mode>%`	The requesting player's best score for that arena definition and mode.

Replace <definitionId> with the internal definition ID and <mode> with the configured game mode (for example: MAX_TARGET or TIME_ATTACK).

🧪 Usage Ideas

Create training ranges where players race to hit a fixed number of targets.
Organize timed tournaments using TIME_ATTACK arenas.
Display top scores in spawn or hub using PlaceholderAPI leaderboards.
Attach join actions to NPCs, signs or regions to make entry seamless.
Use hardcore mode for high-stakes, one-life archery challenges.

Combine the archery minigame with other TypeWriter extensions (regions, dialogs, quests) to integrate it into storylines, events or training sequences.

💾 Download

🔗 Click to Download

🏦 Numerical Storage Extension

Configurable virtual storage & banking systems for TypeWriter with leveling, interest, and interactive menus.

✨ Overview

The Numerical Storage extension provides a fully configurable virtual currency/value storage system with leveling, cron-based interest, and interactive GUI menus powered by TypeWriter and the Dialog API (Minecraft 1.21.7).

💰 Flexible deposit & withdraw with fixed, percentage, or custom amounts.
📈 Interest system with cron scheduling and permission-based rates.
🎯 Leveling with criteria (PLACEHOLDER or FACT mode) and manual/auto upgrades.
🖥️ Fully customizable inventory menus with transaction buttons.
💬 Custom amount input via Dialog API (1.21.7).
🧠 Full PlaceholderAPI integration.
💾 Persistent player data via artifacts.

💰 Transaction System

FIXED, PERCENTAGE, or CUSTOM amount modes.
Configurable success/error messages with placeholders.
Execute commands after successful transactions.
Dialog-based custom amount input (1.21.7).

📈 Interest & Cron

Enable real-time interest with configurable rates.
Cron expressions for precise scheduling.
Permission-based rates (VIP players earn more).
Customizable interest notification messages.

🎯 Leveling System

Define levels with limits, costs, and criteria.
PLACEHOLDER or FACT mode for unlock requirements.
Manual level-up button or automatic progression.
Execute triggers on level up.

🖥️ Interactive Menu

Fully customizable inventory GUI.
Transaction buttons (deposit/withdraw).
Optional display-only info buttons.
Level-up button with available/max templates.

🧩 Entries

📁 numericalstorage_definition

numericalstorage_definition – Defines a Numerical Storage "type".

Configures display name, prefix, interest, levels, menu, and transactions.
Supports cron-based interest with permission-based rates.
Full transaction configuration (messages, commands, placeholders).

💾 numericalstorage_artifact

numericalstorage_artifact – Persistent storage for a numericalstorage_definition.

Saves per-player data (balance, level, last interest time).
Ensures values are preserved across restarts.

📋 Menu Configuration

Each storage definition includes a fully configurable menu:

Title & Rows: Customize inventory title and size.
Fill Items: Background items for empty slots.
Transaction Buttons: DEPOSIT/WITHDRAW with FIXED, PERCENTAGE, or CUSTOM amounts.
Level Button: Available/MaxLevel templates with cost placeholders.
Dialog Config: Custom amount input via Dialog API (title, labels, validation).
Messages: Max level, criteria not met, not enough funds messages.

🔗 PlaceholderAPI Integration

Replace <definitionId> with the ID of your storage definition.

Placeholder	Description
`%typewriter_ns_balance_<definitionId>%`	Player balance for the given definition.
`%typewriter_ns_level_<definitionId>%`	Player level for the given definition.
`%typewriter_ns_limit_<definitionId>%`	Current storage limit based on level.
`%typewriter_ns_name_<definitionId>%`	Display name of the Numerical Storage.
`%typewriter_ns_interest_<definitionId>%`	Interest rate for the player.
`%typewriter_ns_prefix_<definitionId>%`	Prefix for the given definition.

🖥️ Commands

Player and administrative commands:

/numericalstorage <definitionId> open
  - Opens the storage menu for the player.

/numericalstorage <definitionId> add <amount> [target]
  - Add amount to a specific NumericalStorage definition.

/numericalstorage <definitionId> remove <amount> [target]
  - Remove amount from a specific NumericalStorage definition.

/numericalstorage <definitionId> level <amount> [target]
  - Set the level for a specific NumericalStorage definition.

/numericalstorage <definitionId> reset [target]
  - Reset a specific NumericalStorage definition for a player.

🧪 Usage Ideas

Create a bank system where level determines storage capacity and interest rates.
Design custom currencies (honor, reputation, tokens) with interactive menus.
Use Dialog API for custom amount deposits/withdrawals.
Combine FACT-based criteria with quests for unlock requirements.
Drive GUI elements (progress bars, balances) using placeholders.
Create VIP banking with permission-based interest rates.

💾 Download

🔗 Click to Download

🧩 Vanilla Events & Objectives Extension

Adds a large collection of triggers and objectives for vanilla interactions in TypeWriter (stonecutter, smelting, trading, lectern, jukebox, anvils, recipes, and more).

✨ Overview

This extension brings a comprehensive set of event entries and matching objectives for many core Minecraft actions. You can react to player interactions (crafting, trading, enchanting, smelting, etc.) and track them as progress objectives inside TypeWriter quests and systems.

⚙️ Event entries for detecting vanilla actions.
🎯 Objective entries for tracking counts/progress of those actions.
🧪 Ideal for achievements, tutorials, minigames and progression systems.
🧱 Structured by domain: crafting, combat, trading, machines, lecterns, jukeboxes, etc.

All entries below follow the same pattern: EventEntry = trigger you can listen to, ObjectiveEntry = progression objective you can use in quests or systems.

📜 Advancement & Recipe System

Track vanilla advancement completion and recipe unlocks for progression or achievements.

AdvancementGrantEventEntry – Trigger when a player completes an advancement.
AdvancementGrantObjectiveEntry – Objective for “complete specific advancement(s)”.
RecipeUnlockEventEntry – Trigger when a recipe is unlocked.
RecipeRevokeEventEntry – Trigger when a recipe is revoked.
RecipeObjectiveEntry – Objective for recipe-related tasks (unlocking, owning, etc.).

🛠 Anvil & Enchanting

React to repairs, combinations, grindstone usage and enchanting table interactions.

AnvilRepairEventEntry / AnvilRepairObjectiveEntry – Track item repairs or combinations in anvils.
GrindstoneRepairEventEntry / GrindstoneRepairObjectiveEntry – Track grindstone repairs and enchantment removal.
EnchantEventEntry / EnchantObjectiveEntry – Track enchanting table usage and related objectives.

⚙️ Block & Machine Operations

Hooks for barrels, beacons, brewing stands, campfires, cartography tables and cauldrons.

BarrelOpenEventEntry / BarrelCloseEventEntry – Track barrel opening and closing.
BarrelObjectiveEntry – Objective for barrel-related tasks.
BeaconPowerEventEntry / BeaconPowerObjectiveEntry – Track beacon activation or power changes.
BrewingStandBrewEventEntry / BrewingStandBrewObjectiveEntry – Track potion brewing operations.
CampfireCookEventEntry / CampfireCookObjectiveEntry – Track cooking food on campfires.
CampfireExtinguishEventEntry – Trigger when campfires are extinguished.
CartographyMapCopyEventEntry – Track map copying or scaling in cartography tables.
CauldronFillEventEntry / CauldronEmptyEventEntry – Track cauldron water level changes.
CauldronObjectiveEntry – Objective for cauldron-based interactions.

🧵 Crafting & Processing

Track banner patterns, smithing, stonecutting and smelting tasks.

LoomBannerPatternApplyEventEntry / LoomBannerPatternApplyObjectiveEntry – Track banner pattern application on looms.
SmithingTableUpgradeEventEntry / SmithingTableUpgradeObjectiveEntry – Track smithing table upgrades.
StonecutterCutEventEntry / StonecutterCutObjectiveEntry – Track stonecutter usage and cuts.
SmeltEventEntry / SmeltObjectiveEntry – Track furnace/smelting operations.

📚 Lectern & 🎵 Jukebox

Perfect for story-heavy servers, libraries, music halls and lore systems.

LecternPlaceBookEventEntry – Track when a book is placed on a lectern.
LecternTakeBookEventEntry – Track when a book is removed from a lectern.
LecternPageTurnEventEntry – Track page turns on lecterns.
LecternObjectiveEntry – Objective for lectern reading/interaction tasks.
JukeboxPlayEventEntry / JukeboxPlayObjectiveEntry – Track playing music discs.
JukeboxStopEventEntry / JukeboxStopObjectiveEntry – Track stopping jukebox playback.

🧍 Player & Entity Interactions

Trigger on XP pickup, cake consumption, item frames, blocking and more.

ExperienceOrbPickupEventEntry / ExperienceOrbPickupObjectiveEntry – Track experience orb collection.
CakeSliceEventEntry / CakeSliceObjectiveEntry – Track cake slice consumption.
CrossbowReloadEventEntry / CrossbowReloadObjectiveEntry – Track crossbow reloading.
ShieldBlockEventEntry / ShieldBlockObjectiveEntry – Track shield blocking actions.
ItemFramePlaceEventEntry / ItemFrameRemoveEventEntry – Track item frame placement and removal.
ItemFrameRotateEventEntry – Track rotation changes on item frames.
ItemFrameObjectiveEntry – Objective for item frame-related interactions.
TotemUsedObjectiveEntry – Objective to track totem of undying usage.

⚔️ Combat & Weapons

Focused on trident usage and related challenges.

TridentThrowEventEntry / TridentThrowObjectiveEntry – Track trident throws.
TridentRecallEventEntry / TridentRecallObjectiveEntry – Track trident recall events.

💱 Trading & Bartering

Useful for economy and progression systems centered around villagers and piglins.

VillagerTradeEventEntry / VillagerTradeObjectiveEntry – Track villager trading operations.
PiglinBarterEventEntry / PiglinBarterObjectiveEntry – Track piglin bartering events.

⭐ Special Features

Extra utility entries for generic tracking logic.

FactCheckEventEntry / FactCheckObjectiveEntry – Generic “fact” related trigger/objective pair, useful as a flexible hook for custom conditions or checks inside your systems.

💾 Download

🔗 Click to Download

🧳 PocketMenu Extension

Open vanilla utility GUIs anywhere, anytime in TypeWriter – no block interaction required.

✨ Overview

The PocketMenu extension allows players to open various vanilla Minecraft GUIs directly via command, without needing to interact with a physical block. It is ideal for RPG servers, lobbies or quest hubs where convenience and flow are more important than block placement.

📦 Open workbench, anvil, enchanting and more from anywhere.
🧭 Great for menus, NPC interactions, or quest rewards.
⚙️ Simple command usage, easy to integrate with TypeWriter dialogs and actions.

🖥️ Command

Main command provided by the extension:

/tw pocketmenu <TYPE>

Replace <TYPE> with one of the supported GUI types listed below. This can also be wired into dialogs, buttons, regions or other TypeWriter actions for a seamless experience.

🧰 Supported GUI Types

The following TYPE values are available:

TYPE	Opens	Usage Example
`WORKBENCH`	Crafting table GUI	`/tw pocketmenu WORKBENCH`
`ENCHANTING`	Enchanting table GUI	`/tw pocketmenu ENCHANTING`
`ANVIL`	Anvil repair/rename GUI	`/tw pocketmenu ANVIL`
`SMITHING`	Smithing table GUI	`/tw pocketmenu SMITHING`
`GRINDSTONE`	Grindstone GUI	`/tw pocketmenu GRINDSTONE`
`STONECUTTER`	Stonecutter GUI	`/tw pocketmenu STONECUTTER`
`CARTOGRAPHY`	Cartography table GUI	`/tw pocketmenu CARTOGRAPHY`
`LOOM`	Loom GUI	`/tw pocketmenu LOOM`
`BREWING`	Brewing stand GUI	`/tw pocketmenu BREWING`

🧪 Usage Ideas

Attach /tw pocketmenu calls to NPC dialogues for service-style characters (blacksmith, enchanter, cartographer, etc.).
Use in spawn or lobbies where you do not want functional blocks placed.
Combine with permissions to offer pocket utilities as donor or rank perks.
Integrate into quest steps where players must use a specific GUI without hunting for a block.

💾 Download

🔗 Click to Download

🗳️ Vote System Extension

Create configurable votes and polls in TypeWriter, with persistence, placeholders and action-driven outcomes.

✨ Overview

The Vote System extension adds a fully configurable poll & voting system to TypeWriter. You can define polls with an optional end date/time, connect them to dialogue options, store results in artifacts, and execute custom actions based on the votes obtained.

🗳️ Multiple polls with options, labels and display names.
⏰ Optional end date/time per poll (ISO-8601).
🎭 Integration with TypeWriter dialogues via vote_action.
💾 Persistent storage of votes using artifacts.
📊 PlaceholderAPI support for displaying options, stats and player choices.

📋 Poll Management

Define polls with multiple options.
Attach a human-readable display name.
Set an optional endDate (closing time).

🎮 Player Experience

Vote via dedicated actions or commands.
Show live results in GUIs, dialogs or chat.
Send feedback messages when a vote is cast.

⚙️ System Integration

Artifacts for persistent poll data.
Placeholders for options, stats and player choice.
Perfect for events, governance and content feedback.

🧩 Entries

📁 vote_definition

vote_definition – Defines a vote/poll.

Entry id is used as the pollId for placeholders and commands.
Contains display name, options and configuration.
Can include an endDate field (ISO-8601 format) to automatically close the poll:
2024-05-01T12:00:00Z

💾 vote_data

vote_data – Artifact to store data of a vote/poll.

Persists votes across restarts.
Stores per-option vote counts and per-player choices.
Backs all statistics used by placeholders and commands.

✅ vote_action

vote_action – Registers a vote for a specific option in a specific poll.

Designed to be used from dialogue options or other TypeWriter actions.
Links a player’s choice to a given pollId and option index.
Can be combined with conditions and follow-up actions based on results.

✉️ vote_message

vote_message – Sends a message when a player votes.

Feedback confirmation for the voting player.
Can be used to notify staff or broadcast a vote event.

🔗 PlaceholderAPI Integration

Replace <pollId> with the id of your vote_definition entry. These placeholders let you render poll information anywhere (menus, scoreboards, chat, web UIs, etc.).

Placeholder	Description
`%typewriter_vote_display_<pollId>%`	Display name of the poll.
`%typewriter_vote_option_<pollId>_<index>%`	Text of the option at `index` for the poll.
`%typewriter_vote_stats_<pollId>_<index>%`	Number of votes for the option at `index`.
`%typewriter_vote_stats_<pollId>%`	Comma-separated statistics for all options in the poll.
`%typewriter_vote_player_<pollId>%`	Option chosen by the requesting player.
`%typewriter_vote_votes_<pollId>_<index>%`	Legacy alias for `vote_stats` with an index.
`%typewriter_vote_total_<pollId>%`	Total number of votes cast in the poll.

🖥️ Commands

The extension exposes a simple /vote command suite for managing and inspecting polls:

/vote reset <pollId>
  – Clears all votes for the given poll.

/vote stats <pollId>
  – Prints vote counts for the given poll.

/vote <pollId> <option> [target]
  – Registers or prints a vote for the given poll (depending on configuration/usage).

/vote stats
  – Prints vote counts for all polls.

Tip: Combine admin commands with placeholders to quickly debug or calibrate new polls during events.

🧪 Defining Polls

Polls are configured via vote_definition entries. The poll ID is the entry’s id field, and the endDate field uses ISO-8601 format for closing time, for example:

endDate: "2024-05-01T12:00:00Z"

Once the endDate is reached, the poll can be considered closed for further voting and used strictly for result-based actions (rewards, decisions, announcements, etc.).

💾 Download

🔗 Click to Download

🔀 Dual Text Display Extension

Add a second text display and dynamically shift focus between two points in your TypeWriter scenes.

✨ Overview

The Dual Text Display extension extends the standard text display system by introducing a secondary display that can be shown and targeted alongside your main dialogue display. This is ideal when you want to:

📍 Highlight a second point of interest (e.g. an object, NPC, or location) while text is shown.
🎬 Create more cinematic scenes by splitting focus between two text displays.
🧭 Guide the player's attention by forcing them to look toward the secondary display.

🧾 Dual Display Logic

Use a definition to describe how the two displays work together.
Instantiate dual displays per scene or per player when needed.
Mix with existing TypeWriter dialogues and cinematics.

🎥 Focus Control

Force the player to look at the secondary display during key moments.
Direct attention to an alternate angle, object, or character.
Combine with cinematics and movement for dynamic storytelling.

🧩 Entries

📐 dual_text_display_definition

dual_text_display_definition – Defines the configuration of a dual text display.

Describes how the primary and secondary text displays are related.
Can include positions, offsets or references used by your scenes.
Acts as a reusable template for multiple instances.

📦 dual_text_display_instance

dual_text_display_instance – Creates a dual display instance from a definition.

Represents a concrete dual display currently active in the world.
Typically tied to a player, scene, or scripted moment.
Used alongside your usual text display/dialogue flows.

🎯 look_at_secondary_text_display_bound

look_at_secondary_text_display_bound – Forces the player to look at the secondary text display.

Bind this interaction to guide the camera toward the secondary display.
Perfect to emphasize an object, NPC or direction mentioned in the text.
Can be triggered during dialogues, cinematics or scripted events.

🧪 Usage Ideas

Display dialogue above an NPC while a secondary display highlights a key object or door.
Use the secondary display to show side notes, hints or warnings during a main conversation.
Chain dual displays in a cinematic to alternate focus between two points of interest.
Combine with camera paths and look-at bindings for a more cinematic cutscene experience.

🎥 Demo

A short preview in action:

🔗 Watch the demo on YouTube

💾 Download

🔗 Click to Download

✨ AdvancedEnchantments Integration

Connect AdvancedEnchantments to TypeWriter with dedicated triggers and objectives for enchantment-based gameplay.

🔮 Overview

This extension allows TypeWriter to react to events produced by the AdvancedEnchantments plugin. It provides specific entries to detect when players enchant items using custom enchantments and lets you integrate this directly into quests, conditions or scripts.

⚡ Detect when a player applies an AdvancedEnchantment.
🎯 Track enchantment usage in objectives.
📜 Build quests or progression systems around enchanted items.

🧩 Available Entries

🎯 advancedenchants_objective

Objective triggered when a player enchants an item using AdvancedEnchantments. Useful for tracking quest progression, achievements or unlock systems based on enchantment actions.

⚡ advancedenchants_trigger

Trigger executed when a player enchants an item with an AdvancedEnchantment. Designed to activate scripts, dialogue flows or custom logic in response to enchantment events.

💡 Example Use Cases

Require players to enchant a weapon before completing a quest.
Unlock new dialogue options after enchanting with a specific tier.
Create achievement systems triggered by AdvancedEnchantments usage.
Trigger cinematic or UI feedback when a rare enchant is applied.

💾 Download

🔗 Click to Download