Git Product home page Git Product logo

typewriter's Introduction

Typewriter

The next generation of questing in minecraft.

Discord Release

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:

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 PacketEvents from here.

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

Typewriter is licensed under its own LICENSE.

The basic of it is that you can use the software for free, but you can't sell/redistribute/modify it. The only exception is if you want to contribute to the project and make it better.

See LICENSE to see the full text.

Credits

typewriter's People

Contributors

gabber235 avatar marten-mrfc avatar kerzinator24 avatar calebneuf avatar mrdiamonddog avatar snyk-bot avatar dependabot[bot] avatar ahdg6 avatar alexdev03 avatar drakepork avatar multivershaun avatar olimposz avatar cdfn avatar gc-network avatar pxlpioneer avatar anis-slayer avatar nick-w-nick avatar dreeam-qwq avatar l1-an avatar vignan37 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.