Typewriter Documentation

Typewriter is a Minecraft plugin designed for creating interactive server experiences via a visual web panel. It allows for content creation without coding through several core capabilities:

• Interactive Dialogues & Quests: Branching storylines and dynamic quests based on player choices.
• Cinematic Sequences: Animated NPC interactions, camera paths, and cutscenes.
• Intelligent NPCs & Entities: Custom activities, appearance changes, and player-specific entities.
• Custom Commands: Triggering custom content via server commands.
• Visual Configuration: A dedicated web panel for managing all content.
• Extensions System: Modular components to integrate with custom plugins.

The Superior Skyblock Adapter enables integration between the Superior Skyblock plugin and Typewriter. It provides a suite of events, actions, facts, and groups that can be used within Typewriter dialogues to react to player island activity or trigger island-related changes.

:::caution[Untested] This adapter is untested. It may not work as expected. Please report any issues you find. :::

Typewriter is a plugin designed for Paper Minecraft servers. It provides tools to create immersive gameplay experiences including:

• Custom Player Interactions: Quests, NPC dialogues, and branching storylines.
• Cinematic Sequences: Dynamic camera paths, animated NPC interactions, and cutscenes.
• Intelligent NPCs: Customizable NPC behaviors such as walking, appearance changes, and environmental interaction.
• Visual Configuration: A web panel for managing quests, NPCs, and interactions without coding.
• Extensions: A modular system to integrate custom plugins and unique in-game content.

The MythicMobs Adapter is an extension for Typewriter that enables handling MythicMobs plugin entities and logic within Typewriter workflows. It provides specialized entries for Actions, Cinematics, Events, and Facts related to MythicMobs.

:::caution[Untested] This adapter is currently untested and may not behave as expected. Users should report any discovered issues. :::

The Entity Adapter provides the essential entries required to work with entities in Typewriter. It is primarily used to create dynamic entities such as NPCs (Non-Player Characters) or Holograms.

In most use cases, the Entity Adapter should be installed alongside Typewriter. If you have not yet installed Typewriter or the adapter, refer to the Installation Guide before proceeding.

A SingleFilter is a specialized variant of AudienceFilter designed to ensure that only one filter instance is active for a player at any given time.

Use SingleFilter when you need to manage exclusive UI elements that cannot overlap, such as:

• Tab list headers or footers
• Scoreboard sidebars
• Any other single-slot display area where multiple entries would cause visual conflicts.

The Entity Extension allows you to spawn, manage, and control entities (such as NPCs) on your server. Key capabilities include:

• Defining an entity: Creating a reusable entity definition with custom data that can be used across multiple servers.
• Conditional showing of entities: Controlling NPC visibility based on player progress (e.g., appearing only at a specific quest stage).
• Activities: Assigning custom behaviors to entities, such as patrolling a city or walking to a specific location at a certain time.

An interaction context is a mechanism that allows you to pass variables to subsequent entries in a sequence. This enables you to capture user input (such as text or numbers), store it, and use it later in the story to drive dynamic interactions.

Common use cases include:

• Using captured input in future dialogue steps.
• Triggering specific actions based on input (e.g., spawning effects on a specific block).
• Setting dynamic quantities for items or events.