https://github.com/atriusx/craftmark
Spigot chat manager implementing markdown support
https://github.com/atriusx/craftmark
chat markdown minecract spigot
Last synced: 29 days ago
JSON representation
Spigot chat manager implementing markdown support
- Host: GitHub
- URL: https://github.com/atriusx/craftmark
- Owner: AtriusX
- License: mit
- Created: 2019-05-29T21:32:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-16T03:26:39.000Z (almost 7 years ago)
- Last Synced: 2025-02-12T17:19:59.267Z (over 1 year ago)
- Topics: chat, markdown, minecract, spigot
- Language: Java
- Size: 61.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CraftMark [](https://travis-ci.com/AtriusX/CraftMark) [](https://www.spigotmc.org/)
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](https://www.spigotmc.org/wiki/intellij-debug-your-plugin/)
for IntelliJ and [this one](https://www.spigotmc.org/wiki/eclipse-debug-your-plugin/) 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.