{"id":13407867,"url":"https://github.com/Phoenix616/MineDown","last_synced_at":"2025-03-14T12:31:47.929Z","repository":{"id":38866664,"uuid":"120537452","full_name":"Phoenix616/MineDown","owner":"Phoenix616","description":"A MarkDown inspired markup library for Minecraft chat components","archived":false,"fork":false,"pushed_at":"2024-12-01T16:06:26.000Z","size":291,"stargazers_count":299,"open_issues_count":6,"forks_count":21,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-03T14:05:56.248Z","etag":null,"topics":["bungeecord","chat","component","formatting","markdown","minecraft","minedown","spigot"],"latest_commit_sha":null,"homepage":"https://wiki.phoenix616.dev/library/minedown/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Phoenix616.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["Phoenix616"],"ko_fi":"Phoenix616","custom":"https://tip.phoenix616.dev"}},"created_at":"2018-02-06T23:42:59.000Z","updated_at":"2025-02-23T17:09:43.000Z","dependencies_parsed_at":"2024-12-01T17:22:28.419Z","dependency_job_id":"b8c51dec-b70b-4b36-b139-4ef1f6e50566","html_url":"https://github.com/Phoenix616/MineDown","commit_stats":{"total_commits":112,"total_committers":5,"mean_commits":22.4,"dds":0.5,"last_synced_commit":"a0423fcf337680d3dd87bfb7fb63259cb910506d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phoenix616%2FMineDown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phoenix616%2FMineDown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phoenix616%2FMineDown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Phoenix616%2FMineDown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Phoenix616","download_url":"https://codeload.github.com/Phoenix616/MineDown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242865723,"owners_count":20197947,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bungeecord","chat","component","formatting","markdown","minecraft","minedown","spigot"],"created_at":"2024-07-30T20:00:49.138Z","updated_at":"2025-03-14T12:31:47.382Z","avatar_url":"https://github.com/Phoenix616.png","language":"Java","funding_links":["https://github.com/sponsors/Phoenix616","https://ko-fi.com/Phoenix616","https://tip.phoenix616.dev"],"categories":["Messages","Java"],"sub_categories":[],"readme":"# MineDown-adventure\nA library that adds the ability to use a MarkDown inspired markup to write Minecraft chat components!\n\nIt provides a custom mark up syntax which is loosely based on MarkDown that adds the ability to use the full power of \ncomponent messages with the same simplicity as legacy formatting codes. (Which it can still support!)\nIt also includes a way to directly replace placeholders in the messages, both string based and component based ones!\n\nThis requires the [kyori-adventure](https://github.com/KyoriPowered/adventure) chat API so you need to provide one of \nthe [platform libraries](https://github.com/KyoriPowered/adventure-platform) in your project in order to use these\nmessages! See [this plugin](https://github.com/Phoenix616/MineDownPlugin/) for a simple implementation.\n\n## Syntax\n\n### Inline Formatting\n Description   | Syntax             | More Info                                                     | Preview\n --------------|--------------------|---------------------------------------------------------------|-------------------------------------------\n Color legacy  |` \u00266Text           `| [Formatting codes](https://minecraft.wiki/w/Formatting_codes) | ![](https://i.phoenix616.dev/gbJYVeql.png)\n Color         |` \u0026gold\u0026Text       `| [Color names](https://minecraft.wiki/w/Formatting_codes)      | ![](https://i.phoenix616.dev/gfgApGrn.png)\n RGB Hex Color |` \u0026#ff00ff\u0026Text    `| Full hexadecimal format                                       | ![](https://i.phoenix616.dev/glFV9zgw.png)\n RGB Hex Color |` \u0026#f0f\u0026Text       `| Short format (equivalent to long one)                         | ![](https://i.phoenix616.dev/gojZlSaN.png)\n Gradient      |` \u0026#f0f-#fff\u0026Text  `| Inline gradients                                              | ![](https://i.phoenix616.dev/giOQuXV6.png)\n Rainbow       |` \u0026rainbow\u0026Text    `| Inline Rainbow                                                | ![](https://i.phoenix616.dev/ggYaEWZt.png)\n Rainbow Phase |` \u0026rainbow:20\u0026Text `| Inline Rainbow with a phase                                   | ![](https://i.phoenix616.dev/gojDf1ZM.png)\n Bold          |` **Text**         `|                                                               | ![](https://i.phoenix616.dev/fYDs0soW.png)\n Italic        |` ##Text##         `|                                                               | ![](https://i.phoenix616.dev/gaLmjWZA.png)\n Underlined    |` __Text__         `|                                                               | ![](https://i.phoenix616.dev/gk6lbR0B.png)\n Strikethrough |` ~~Text~~         `|                                                               | ![](https://i.phoenix616.dev/gpc5zBr4.png)\n Obfuscated    |` ??Text??         `|                                                               | ![](https://i.phoenix616.dev/giRU4C9u.gif)\n\n### Events ###\nYou can define click and hover events with the commonly used MarkDown link syntax\nas well as specify formatting, font and colors that way.\n\n#### Simple Syntax\n Description                    | Syntax\n -------------------------------|------------------------------------------------------------\n General syntax                 |` [Text](text-color text-formatting... link hover text)    `\n Simple Link                    |` [Text](https://example.com)                              `\n Simple Command                 |` [Text](/command to run)                                  `\n Link + Hover                   |` [Text](https://example.com Hover Text)                   `\n Text formatting                |` [Text](blue underline !bold)                             `\n Gradient                       |` [Text](#fff-#000)                                        `\n Rainbow                        |` [Text](rainbow)                                          `\n Phased Rainbow                 |` [Text](rainbow:20)                                       `\n Text formatting + Link + Hover |` [Text](#0000ff underline https://example.com Hover Text) `\n\n \n#### Advanced Syntax\n Description        | Syntax                                 | More Info\n -------------------|----------------------------------------|----\n General syntax     |` [Text](action=value)                 `|[ClickEvent.Action](https://github.com/KyoriPowered/adventure/blob/master/api/src/main/java/net/kyori/adventure/text/event/ClickEvent.java#L196-L222), [HoverEvent.Action](https://github.com/KyoriPowered/adventure/blob/master/api/src/main/java/net/kyori/adventure/text/event/HoverEvent.java#L311-L339)\n Link               |` [Text](open_url=https://example.com) `|\n Color              |` [Text](color=red)                    `| [Color names](https://minecraft.wiki/w/Formatting_codes)\n RGB Hex Color      |` [Text](color=#ff00ff)                `| Full hexadecimal format\n RGB Hex Color      |` [Text](color=#f0f)                   `| Short format (equivalent to long one)\n RGB Color Gradient |` [Text](color=#fff-#000)              `| Gradient of two colors. (Supports all color forms)\n RGB Color Gradient |` [Text](color=#fff-#333-#222)         `| Gradient of three colors.\n RGB Rainbow        |` [Text](color=rainbow)                `| An RGB rainbow.\n Phased RGB Rainbow |` [Text](color=rainbow:50)             `| An RGB rainbow with a specific phase.\n Formatting         |` [Text](format=underline,bold)        `| Specify formatting\n Disable Formatting |` [Text](format=!underline)            `| Disable the specific formatting with a ! prefix\n Font               |` [Text](font=custom_font)             `| Set a custom font from a resource pack\n Run Command        |` [Text](run_command=/command string)  `| Run command on click\n Suggest Command    |` [Text](suggest_command=/command)     `| Suggest a command on click\n Simple Hover       |` [Text](hover=Hover Text)             `| Show hover text\n Hover Text         |` [Text](show_text=Hover Text)         `| Show hover text\n Hover Entity Info  |` [Text](show_entity=uuid:pig Name)    `| Show entity information.\n Hover Item Info    |` [Text](show_item=stone*2 nbt...)     `| Show item information, additional information needs to be provided as a string of the nbt in json\n Insertion          |` [Text](insert=insert into input)     `| Insert into input on shift click, can be combined with other events\n \nAll advanced settings can be chained/included in a event definition.\nYou can't however add multiple different colors or click and hover actions!\n\n## How to use it\nThe library's main API access is through the [MineDown.class](https://docs.minebench.de/minedown-adventure/de/themoep/minedown/adventure/MineDown.html) and its parse methods.\n\nE.g. you can use it like this in your Bukkit plugin:\n```java\nBukkitAudiences.create(plugin).player(player).sendMessage(new MineDown(rawMessage).replace(replacements).toComponent());\n```\nor with a static approach:\n```java\nBukkitAudiences.create(plugin).player(player).sendMessage(MineDown.parse(rawMessage, replacements));\n```\n\nTake a look at the [MineDown JavaDocs](https://docs.minebench.de/minedown-adventure/) for more\ndetailed info on the library and the included classes.\n\n### Include it into your plugin\nYou can easily include this library into your plugin by using maven.\nMake sure to relocate it into your plugin's package!\n\n#### Repository\n```xml\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003eminebench-repo\u003c/id\u003e\n        \u003curl\u003ehttps://repo.minebench.de/\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\n#### Artifact\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ede.themoep\u003c/groupId\u003e\n        \u003cartifactId\u003eminedown-adventure\u003c/artifactId\u003e\n        \u003cversion\u003e1.7.3-SNAPSHOT\u003c/version\u003e\n        \u003cscope\u003ecompile\u003c/scope\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n##### Legacy BungeeCord-chat library\nThe original BungeeCord-chat library is no longer maintained and has been replaced by this adventure implementation. If you need to still use the legacy version (found on the `legacy` branch), you can include it like this:\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ede.themoep\u003c/groupId\u003e\n        \u003cartifactId\u003eminedown\u003c/artifactId\u003e\n        \u003cversion\u003e1.7.1-SNAPSHOT\u003c/version\u003e\n        \u003cscope\u003ecompile\u003c/scope\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n#### Relocation\n```xml\n\u003cbuild\u003e\n    \u003cplugins\u003e\n        \u003cplugin\u003e\n            \u003cartifactId\u003emaven-shade-plugin\u003c/artifactId\u003e\n            \u003cversion\u003e3.1.0\u003c/version\u003e\n            \u003cconfiguration\u003e\n                \u003crelocations\u003e\n                    \u003crelocation\u003e\n                        \u003cpattern\u003ede.themoep.minedown\u003c/pattern\u003e\n                        \u003cshadedPattern\u003eyour.package.path.libraries.minedown\u003c/shadedPattern\u003e\n                    \u003c/relocation\u003e\n                \u003c/relocations\u003e\n            \u003c/configuration\u003e\n            \u003cexecutions\u003e\n                \u003cexecution\u003e\n                    \u003cphase\u003epackage\u003c/phase\u003e\n                    \u003cgoals\u003e\n                        \u003cgoal\u003eshade\u003c/goal\u003e\n                    \u003c/goals\u003e\n                \u003c/execution\u003e\n            \u003c/executions\u003e\n        \u003c/plugin\u003e\n    \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\n### Alternative to shading\n\nAlternatively you can also directly depend on my [MineDownPlugin](https://github.com/Phoenix616/MineDownPlugin/) \ninstead of shading in this library! MineDownPlugin includes a non-relocated version of this library.\n\n## License\nMineDown is licensed under the MIT open source license:\n\n```\nCopyright (c) 2024 Max Lee (https://github.com/Phoenix616)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPhoenix616%2FMineDown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPhoenix616%2FMineDown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPhoenix616%2FMineDown/lists"}