Dynamic weather generation, by season and biome, including automatically activating weather effects. If Simple Calendar (see changelog for which versions of SC are supported by each version of Simple Weather) is present, Simple Weather will integrate to it and display the date/time and automatically generate new weather when the date changes. Without Simple Calendar, no date is shown and weather regeneration can be manually triggered. (NOTE: THIS MODULE IS NOT AFFILIATED WITH THE CREATORS OF SIMPLE CALENDAR)
I built this as a way to learn Foundry better, but I plan to maintain it for now and am happy to consider feature requests
- Intuitive UI to generate weather
- Use Foundry scene weather or FX Master to automatically show rain, snow, etc. when appropriate
- Various ways to share weather with players
- Print the weather to chat, with the option of showing to players or not
- Choose whether players can see the dialog (with a limited UI)
- Randomized weather for every season across 3 climates (hot, temperate, cold) and 3 humidities (barren, modest, verdant)
- Weather progresses naturally from day to day
- GM can see a forecast of the upcoming days
- Ability to manually pick weather for special events
- Ability to store weather history to calendar day, enabling replaying weather history
- Ability to add custom text (ex. movement penalties during snowstorms) to each weather condition
- Supports Farenheit and Celsius temperatures
- Helpful keybinding options
- Generate weather for every new day automatically
- Use the Simple Calendar season to adjust season automatically
- Show the current date/time from Simple Calendar in a smaller box (good for players who don't need the full Simple Calendar display), or hide it and just show the weather
- Display either as a standalone window or as a slide-out window attached to Simple Calendar
You can set a keybinding (see below) to toggle the window on/off. You can also hide the whole thing using the 'x' on the weather box. Once hidden, if you don't have a keybinding set, you can also re-open it via the Simple Weather button under the journal notes scene control menu.
Selecting a biome will automatically pick the climate and humidity to match - providing an easy way to pick standard Earth biomes. But you can also pick the climate/humidity separately so it's flexible to capture most weather conditions.
Seasons determine the types of weather for each biome. Winter is colder, summer is hotter, and spring/fall are in the middle (but generally tend toward getting warmer/colder).
When not using Simple Calendar, you just select the season you want to use.
When using Simple Calendar, you can choose "Sync with Simple Calendar" and the season of the current date will be used automatically. The season icon next to the drop down will change to let you know what season it is currently using. Simple Weather determines the Season to use based on the icon for the season in Simple Calendar. So, if you are using a custom calendar, for season sync to work you must a) set up seasons in Simple Calendar, and b) choose one of the season icons (fall, winter, spring, summer) for each of your seasons.
In some cases, you may need to override Simple Calendar's season. In particular, if you change hemispheres - because what Simple Calendar thinks is summer (ex. July) may actually be cold temperatures (ex. if in South America), so you'll want to manually override it. "Winter" is always cold in Simple Weather. In that case, simply pick the season you want in the drop down. It will remain in the manual setting until you set it back to "Sync".
Sometimes you might want to specify the exact weather that you need, rather than having it randomly generated (for example when approaching the lair of a frost witch). To do this, open the manual toolbar and check "Pause updates" (which will collapse the season and biome toolbars for simplicity). Note that pausing isn't technically required, but if you don't then if you hit "regenerate" or advance the date, the weather will go back to the normal weather pattern. You can then choose the weather desired from the dropdown and enter a temperature before hitting the submit button. This will then cause the weather to appear in the chat, player dialogs, and weather effects just as if the system generated it (as determined by your settings).
Unchecking "Pause updates" won't immediately trigger a regeneration of weather, but if you want one without advancing the date, just then hit the "regenerate" button.
The GM can activate weather effects in the module settings. This includes support for the scene weather in the Foundry core, as well as FX Master.
Once activated in settings, the scene weather will automatically be changed whenever the weather warrants it. There is currently only support for inclement weather (rain, hail, snow, fog). Let me know if there's any desire to do something to show sunny days, as I wasn't sure what made the most sense.
When players go inside, you can easily toggle the fx on/off temporarily using the toggle button on the toolbar. There is also a module setting to make weather FX turned on/off by scene instead of globally, so you can just set them to not display on indoor scenes and they'll automatically come back when you switch back to an outdoor scene.
***Note: I've mixed up the weather effects a bit - in particular whether or not clouds show up when it's raining. In all cases, I'd love to hear if there are setups you'd like to change how they work. I suspect different types of gameplay will have issues with different FX. Simply open an issue. At the very least, I need the text description of the weather at issue. Preferably, the biome, climate and/or humidity as well. Whatever you have. A description of the type of scene would be helpful, too (battle map, theater of the mind image, etc.) ***
If you activate forecasts in the module settings, the GM's window will display the next 7 days of weather. You'll see basic weather symbols for each day, and can mouseover one to see the detailed description. Temperatures are still estimates (accurate to within 5% degrees or so), but the descriptions will match exactly what gets generated for that day.
The full forecast is regenerated if you use the regenerate button. Setting the weather manually doesn't currently change the forecast (because it's easy to set weather that doesn't make sense for the current season or biome, so I'm not quite sure how a forecast should work).
I'm looking at adding an optional player view for the forecast that would be probabilistic in nature (i.e. not always right).
Comments on any of this are welcome here:
There are keybinding options under "Configure Controls" in the main Foundry Game Settings section. You can toggle the whole window on/off, regenerate weather, pause automatic changes to the weather, and toggle weather effects on/off. Note that these keybindings work even when the window is hidden. So you can in theory run the whole weather system while the window is hidden (autogenerating weather by calendar, manually generating new weather, turning effects on/off).
When using the "Attached to Simple Calendar" setting, there will be a button added to the Simple Calendar window to toggle the weather tab on/off. In this mode, there is no option to show Simple Weather's calendar panel (because the Simple Calendar must be showing).
Note that there is tight version dependency between this module and Simple Calendar. Check the changelog to find the version that works for your version of Simple Calendar. If the latest version of Simple Calendar isn't yet supported, please file an issue to let me know.
Or in compact mode:
- Custom weather messages - Allows you to manually enter additional text for each weather condition. When that condition comes up, this additional text will be output to the chat after the weather description and temperature. This is particularly useful if you'd like to assign system-specific conditions (for example, applying movement penalties during a snowstorm). Note that you have to set it in every combination of climate, humidity, and weather that you wish to have a special notation (though anything you don't need to notate can be left blank). For now, these are unreliable when manually selecting weather - NOT RECOMMENDED to combine the two features.
- Output weather to chat - If checked, whenever new weather is loaded/generated, it will be displayed in the chat. If not, you can only see the weather in the dialog.
- Make chat public - If checked, everyone will see the weather display (from prior option) in the chat. If not, it will only be visible to the GM
- Can players see dialog - If checked, the player version of the dialog (see above) will be visible to players. If not, players won't see a dialog.
- Display special effects - Choose weather to use special effects (and which system).
- Attach to Simple Calendar - If checked, turns on "Attached Mode" (see above).
- Store weather in Simple Calendar - If checked, whenever new weather is loaded/generated, it will create a note on the current day in Simple Calendar. This note will contain the weather for the day, for future reference. If you ever change the calendar date to be a day that has one of these weather notes, it will reuse the weather from that date rather than generating new weather. You can still manually set the weather or use the "regenerate" button to create new random weather (which will then update the note). The weather details are stored internally on the note, so it is safe to edit the note title and contents, if you'd like.
- Use Celsius - If checked, all temperatures will display in celsius. If not, Faherenheit.
If you manually set the weather via the Ambiance tab in the scene settings, you may get some unpredictable interactions. Unfortunately, there's not a great way for Simple Weather to know that the weather was manually picked. Generally speaking, if you toggle the Simple Weather FX toggle (twice - to get it back where it was) that should get the weather back under Simple Weather's control. The alternative was to prevent you from manually setting the weather altogether (which is what 1.15.0 was doing). If the toggle twice method isn't working for you, please create an issue.
Some people occasionally have issues where the box will disappear and won't come back. We haven't been able to consistently reproduce it, and I suspect it's a conflict with another module somehow. If this happens to you, though, for now the workaround is to open your browser console (usually f12) and run this command to reset the window position:
game.settings.set('simple-weather', 'windowPosition', { bottom: 100, left: 100})
Then refresh (F5). That should make the window reappear. If that doesn't work (or if anyone can find a way to reproduce this consistently) please create an issue report.
The attachment to the calendar when the calendar is in compact mode is highly dependent on the Simple Calendar version. Check the (change log) and make sure that the version of Simple Calendar you are using matches what's listed for your version of Simple Weather.
Sometimes when you have another Simple Calendar side tab open and you try to switch to the weather tab, it will close the other tab but not show the weather. The workaround is just to hit the weather button again.
- Why doesn't the weather update when I change the date in Simple Calendar? The weather updates are tied to the main Foundry calendar (so they can be triggered by any module that modifies the date). Make sure that the Simple Calendar calendar you are using is updating the game world time (under "General Setings" for the calendar).
If you believe you found a bug or would like to post a feature request, head over to the module's Github repo and open a new issue.
I'm happy to do this for free, as I primarily work on things I like to use myself. But if you'd like to buy me a root beer, I love knowing that people are using my projects and like them enough to make the effort. It's really appreciated!
Simnple Weather is the result of the effort of many people (whether they know it or not). Please refer to CREDITS.md for the full list.
THIS ENTIRE REPOSITORY IS COVERED BY THIS LICENSE AND COPYRIGHT NOTICE
Copyright 2023 Dov Rosenberg
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
