Code Monkey home page Code Monkey logo

craftmark's Introduction

CraftMark Build Status Spigot

CraftMark is a spigot plugin that adds markdown support to minecraft's chat system. This greatly extends and improves the game's formatting system in a way that's much more intuitive than before.

Supported Operations

Chat colors will continue to work as they have before; using & with 0-9 or a-f.

Formatting codes are supported via the following markdown operations:

Name Operation Code
Bold **example** &l
Italic *example* &o
Underline ++example++ &m
Strikethrough ~~example~~ &n
Escape MD `example` N/A

Coming Soon

Name Operation Code
Spoiler ||example|| &k
Link [Example](link) N/A

Later operations are to be considered. If you have any ideas you want supported, feel free to open an issue in the issue tracker.

Contributing

To begin contributing to this project, import the project into your preferred IDE of choice. Make sure to also take the time to create a spigot test server on your machine for debugging.

To build the project, run gradle build. I would also recommend setting up a debug runner in your IDE for hot reloading. Follow this guide for IntelliJ and this one for eclipse.

Please take care to verify that you have Java 8 installed and your project is using it, additionally please note that the project follows the K&R style guidelines.

craftmark's People

Contributors

atriusx avatar

Stargazers

Michael avatar

Watchers

James Cloos avatar  avatar

craftmark's Issues

Style preservation breaks in certain cases

Due to the nature of color codes in Minecraft, it was necessary to introduce style preservation into the renderer. This allows the user to type messages where the color changes midway through, without terminating the markdown region prematurely.

The initial implementation of this system works decently well on it's own, however it does appear to break reliably when the user supplies multiple color codes in rapid succession (between 0 to 1 - 2 characters apart).

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.