bogstandard / rl-weather

Weather plugin for RuneLite
BSD 2-Clause "Simplified" License
9 stars 3 forks source link

Planning: in-game location matching #7

Open bogstandard opened 2 years ago

bogstandard commented 2 years ago

This is a planned feature, any suggestions & help welcome!

Summary

The Old School Runescape map is divided into Regions, these can be derived in-game by Plugins like World Location and, they can be derived out-of-game and in-browser by using maps like Explv's Map (enable Region Grid & Labels).

Using similar code to World Location, we should be able to assign various weather conditions to specific in-game locations, eg. It always thunder storms at Barbarian Village and rains at Lumbridge.

Proposed Config

Introduce 3 new config options to assign which regions get what; Raining Region IDs, Thunder Region IDs, Snowing Region IDs. By default we'd assign what "feels best" for these config options, with users being able to amend them how they see fit.

For the example of thunder storming at Barbarian Village, the Region IDs for Barbarian Village would appear in the Raining Region IDs and Thunder Region IDs lists.

There would be a toggle similar to the recent real-world-location matching feature & would behave in a similar way.

This is a simple way of doing it, but I'm unsure users would be happy having to muck about with the huge amount of region IDs. Maybe there's a better way?

Crazy Future Idea; Ever-Changing Region Assignment

Maybe we could host a file on GitHub that cycles which Regions are assigned which weather, so we can simulate weather systems moving in-and-out of game regions. Since users would all be getting the same data, everyone would be "in sync". Two users of the Plugin at Varrock would have it begin to rain at the same time if the file updated to say it was now raining there.

Feasibility

Personally I'm back at full-time work so my ability to work on the plugin is more limited. Any help is more than welcome.

JeauxyPatton commented 1 year ago

Hey friend, I'm a real-life meteorologist and I want to say I love this plug-in. I would definitely be interested in helping develop some of the future work, like assigning weather by regions and the updating weather systems in-game.

bogstandard commented 1 year ago

Hi @JeauxyPatton thanks for the praise, it means a lot to all the contributors! If you've any ideas please feel free to lay them out! Ultimately we'll need at minimum a huge list of weather types matched to the region block numbers. I think. The more advanced plugin 3D Weather I believe does regional cycles this way.

If you've any ideas on how the cycles could be chosen or calculated that's something I've not given much thought at all yet. I think we could maybe hook it the clock, so all users with regional weather mode on, get the same weather effect at once.

I don't currently have membership (times are tight!) so I'm unable to checkout a lot of the places in-game 😅

bogstandard commented 1 year ago

Hey friend, I'm a real-life meteorologist and I want to say I love this plug-in. I would definitely be interested in helping develop some of the future work, like assigning weather by regions and the updating weather systems in-game.

HI @JeauxyPatton please see my latest reply here: https://github.com/bogstandard/rl-weather/issues/8#issuecomment-1586293519

This will be going Live soon, hopefully. I'm working on it tonight.