Skip to content

NovaverseMC/TypeWriter

 
 

Repository files navigation

Typewriter

The next generation of questing in minecraft.

Discord Release License

Typewriter is a plugin for Paper Minecraft servers that allows for custom player interactions such as Quests, NPC chat, Create branching story with ease, Creating Cinematic with camera paths, and more. It is easily configurable using the web panel specifically designed for this plugin.

The plugin can also be extended using adapters, which are pre-made or can be custom-made by developers.

To get started with Typewriter, see the Getting Started section.

Sponsors

Thanks to the following sponsors for supporting this project:

Pier Paolo TanziBryan

Examples

cinematic

A cinematic fully in vanilla minecraft using Typewriter. View a demo here.

dialogue sequence

A dialogue sequence with Typewriter where the player is asked to choose between multiple options.

web panel

The web panel for Typewriter, where you can create quests, NPCs, and more.

Features

  • Create custom player interactions, including quests and NPC chat, branching story, and more...
  • Create cinematic sequences with camera movements, dialogue, animated NPCs, and more...
  • Configure interactions using a custom written visual interface
  • Extend the plugin using adapters
    • Pre-made adapters available for popular plugins
    • Custom adapters can be made by developers

Getting started

To get started with Typewriter, simply download the plugin and configure it accordingly. See Installation Guide for more information.

Also be sure to download ProtocolLib from here (Click on ProtocolLib.jar).

Then, use the app to configure your custom interactions as desired.

You can also utilize the pre-made adapters or create your own custom adapters to extend the capabilities of the plugin. See First Interaction for more information.

For administrators

As an administrator, you can easily configure Typewriter using the custom web panel. Simply input your desired interactions and let the plugin handle the rest. You can also take advantage of the pre-made adapters or create your own custom adapters to further customize the plugin for your server.

For developers

Are you a developer looking to contribute to Typewriter? We welcome any custom adapters you may create! Simply make a pull request to add your adapter to our repository. If you create an adapter for an open source plugin, we would be happy to include it in our list of ready adapters. Help us make Typewriter the best it can be!

License

GNU General Public License v3.0

See LICENSE to see the full text.

Credits

Packages

No packages published

Languages

  • Dart 51.9%
  • Kotlin 41.2%
  • Rust 4.7%
  • C++ 1.0%
  • CMake 0.8%
  • Ruby 0.1%
  • Other 0.3%