Skip to content

Repository files navigation

Medieval Roleplay Engine

Description

Medieval Roleplay Engine is a Minecraft plugin for players to use to roleplay more effectively. It currently supports Character Cards, Birds, Emotes, Dice, and different types of chats including local, global, whisper, yell, and local out-of-character.

Installation

First Time Installation

  1. Download the plugin from SpigotMC.
  2. Place the jar in the plugins folder of your server.
  3. Restart your server.

Optional Integrations

Usage

Documentation

Wiki & Additional Resources

Support

You can find the support Discord server here.

Experiencing a bug?

Please fill out a bug report here.

Contributing

Testing

This project does not yet have an automated unit test suite. For manual testing, use the Docker-based development server described below.

Development

Test Server with Plugin Hot-Reloading

A Docker-based test server is available for development.

Setup

  1. Build the plugin: mvn package (this project has no Maven wrapper, so Maven must be installed; the build targets Java 8, which is also what CI uses)
  2. Start the test server: ./up.sh

Stopping the Test Server

./down.sh

Authors and Acknowledgement

Developers

Name Main Contributions
DanTheTechMan Creator
UndeadZeratul Created a potential replacement for the /roll command
Caibinus Implemented PlaceholderAPI integration

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

You are free to use, modify, and distribute this software, provided that:

  • Source code is made available under the same license when distributed.
  • Changes are documented and attributed.
  • No additional restrictions are applied.

See the LICENSE file for the full text of the GPL-3.0 license.

Project Status

This project is in active development.

bStats

You can view the bStats page for the plugin here.

Roadmap

Changelog

See CHANGELOG.md for a release-by-release summary of changes.