search

mfnalex / Spigot-UpdateChecker

UpdateChecker for your Spigot plugins with only one line of code needed in your plugin!
GNU General Public License v3.0
54 stars 14 forks source link

Add customisable message colors #24

Closed lokka30 closed 2 years ago

lokka30 commented 2 years ago

This PR is only useful as a temporary aid to customising messages. This PR is likely to be rejected since it isn't a permanent solution, I am just submitting this in case you prefer it.

This PR allows the customisation of message colors, however, this PR does not allow customisation of the content of the messages.

This is likely incompatible with #9 and does not fully solve #20.

mfnalex commented 2 years ago

This PR is likely to be rejected

Yeah, unfortunately you're right :P But I guess I'll just make it configurable now. My idea is the following:

The lib itself contains a file updatechecker-messages-default.yml that contains the messages. Plugin devs can simply include their own file called updatechecker-messages.yml and if that's present, it will use those messages instead.

The plugin name, version etc can then be simply controlled with placeholders like {plugin}, {version}, {downloadFree}, {downloadPaid}, etc etc

lokka30 commented 2 years ago

This PR is likely to be rejected

Yeah, unfortunately you're right :P But I guess I'll just make it configurable now. My idea is the following:

The lib itself contains a file updatechecker-messages-default.yml that contains the messages. Plugin devs can simply include their own file called updatechecker-messages.yml and if that's present, it will use those messages instead.

The plugin name, version etc can then be simply controlled with placeholders like {plugin}, {version}, {downloadFree}, {downloadPaid}, etc etc

No worries 😁 Wouldn't this be better configured through an enum of some sorts, similar to the one I used in this PR? No YML syntax or parsing to deal with.

mfnalex commented 2 years ago

An enum? I don't really understand what you mean, like - how would one be able to pass the translated message using an enum? 🐺

lokka30 commented 2 years ago

An enum? I don't really understand what you mean, like - how would one be able to pass the translated message using an enum? 🐺

An enum containing a constant for each message sent by S-UC. The enum has a method getDefaultContent, setContent, getContent - similar to how I did this in the commit for custom message colors. :)

Haven't given this much thought so let me know if it's a terrible idea. 😁