DOCSEARCHbyAlgolia
Submit Docs

TypewriterMC Documentation

website·Indexed 31 days ago

https://docs.typewritermc.com

Developer documentation for TypewriterMC, covering the creation of stories and extensions. Includes detailed guides on implementing various entry types such as DialogueEntry, AssetEntry, SoundIdEntry, SoundSourceEntry, SpeakerEntry, and VariableEntry across versions 0.4.2, 0.5.1, 0.6.1, 0.7.0, and Beta.

Tokens
348.9K
Snippets
723
Records
3.7K
Agent score
56%

What's inside TypewriterMC

  1. Overview of the Entity Adapter

    The Entity Adapter is a Typewriter feature used to spawn, manage, and control entities (such as NPCs) on a server. Key capabilities include:

    • Defining Entities: Creating entities with custom data that can be reused across multiple servers.
    • Conditional Visibility: Making NPCs appear only when a player reaches a specific quest stage.
    • Activities: Assigning custom actions to entities, such as patrolling a city or walking to a specific location at night.

  2. Overview of Typewriter development components

    Typewriter is composed of three primary areas for development:

    • Extensions: Self-contained building blocks designed for easy sharing and integration into the system.
    • Plugins: Core functional components of Typewriter. Due to the high impact of changes on the user base, contributions to plugins should be discussed with the maintainers first.
    • UI: The user interface layer, developed using the Flutter framework.

  3. Overview of MythicMobs Adapter for Typewriter

    The MythicMobs Adapter (version 0.7.0) allows Typewriter to interact with the MythicMobs plugin. It provides a set of actions, cinematics, events, and facts to manage mob-related logic. Note: As of version 0.7.0, this adapter is marked as untested and may not work as expected.

  4. Overview of the RPGRegions Adapter

    The RPGRegions Adapter (version 0.7.0) allows developers to integrate the RPGRegions plugin's discovery system directly into their dialogue. Note: As of version 0.7.0, this adapter is marked as untested and may contain bugs.

  5. Overview of Vault Adapter for economy and permissions

    The Vault Adapter is a beta adapter for the Vault plugin that enables the use of Vault's economy system within dialogues. It provides a set of actions, facts, and groups to manage and query player balances and permissions.

  6. Overview of Superior Skyblock Adapter entries

    The Superior Skyblock Adapter (version 0.8.0) allows the Superior Skyblock plugin to be used with Typewriter. It provides a suite of actions for modifying island states, events for triggering dialogue based on island activity, facts for retrieving island data, and island-wide groups. Note: This adapter is currently marked as untested.

  8. Overview of CitizensAdapter for Typewriter

    The CitizensAdapter allows for the creation of custom interactions with NPCs within Typewriter. Note: As of version 0.7.0, this adapter is marked as unsupported; it will only receive bugfixes and may be removed from the repository at any time.

  10. Overview of the MythicMobs Adapter for Typewriter

    The MythicMobs Adapter allows developers to handle MythicMobs plugin entities and behaviors within Typewriter. Note: As of version 0.4.2, this adapter is marked as untested and may not work as expected.

  11. Overview of Typewriter Adapters

    Adapters are optional additions for Typewriter that provide extra functionality and entries, primarily by allowing Typewriter to interface with other plugins. While not required for basic use, the Basic Adapter is recommended for most servers as it contains essential building blocks.