MarkChat

About the Modification

When I was setting up my SMP server, I noticed that I consistently used markdown syntax while writing chat messages. Although Minecraft doesn't support player chat formatting by default, the game client has built-in capabilities to display formatted text if the server sends it.

This modification analyzes chat messages using Markdown, applies formatting, and sends the formatted version to clients. Players gain the ability to use bold and italic text using the same syntax as Discord and other popular messengers. Additionally, the mod prevents the chat reporting system.

Working with Books

Beyond chat formatting, MarkChat includes an additional module that allows loading Markdown files as written books. To use this, hold a book and quill and execute the command /book upload <title>. The system will prompt you to upload a markdown file via Filebin, which the server will then download. The command /book download <title> (url|filebin) <address> is also available for direct book downloads.

This module can be disabled in the settings.

Configuration Settings

config/markchat.json

• formatting (object): Formatting style settings

  • ulPrefix (string): Prefix for bulleted lists
  • olPrefix (string): Prefix for ordered lists. Use %d to indicate item number
  • headingColors (list): List of colors for different heading levels. Formats specified similar to linkColor. Headings with index greater than list length will use the last element
  • linkColor (string): Link color. Can be a Minecraft color name or hex code

• allowLinks (string): Link permission in chat and books. Values: NEVER, ADMINS or ALWAYS

• enableBooks (boolean): Enable book upload module. If false, mod functionality is limited to chat only

• filebinUrl (string): Base URL of Filebin for uploading markdown files

• commandPrefix (string): Prefix of book command. Change in case of conflicts with other modifications

Supported Markdown Elements

Current implementation follows CommonMark specification.