feat: allow addons to add wiki pages to items

[ybw0014]

Description

Nowadays there are more and more Slimefun addons, but only Slimefun items can have the wiki item in the recipe display. Some addons already have wiki, but players may not be able to know the wiki's existence, unless the developer add the wiki link via FlexItemGroup or using other ways. I think the wiki page item should be available to all the items that have wiki for them.

Tested with Sefiraat/Networks#152.

Proposed changes

• Add getWikiURL() in SlimefunAddon to provide a base URL for addon wiki.
• Add getWikiPage(String) in SlimefunItem to allow items to have wiki pages.
• Deprecate addOfficialWikipage in favor of getWikiPage.
• Display a different wiki icon for all addons.
• Move the code that setups wiki from wiki.json to WikiUtils.

Related Issues (if applicable)

N/A

Checklist

• I have fully tested the proposed changes and promise that they will not break everything into chaos.
• I have also tested the proposed changes in combination with various popular addons and can confirm my changes do not break them.
• I have made sure that the proposed changes do not break compatibility across the supported Minecraft versions (1.16.* - 1.20.*).
• I followed the existing code standards and didn't mess up the formatting.
• I did my best to add documentation to any public classes or methods I added.
• I have added Nonnull and Nullable annotations to my methods to indicate their behaviour for null values
• I added sufficient Unit Tests to cover my code.

[github-actions]

Pro Tip!
You can help us label your Pull Requests by using the following branch naming convention next time you create a pull request. ❤️

Branch naming convention	Label
feature/**	🎈 Feature
fix/**	✨ Fix
chore/**	🧹 Chores
api/**	🔧 API
performance/**	💡 Performance Optimization
compatibility/**	🤝 Compatibility

---

If your changes do not fall into any of these categories, don't worry. You can just ignore this message in that case! 👀

[github-actions]

Slimefun preview build

A Slimefun preview build is available for testing!
Commit: 69df2b5

https://preview-builds.walshy.dev/download/Slimefun/3937/69df2b59

Note: This is not a supported build and is only here for the purposes of testing.
Do not run this on a live server and do not report bugs anywhere but this PR!

[JustAHuman-xD]

I like the idea but limiting the addon to be under one url + a placeholder imo isn't ideal. If there was a way to add a full link to an item on top of this I think it would be a good addition

[J3fftw1]

I like the idea but limiting the addon to be under one url + a placeholder imo isn't ideal. If there was a way to add a full link to an item on top of this I think it would be a good addition

Yea i agree with this, maybe we can have the wiki link be defaulted to the repo as how you have it now but allow it to be overridable with custom links.
this will allow sites like gitbook to be used

[ybw0014]

For anyone would like to test this build using the preview jar, here is the modified Networks that utilized the methods added in this PR.
Download link: https://cloud.ybw0014.net/s/PwTr (my own cloudreve instance)
If you want to compile it by yourself, the PR link is here: Sefiraat/Networks#152

[WalshyDev]

I'm not fully opposed to giving a way to provide wiki links for addons.

However...

Arbitrary links doesn't feel good. Domains will be bought, not renewed and snatched by others. I think we need to figure out the right approach to this rather than just throw this out there.
We do not want to be the ones responsible for someone getting malware on their system or seeing adult material due to a snatched domain.

[ybw0014]

I'm not fully opposed to giving a way to provide wiki links for addons.

However...

Arbitrary links doesn't feel good. Domains will be bought, not renewed and snatched by others. I think we need to figure out the right approach to this rather than just throw this out there. We do not want to be the ones responsible for someone getting malware on their system or seeing adult material due to a snatched domain.

Maybe add a warning message before sending the link in the chat?

[J3fftw1]

Warnings don’t mean much and are almost always ignored

[ybw0014]

Warnings don’t mean much and are almost always ignored

It is the player's choice to ignore the warning.

[J3fftw1]

i dont think this is the right approach we will still be kept accountable if someone gets a virus or something else.
I do really like this feature, but i do agree with Walshy completely

[StarWishsama]

Maintaining a list of trusted wiki domain names could be a compromise, since no official addon wiki provided.

[Phoenix-Starlight]

Is creating a second repository for all addons an option?

…

On 8/7/23, NoRainCity ***@***.***> wrote: Maintaining a list of trusted wiki domain names could be a compromise, since no official addon wiki provided. -- Reply to this email directly or view it on GitHub: #3937 (comment) You are receiving this because you are subscribed to this thread. Message ID: ***@***.***>

[PhoenixCodingStuff]

I'm not fully opposed to giving a way to provide wiki links for addons.

However...

Arbitrary links doesn't feel good. Domains will be bought, not renewed and snatched by others. I think we need to figure out the right approach to this rather than just throw this out there. We do not want to be the ones responsible for someone getting malware on their system or seeing adult material due to a snatched domain.

Sf could have a list of whitelisted links, GitHub, gitbook and other docs hosting platforms. In addition to a warn that the files hosted are not officially by slimefun and made by the addon developer if that makes sense.

[ybw0014]

Minecraft has its own warning system already inplace for external links, If that fires im fine with this being in place.

Slimefun displays a message that contains the link when you click on the wiki button, so that will be fired.

.

[ybw0014]

As I didnt get any response for panel thing, I just merged commits and resolved merge conflicts.
As Jeff mentioned, Minecraft has its warning system, as we just send the link to users and users will be warned when they click on a link in the chat.

[J3fftw1]

Have you tested this with an addon that uses this?
Would love to see the button working.

[ybw0014]

Have you tested this with an addon that uses this? Would love to see the button working.

I tested this earlier with Networks (Sefiraat/Networks#152), now I'm gonna test this again.

[ybw0014]

Just tested and it still works. However, the item name seems to be a bit long, should we move some parts into item lore?

[J3fftw1]

Yea let’s just call it wiki

[PhoenixCodingStuff]

Agreed with Jeff, the item name can be Wiki to make it smaller while the error message is shown in chat.

[ybw0014]

I changed the wiki button name to 'View this item on the %addon% wiki', where %addon% will be replaced by addon name.
And add a line to show if it is official Slimefun wiki, or third party wiki.

[ybw0014]

[JustAHuman-xD]

How do we stop another plugin changing the wiki pages of another?

If an addon or just random plugin wanted to they could loop through the items and change the wiki page right?

And if they did that to the core slimefun items it would still appear as "official" even if it isn't

Or you could make a slimefun item have an "official" wiki, if you register the item with the slimefun instance (which you shouldn't do but you could to trick this system)

[ybw0014]

good point, maybe once the item has a wiki page, the wiki page link cant be changed further.

[ybw0014]

Its been a while.
I added a state check on addCustomWiki so the wiki page cannot be added once it is already set.
Also, I use pattern match to check if the wiki URL is from official Slimefun wiki.

I wonder if I should remove addOfficialWiki since I don't think any addon would use this.

[ybw0014]

Tested again with the modified Networks.