Create lockedchunkoverlay

[rauvagol]

Overlay that works either by itself or with the region-locker plugin to display locked chunks on the world map with any gpu.

Includes optional warnings and penalties for time spent in a locked chunk (disabled by default except for increasing (non-opaque) darkness)

First plugin, so I apologize in advance if I messed up any steps, and I will correct any issues ASAP

[runelite-github-app]

New plugin lockedchunkoverlay: https://github.com/rauvagol/lockedchunkoverlay/tree/ac535c2e8a0a1a4b2b49c5a29cf794be6b059e15

[runelite-github-app]

This plugin requires a review from a Plugin Hub maintainer. The reviewer will request any additional changes if needed.

---

Internal use only: Reviewer details Maintainer details

[rauvagol]

I suspect the plugin hub check is because of the site integration/url access potentially being used maliciously

A quick summary to explain why that exists, the user is able to input their map code, which is used to assemble a url like so

"https://chunkpicker.firebaseio.com/maps/" + mapCode + "/chunks/unlocked.json"

which returns a list of unlocked chunks.

I don't see a way this could be used maliciously, but if there are needed changes, then I will gladly make them

[riktenx]

What you're doing is allowed but you MUST add a disclaimer to your manifest file stating that your plugin makes network requests and transmits your IP address to a 3rd-party server not controlled or verified by RuneLite developers.

Example: https://github.com/runelite/plugin-hub/blob/master/plugins/flipping-copilot#L4

I haven't looked at your code at all, but if there's a way for this plugin to work without doing that (like, save chunks in rsprofile or something) that's probably going to be preferred.

[rauvagol]

Alright, made that addition, and it does work without that, but the ability to import the chunks automatically from https://source-chunk.github.io/chunk-picker-v2/ is an optional feature that I have had very good feedback on, and the site itself is well known by people doing chunk accounts.

As for how it works/can be avoided, there are three options a user has

• Integration with the region locker plugin: reads the list of chunks that plugin marks as unlocked (semi-self contained, convenient)
• Manual input: lets the user input a list of allowed chunkIDs (completely self contained but a bit annoying)
• Site reading: automatically gets your list of unlocked chunks from the sourcechunk site, will only ever make requests if you have that selected AND a map code entered, extremely convenient, but relies on third party tools.

It works the same as the chunk-tasks plugin, but instead of a checkbox to allow connection, you need to select the dropdown option

[riktenx]

FYI if your networking happens behind an opt-in config, you can get rid of the manifest-level disclaimer and instead put it in @ConfigItem::warning (https://static.runelite.net/runelite-client/apidocs/net/runelite/client/config/ConfigItem.html#warning())

[rauvagol]

Thanks for the info, added that warning and updated the plugin-hub pr (also made manual input the default, so ANY integrations need to be opt in)