Typewriter

Interactions like dialogue or cinematics have gained many new capabilities.

Interaction Bounds

Interaction bounds confine interactions to an action or space, such as canceling dialogue when the player walks away.
Interaction bounds can be in 2 modes: Interrupting and Blocking.
Interruption Mode means that if the player breaks the bounding condition, the interaction will be canceled.
Blocking Mode means the player is not allowed to violate the bounding condition, ensuring players see the dialogue through.

The mode is determined by the priority of the interaction versus the priority of the bound. If the interaction has a higher priority, it is in Blocking Mode; if it is the same or lower priority, it is in Interruption Mode.
Entries inherit their priority from the page.

Some examples of Interaction Bounds are:

• PlayerRadiusInteractionBound: Player stays within a certain radius from when the bound started.
• LookAtNpcInteractionBound: Similar to PlayerRadiusInteractionBound but forces the player to look at the entity.
• LockInteractionBound: Completely locks the player's camera from moving and rotating.
• CommandInteractionBound: Triggered when the player runs a command other than the /tw command.

Interaction Context

The second new concept is Interaction Context. This allows you to pass variables to subsequent entries in a sequence, allowing for more flexible interactions, such as asking the user for input and using that later, or spawning something on the block the player clicked on.

Custom Commands

Though you could already have Typewriter create a custom command, you can now have arguments for this command and use the input of the arguments in subsequent entries.

InputDialogue

NPCs can now ask more open-ended questions, like how many cookies 🍪 you want to have baked, or asking for a certain phrase like a password.

Other Features

This is not the only thing we added. Some noteworthy new features:

• Speed Data: You can now specify how fast/slow an NPC should walk.
• Replace With … Button: Now in the web panel, you can replace an existing entry with a different one. This is particularly useful!
• Improved Navigation for long cinematic content modes
• Allow glowing effect data to have colors
• And 70+ more new features!

To see all the changes, look at the full changelogs

Developer Changes

This new version comes with many breaking changes for developers! A full migration guide is provided to help you migrate your extensions to the new version.

If you find Typewriter valuable for your server, please consider Sponsoring the Project

What are Dynamic Variables

Before, all fields on an entry needed to be filled in with valid values during configuration time. With Dynamic variables, fields can now be substituted with runtime values.

To give you some inspiration of what you can now do:

• Have cinematics in the world the player is in, instead of in a fixed world. Which is useful for playing cinematics in generated dungeons.
• Have the skin of a NPC be determined from a placeholder. For making leaderboard NPCs.
• Having the strength of a potion effect be the value of a fact. For "upgradable skills."
• Making launch pads shoot the player in the direction where they are looking.

Placeholder Parameters

Sometimes you want to know different details of an entry. Like the time it last got updated. The remaining time until the fact resets. Entries now support parameterized placeholders for more detailed information:

%typewriter_<entry id>:remaining:10%     // Items left to collect
%typewriter_<entry id>:time:expires:relative%     // Time until daily quest is active

New Entries

• Entity types: ArmorStand, EnderDragon, Parrot, Wolf, BlockDisplay
• CalculatedFact for complex expressions
• WeightedRandomTriggerGate for probability-based triggers
• World and potion effect audience filters

Breaking Changes

• Extension developers: PlaceholderEntry API updated
• Random...DialogueEntry deprecated (use RandomVariable instead)

If you find Typewriter valuable for your server, please consider Sponsoring the Project

There are also some critical bug fixes:

• The option dialogue now makes sure it always displays all options, instead of only the first
• Fixed an issue with actions not being able to trigger any following entries
• Staging folder, not saving except for when shutting down the server. (Broken since beta-133)
• Recalculating the road network creates 1 snapshot per world instead of 1 per node.

Typewriter v0.6 – The Extensions Update

This release brings a foundational shift in Typewriter’s core structure and a major update to the item system, along with new features and important usability improvements. Below are the highlights:

Critical Changes

1. From Adapters to Extensions
   Typewriter has transitioned from using Adapters to Extensions, marking a significant evolution in how custom functionality is integrated. Key improvements with this change include:

   • Gradle Plugin for Extensions: A new Gradle plugin simplifies the process of developing Extensions, making setup and management easier for developers.
   • Compile-Time Discovery: Discovery of Extension internals, such as entries, now occurs at compile-time instead of runtime. This not only future-proofs Typewriter but also lays the groundwork for the upcoming marketplace, where entries in each Extension will be viewable without running the Extension.
   • Hot Reloading: Extensions can now be reloaded on-the-fly using /tw reload, enabling real-time updates without the need for a server restart.
   • Optimized Loading: Only the necessary classes are loaded from Extensions. For example, if an Extension contains thousands of entries but only one is used, Typewriter loads only that specific entry, enhancing memory and processing efficiency.
   • Extension Validators: Built-in validators now check Extensions against Typewriter’s standards, helping to ensure reliability and consistency across user-created Extensions.

2. New Item System
   Typewriter introduces a completely new item system, which is incompatible with previously defined items. Users will need to recreate items to align with the new structure. Based on user feedback, no migrator will be provided, as the majority found it unnecessary. Please test this update on a development server before upgrading your production environment.

Important Features

1. Skip Cinematic Segments
   A new SkipCinematicEntry gives players the option to skip sections of cinematics by pressing a configured key, offering more control over in-game cinematic experiences.

2. UI and Web Panel Upgrades
   Improvements to the web panel and UI components provide a smoother experience. These upgrades include the ability to unselect Sound IDs, layout enhancements, compatibility improvements behind reverse proxies, and visual indicators for empty fields, all of which contribute to a more intuitive and flexible panel.

New Entries

• Cinematic Entries: GameTimeCinematicEntry, WeatherCinematicEntry, SkipCinematicEntry, BlockCommandCinematicEntry
• Dialogue: ActionbarDialogueEntry, SimpleMessageActionEntry
• Entity and Activity Entries: MythicMobKillPlayerEventEntry, RemovePotionEffectActionEntry, LookAtBlockActivity, LookAtPitchYawActivity, RandomPatrolActivity, AmbientSoundActivity, ScaleData, InteractionEntity, PillagerEntity, VindicatorEntity, Llama Entity
• Miscellaneous: WeatherAudienceEntry, FireworkActionEntry (with flight duration setting)

As always, please make sure you have a backup before updating and enjoy the new features!

If you consider Typewriter to be valuable to your server, please consider Sponsoring the Project

A very quick bug fix where NPC's in cinematics were not showing.

Manifesting Stories Update

Since this update is so big, it is almost impossible to list every change. Therefore, only the biggest changes are listed.

With 729 commits, 1,438 changed files, with 60,258 additions and 33,483 deletions, this is by far the biggest update in the history of Typewriter.

Manifest Entries

Manifest entries are entries that automatically do stuff based on the environment. Think of showing NPCs based on filters (such as quest status) and having NPC holograms. Boss bars, Creating scoreboards, Interaction zones, and much more!

For the programmers under us, where sequence entries are like imperative programming. Manifest entries are declarative programming. They can be linked in an acyclic-directional graph.

Audience Entries

The first subclass of Manifest Entries are Audience Entries. They display anything to the player, Such as a boss bar. There is a special variety of audience entries, which are AudienceFilterEntries. They filter out players, such as regions, if they are in a certain part of a quest, if they are in a cinematic... These types of filters can be chained to have extreme customizability and flexibility.

Entity Adapter

Say goodbye to the old NPC adapters like Citizens, FancyNpcs, and ZNPCs. The Entity Adapter allows you to define entities directly within Typewriter, empowering you to use them in cinematics, control their visibility based on conditions (like during a quest segment), and even have them navigate and exhibit complex behaviors. With full control, the sky is the limit!

Road Network

You can now create Road Networks in Typewriter. These allow NPCs to navigate through the world and show Path Streams to guide the players.

Grouped Facts

The value of a fact can now be set for a group of players. For example, you can now check if a party of players have killed a certain number of enemies.

Documentation Improvements

Some of you may have already looked at the new documentation. We've made major improvements to the documentation. All to make it easier to use and understand Typewriter.

Switched from ProtocolLib to PacketEvents

This switch has allowed many new features in Typewriter, like the new buttery smooth camera cinematics. It means that now you need to install PacketEvents in order for Typewriter to work.

Made some breaking API changes

There are various breaking API changes for Adapters. To view the migration, take a look at the Migration Guide

Deprecation Warning

With this release, we're marking the old NPC adapters, such as ZNPCs and FancyNpcs, as deprecated. This means that while they will still function in the current version, this will be the last release where they are supported. Going forward, we'll only be providing bug fixes for the Citizens NPC adapter. It will remain updated primarily to assist new users in getting started, but we strongly encourage everyone to transition to the Entity Adapter for the best Typewriter experience.

What's Changed

• Update index.mdx by @Kerzinator24 in https://github.com/gabber235/TypeWriter/pull/145
• Fix bug with modrinth update checker with dependencies
• Fix bug with PlayerNearLocationEventEntry checking for different worlds

New Contributors

• @Kerzinator24 made their first contribution in https://github.com/gabber235/TypeWriter/pull/145

Full Changelog: https://github.com/gabber235/TypeWriter/compare/v0.4.1...v0.4.2

Changelog

This update includes a range of enhancements, from critical bug fixes to exciting new features.

Highlighted Features

• Added Skills and Mobs to the MythicMob adapter
  A significant enhancement, expanding the capabilities of the MythicMob adapter by integrating both Skills and Mobs.

• Added FancyNpcs and ZNPCsPlus adapters
  Introduces new npc adapters. As not everybody uses Citizens, more diversity is nice to have.

• Added a new /typewriter trigger <entryId> [optional player] command
  Introduces a new command to directly call any triggerable entry. This will allow for much more integration options with different plugins

• Added a discord bot to synchronize & organize tickets
  A crucial addition for community management, improving the synchronization and organization of user tickets through a Discord bot.

• Added an option to change the confirmation key in dialogue
  Not every server want to use the F key to forward the dialogue. Now you can choose from Item Swap, Jump and Sneak to forward the dialogue.

• Improve single frame editing in cinematic view Add a selector for segments for a selected entry. And allow to set the specific frame of a single frame segment.

New Features

• Added many more descriptive errors.
• Added ctrl+shift+p for publishing shortcut in panel.
• Added pumpkin head for cinematics.
• Added additional filters to the interact event.
• Added cinematic start event.
• Added support for non-singleton object adapter class.
• Added outdated version detector.
• Added SetBlockActionEntry.

Bug Fixes

• Fixed index out of bounds for updating values on the panel.
• Fixed blindness bug when logging out during a cinematic.
• Fixed offline issues on cinematic close.
• Fixed Jitpack artifacts.
• Fixed block interaction with location.
• Fixed custom item with complicated names checking for the Item Entries.
• Fixed a bug with citizens NPC not working if they had no skin.
• Fixed arm swing packet.
• Fixed bug with duplicated pages after renaming.

Improvements & Tweaks

• Update adapter docs (oops forgot to do this in v0.4.0).
• Made asset deletion more robust.

Quality of life update

Major Changes

• Item Inspector: Now items are more flexible and easier to use in the ui. It also add the ability for NBT data.
• Revamp CI/CD: Allow quick dev-builds to release early and allow users to test the plugin.
• Chapters: Finally there is a way to order pages.
• Custom Sounds: Allow users to have custom sounds.
• Muli-Command: Allow multiple commands to be specified in a single entry.
• Drag & Drop for pages & entries: Allow you to drag and drop entries onto each other for quick linking.

ChangeLog

New Features

• Auto create adapter folder
• Allow multiple commands to be registered in a single command entry
• Add BStats
• Rework toast UI
• Add a particle for camera during recording
• Add drag & drop for pages
• Add drag & drop for entries
• Add page search and quick actions in global search
• Add a particle for camera during recording

Improvements

• Rework migration system to allow entries to have their own migrations defined
• Allow speaker name placeholders
• Always show search suggestions, even with no search
• Display errors from socket
• Allow adding/selecting entries not from current page
• Add error screen when timeout on panel

Bug Fixes

• Fix adapters not loading without Geyser
• Fix Page & File name getting out of sync
• Fix npc interactions only registering for right or left click.
• Fix options with criteria ordering
• Fix skipping option when no options are available
• Fix potion effects for 1.20.4
• Fix flutter text size calculation
• Fix final dialogue able to trigger next multiple times if users spam.

Documentation

• Add Troubleshooting documentation (Thanks @Gc-network)
• Add Adapter development documentation
• Update Facts documentation page with content and examples (Thanks @vignan37 & @Gc-network)

What's Changed

• Update docs about server providers not supporting the web panel by @MrDiamondDog in https://github.com/gabber235/TypeWriter/pull/62
• Update paper version by @MrDiamondDog in https://github.com/gabber235/TypeWriter/pull/63
• V0.3.1 Simple Bugfixes by @gabber235 in https://github.com/gabber235/TypeWriter/pull/65

Full Changelog: https://github.com/gabber235/TypeWriter/compare/v0.3.0...v0.3.1

Introducing Typewriter v0.3: The Cinematics Update!

Get ready to bring your Minecraft server to life with the most exciting update since Typewriter's release. We've been hard at work, and this update is packed with game-changing features, led by the introduction of Cinematics 🎬.

Cinematics are the ultimate tool for creating immersive experiences in your Minecraft world. With precisely timed sequences of actions, you can now craft stunning cutscenes for quests, engaging tutorials, fast travel systems, thrilling random encounters, and so much more. The possibilities are endless ✨!

But that's not all. Cinematics in Typewriter go above and beyond. You can create dynamic camera paths to capture the perfect angles 🎥, weave in captivating dialogues for your characters 🎭, and even record your own NPC 💃 to take center stage in your cinematic masterpiece.

With over 28,131 lines changed and 10,988 lines removed, this is the biggest update to Typewriter yet. We've fine-tuned every aspect to ensure a seamless and powerful cinematic experience that will leave your players in awe.

So, gather your creative spirit, update your Typewriter plugin, and get ready to embark on a new era of storytelling in Minecraft. We can't wait to see the incredible cinematic adventures you'll create with Typewriter v0.3. Enjoy the journey 🌟🎮!

We've fixed a pesky bug that prevented spoken dialogue from being longer than the minimum length. Plus, we've added a search function to our documentation site to make it easier for you to find what you need.

Ladies and gentlemen, it's time to upgrade your Typewriter plugin because v0.2.0 of the Typewriter plugin is out! And let me tell you, this update is a doozy. We've added so many new features!

First up, we've got Computed Facts. That's right, facts can now change based on the environment! It's like becoming more knowledgeable by just downloading the new version. We've given you the power to know facts from all sorts of places of your minecraft server. Have a look at one of the new facts like NumberPlaceholderFact to see how you can start becoming more knowledgeable 🧠.

But wait, there's more! We've also added Snippets, one of the most requested features. Now you can customize how every single message is displayed. You get full control over how Typewriter looks and feels, you can finally make your Minecraft server look as pretty as your prom date 💖.

And if that wasn't enough, we've also added Entry Documentation. Thanks to our buddy @MrDiamondDog, you can now read all about every single entry of all the official adapters. Because let's face it, who doesn't love reading documentation 📚?

But wait, there's still more! We've also added three new adapters: WorldGuard, CombatLogX, and Superior Skyblock. Thanks to @calebneuf, you can now use Typewriter with even more plugins than ever before 🔌.

So what are you waiting for? Upgrade your Typewriter plugin today and supercharge your player interactions 📈!

Ahoy there, fellow Typewriter enthusiasts! It's time for another update 🎉, and this one is sure to have you flipping pages like there's no tomorrow 📖.

First up, we've got references 🔗 to entries on another page! That's right, you can now reference an entry that is on a completely different page. It's like there is a portal in each page. Now with this new superpower allows you to create stories that are even more flexible and powerful 💪. It's like having a never-ending book of epic adventures, where the only limit is your imagination 🤯 (and maybe your typing speed).

But wait, there's more! We've also revamped the search bar 🔍 with some shiny new animations. Trust us, you'll be typing away and searching for those hidden gems in no time 🧐. And to top it all off, we've created a custom documentation site 📚 so that contributors can also contribute to the documentation site! Because who knows better than our users what they want to learn about?

And of course, there are many more minor changes that we won't bore you with. But rest assured, we've been working tirelessly to make Typewriter the best it can be. So go forth, fellow adventurers, and start turning those pages!

Change-log

Major Changes

• Allow for references to entries on another page! This makes creating stories more flexible and powerful!
• Revamped the search-bar. It's now fully integrated throughout the application. And has some new nice animations!
• Created a custom documentation site so that contributors can also contribute to the documentation site!

Minor Changes

• Restructured the web panel code to reuse more components and clean everything up (Sometimes a little housekeeping is necessary).
• Added a Vault Adapter (thanks to @calebneuf)
• Added various new entry to the Basic Adapter (thanks to @calebneuf, @MrDiamondDog, and @CDFN)
• Changed NPC linking to just their ID
• Fixed items having a default name if the field was left empty (thanks to @MrDiamondDog)
• Fixed bug where some actions were called async leading to an error in paper.