Skip to content

Commit

Permalink
Merge pull request #14 from MrDiamondDog/main
Browse files Browse the repository at this point in the history
Minor README changes
  • Loading branch information
gabber235 authored Feb 9, 2023
2 parents 18eb052 + 8510e2b commit 3e60067
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@

[![Discord](https://img.shields.io/discord/1054708062520360960?label=discord&logo=discord&logoColor=white)](https://discord.gg/HtbKyuDDBw)
[![Release](https://img.shields.io/github/v/release/gabber235/Typewriter?include_prereleases&logo=github)](https://github.com/gabber235/TypeWriter/releases)
![License](https://img.shields.io/github/license/gabber235/Typewriter?logo=github)
[![License](https://img.shields.io/github/license/gabber235/Typewriter?logo=github)](LICENSE)

Typewriter is a plugin for spigot Minecraft servers that allows for custom player interactions such as Quests,
NPC chat, Create branching story with ease, 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](https://github.com/gabber235/TypeWriter/wiki/pre-made-adapters) or can be custom-made by developers.

To get started with Typewriter, see the [Getting Started](#getting-started) section.
Expand All @@ -33,6 +34,9 @@ The web panel for Typewriter, where you can create quests, NPCs, and more.

To get started with Typewriter, simply download the [plugin](https://github.com/gabber235/TypeWriter/releases) and configure it accordingly.
See [Installation Guide](https://github.com/gabber235/TypeWriter/wiki/Installation-guide) for more information.

Also be sure to download ProtocolLib from [here](https://ci.dmulloy2.net/job/ProtocolLib/lastSuccessfulBuild/) (Click on `ProtocolLib.jar`).

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

You can also utilize the [pre-made adapters](https://github.com/gabber235/TypeWriter/wiki/pre-made-adapters) or create your own custom adapters to extend the
Expand All @@ -59,4 +63,4 @@ See [LICENSE](LICENSE) to see the full text.

# Credits

- [Aarthificial](https://www.youtube.com/channel/UCZ1XWgQK8YkZp5ZwXKdVqjw) For the inspiration on the base logic.
- [Aarthificial](https://www.youtube.com/@aarthificial) For the inspiration on the base logic.

0 comments on commit 3e60067

Please sign in to comment.