Add support for tab completing and highlighting console input from the Brigadier command tree

[jpenilla]

Adds support for tab completing and highlighting console input from the Brigadier command tree. This works with vanilla commands, regular bukkit commands, as well as bukkit commands that have registered with Brigadier using Commodore/CommandRegisteredEvent.

Screenshot:

[TheFruxz]

OMG, waited for this feature so long, I love it! Have to be inside of paper-api

[zml2008]

nice to see this make its way to paper :)

I think an event is unnecessary since plugin devs can already provide completions with the brig api and the event as it stands reeks of implementation detail

also, when I implemented this I ran I to some situations where it seemed like the ranges on brig nodes were out of bounds for the input string, not sure why. iirc I was able to get this with bossbar create at the argument that took a json Component

[wizjany]

Honestly I'd prefer an event over forcing brig. Unfortunately brig doesn't allow for everything that plugins may want to use in commands and adapting to it causes loss of functionality (flags and mid-command optionals to name a few). That said I'm not sure if this needs to be console-limited. Would be cool to have component completions for in game commands too (again, short of relying on brig).

iirc when DemonWav played around with this for paperd he just hooked off the existing event (albeit didn't support components) and it worked pretty well.

[jpenilla]

Honestly I'd prefer an event over forcing brig. Unfortunately brig doesn't allow for everything that plugins may want to use in commands and adapting to it causes loss of functionality (flags and mid-command optionals to name a few). That said I'm not sure if this needs to be console-limited. Would be cool to have component completions for in game commands too (again, short of relying on brig).

iirc when DemonWav played around with this for paperd he just hooked off the existing event (albeit didn't support components) and it worked pretty well.

It seems like the AsyncPlayerSendSuggestionsEvent should allow for the same type of functionality for the player. It exposes the Brigadier Suggestions object before sending the tab complete packet to the player. Needing to manually convert your Components to Messages for use as tooltips is a bit annoying and could probably be improved, though.

[jpenilla]

nice to see this make its way to paper :)

I think an event is unnecessary since plugin devs can already provide completions with the brig api and the event as it stands reeks of implementation detail

also, when I implemented this I ran I to some situations where it seemed like the ranges on brig nodes were out of bounds for the input string, not sure why. iirc I was able to get this with bossbar create at the argument that took a json Component

I think I am mostly in agreement about the event, it basically is an implementation detail.

This line prevents the out of bounds issue: https://github.com/PaperMC/Paper/pull/5437/files#diff-7f71fa74f053b28e5f753d6db8dff2530b32fa0369b2c0ed2e7bacbb28183247R231

[wizjany]

Honestly I'd prefer an event over forcing brig. Unfortunately brig doesn't allow for everything that plugins may want to use in commands and adapting to it causes loss of functionality (flags and mid-command optionals to name a few). That said I'm not sure if this needs to be console-limited. Would be cool to have component completions for in game commands too (again, short of relying on brig).
iirc when DemonWav played around with this for paperd he just hooked off the existing event (albeit didn't support components) and it worked pretty well.

It seems like the AsyncPlayerSendSuggestionsEvent should allow for the same type of functionality for the player. It exposes the Brigadier Suggestions object before sending the tab complete packet to the player. Needing to manually convert your Components to Messages for use as tooltips is a bit annoying and could probably be improved, though.

Unfortunately the counterpart here is actually AsyncTabCompleteEvent. The SendSuggestions event happens at a different point in the command lifecycle and requires a complete second pass at processing essentially. I suppose what I'm saying is that I think components should be added to AsyncTabCompleteEvent instead of making a new event. Dunno how break-y that'd be though.

[zml2008]

That was something i asked jmp to look at doing as well -- but it sounded like there wasn't any nice way to shove tooltips into there.

[jpenilla]

Something like that might be possible but I think it's out of scope for this PR.

[jpenilla]

I've removed the event, as I agree with zml that it's too much of an implementation detail. This PR should be "ready for review" now.

[JRoy]

Tested with latest EssentialsX which tampers with CommandMap quite a bit and this works!

[kennytv]

Looks hot and works well from my testing 🐱‍🏍

[codebycam]

Looks hot and works well from my testing too 🐱‍🏍