search

Phoenix616 / MineDown

A MarkDown inspired markup library for Minecraft chat components
https://wiki.phoenix616.dev/library/minedown/
MIT License
296 stars 21 forks source link

Make adventure artifact the main one and deprecate bungeecord-chat #24

Open Phoenix616 opened 2 years ago

Phoenix616 commented 2 years ago

Currently there are two different maven artifacts and branches, the master one with bungeecord-chat as the component adapater and the kyori-adventure one which uses adventure.

In order to support as many platforms as possible the adventure branch is the one with the most usefulness for the community at large seeing as adventure is supported either natively or via adapters in pretty much every Minecraft-related plugin, modding or proxy API.

A possible plan for shifting the focus completely to adventure could be as simple as renaming the current minedown-adventure artifact to just minedown but with a version increased to 2.0 seeing as it would be a major update which would require changes by developers. The old 1.x versions of that artifact could be maintained for a bit longer to fix serious bugs if they occur but not receive new updates.

Main issue with that would be that projects which use minedown-adventure right now would not get those upgrades automatically, maybe an update could be pushed to that artifact which deprecates stuff? Unfortuantely maven doesn't really offer deprecation notices... alternatively minedown-adventure could be continued to be used as the artifact name but that could be confusing in the long-run.

Phoenix616 commented 4 months ago

I recently made minedown-adventure the main branch with a note in the readme added about Bungee-chat being legacy.

At some point minedown 2.0 will be released with a bunch new features (and potentially a re-implemented parser) requiring adventure but for now it will stay minedown-adventure and the original bungee-chat will only receive fixes, no new features.