Weather Extension

From Fantasy Grounds Wiki
Jump to: navigation, search

The DOE: Weather Extension provides a Ruleset-Neutral database and the mechanics to generate the Day-To-Day Weather for a given Place. It will work with or without the DOE: Locations Extension and other DOE Extensions.

The DOE: Weather Extension consists of a series of Weather Records each representing one day's Weather at a particular place. In addition to information required to generate the Weather for a given Location, such as Altitude, Terrain, Time of Year, etc, each Weather Record also exposes the six Die Rolls used to randomize the Weather at that Location, allowing you to manually override the Die Rolls and regenerate the resulting Weather.

If, when generating a day's Weather a Weather Record exists for the previous day or for the next day then those days' Weather may have an effect on this day's Weather - the DOE: Weather Extension takes this into account.

Each Weather Record uses some Weather Data from both the previous day's and the next day's Weather, providing that that data exists, so while it is possible to manually change a given day's Weather this can lead to some strange and inconsistent results, such as having a Hurricane one day and then Drought the next. Thus, it is best to let the DOE: Weather Extension generate each Day's Weather instead of doing it manually.

The DOE: Weather Extension is Ruleset-Neutral (ie the results have no in-built game mechanics) and is based quite heavily on the Weather Generation System presented in the 1st Edition AD&D Sourcebook, The Wilderness Survival Guide by Kim Mohan - but has been generalized so as to be able to be used with any RPG System. For game effects as to how Weather can affect Characters you can use The Wilderness Survival Guide as a guide.

This Extension has been designed to be used with the DOE: Locations Extension in that it will take relevant data from those Place Records and copy that data into its own Weather Records - but note that you do NOT need to use the DOE: Locations Extension to use this Extension - it will work completely fine on its own, without the DOE: Locations Extension being loaded.

Each Weather Record consists of three Pages, each accessible via a Tab along the right-hand side. The 1st Page (the Main Page) contains the Weather Data; the 2nd Page (the Details Page) contains the base Time, Terrain, and Die Roll Result Data; and the last Page is a Notes Page.

In addition to the three Pages there are two Buttons along the bottom of each Record Window. The Button on the left is the Generate Today's Weather Button, while the button on the right is the Tomorrow's Weather Button. The left button when Clicked simply rolls a series of Dice and places the Die Results in the appropriate Numberfields on the Details Page, which in turn generates that day's Weather. The right button when Clicked either not only rolls the series of Dice but also creates and opens a brand new Weather Record with the Date and/or Day advanced by one, copies all of the Details from the existing Weather Record to the new one, links the two Weather Records together, modifies the existing day's Weather (if appropriate), and generates the new day's Weather; or, if the Weather Record is Locked, simply moves to the next Weather Record.

Version

1.0 - Initial Creation
2.0 - Replaced Cyclebuttons with Comboboxs; compatibility update for use with other DOE Extensions
2.4 - FGv3.2 Compatibility update
2.4.4 - FGv3.2.2 Compatibility update

Dependencies

This Extension is dependent upon the following Rulesets:

  • CoreRPG v3.2.2+

This Extension is dependent upon the following Extensions:

  • DOE: Base v2.3

Ruleset Compatibility

This Extension has been tested and works with the following Rulesets:

  • CoreRPG Ruleset v3.2.2+
  • 3.5E D&D Ruleset
  • 5E D&D Ruleset
  • 6E Call Of Cthulhu Ruleset
  • 7E Call Of Cthulhu Ruleset
  • Castles And Crusades Ruleset
  • d20 Modern Ruleset
  • Fate Core Ruleset
  • Pathfinder Ruleset
  • SavageWorlds Ruleset

This Extension has been tested and works with the following Rulesets, but requires compatible Graphics. Please contact the Author if you would like to help by providing suitable Graphics:

  • 13th Age Ruleset v3+
  • 4E D&D Ruleset
  • Barbarians Of Lemuria Ruleset
  • MoreCore Ruleset
  • Numenera Ruleset

This Extension is not required by the following Rulesets, as this functionality is already built-in:

  • DOR: Core Ruleset
  • DOR: Alternity Ruleset
  • DOR: Dragon Warriors Ruleset
  • DOR: √úbergame Ruleset

This Extension will not work with any other Ruleset. Other CoreRPG-Child Rulesets may be able to use this Extension, but the Extension will need to be tested first. Please contact the Author if you would like this Extension to be tested with an unlisted CoreRPG-Child Ruleset.

Extension Compatibilities

This Extension has been tested and works with the following Extensions:

  • DOE: Alignment Graph Extension
  • DOE: Campaign Style Graph Extension
  • DOE: Locations Extension
  • DOE: OLE Extension
  • DOE: Organisations Extension
  • DOE: Sound Extension
  • 1890s Era (CoC)
  • 5E - Language Fonts (FR) - Wizards
  • 5E - Language Fonts - Wizards
  • Blank Skills (Fate)
  • D&D Player's Handbook Desktop Decal Extension
  • Dark Ages (CoC)
  • Present Era (CoC)
  • Theme - Dungeon
  • Theme - Wood

This Extension has been tested and works with the following Extensions, but requires compatible Graphics. Please contact the Author if you would like to help by providing suitable Graphics:

  • 5E D&D Theme - Wizards

This Extension has not been tested with any other Extension, but should work with any Extension compatible with the CoreRPG Ruleset v3.2+ and any child Rulesets.

Supersedes

The following Extensions are superseded by this Extension and are no longer required:

  • None

Known Bugs

This Extension has the following known bugs:

Usage

The way that the Weather Extension was designed to be used and the best way to use the Weather Extension is as follows:

When you are starting your Campaign or Adventure, when your Players' Characters are resuming the Campaign after a significant break in time (more than a few days or so) or when the PCs move to a new Location that has different characteristics (as determined by the Details Page of a Weather Record) create a new Weather Record as you would normally create any FG Record.

Once the new Weather Record is created Drag-And-Drop the current/relevant Place from the DOE: Locations Extension to the Location area on the Main Page or, if not using that Extension, type in a suitable Location name.

Next, set the relevant details on the Details Page (ignoring the Die Result Numberfields for the moment). Note that these will be set automatically if you Dragged-And-Dropped a Location from the DOE: Locations Extension. If you manually set these details when using the DOE: Locations Extension you may generate strange and inconsistent Weather inappropriate for the Location selected.

Next, set the Current Date or the Current Day on the Main Page.

Next, Click on the Generate Today's Weather Button to generate this day's Weather.

Finally, Lock the Weather Record using the Lock Record Icon at the top-right of the Weather Record Window.

Now you are all set; simply Click on the Generate Tomorrow's Weather Button on this day's Weather Record and each subsequent Weather Record to generate the Weather for the next and subsequent days. You can generate Weather each day as the Campaign/Adventure continues or you can generate Weather several days in advance. It is suggested that you keep at least one day in advance of the actual Campaign Date so you know what's coming and so a given day's Weather correctly takes into account what the next day's Weather will be.

If the PCs move into an area with a different Terrain or Climate Zone or if they change their Altitude by more that about 300 feet (100 meters, moving up or down a building doesn't really count) then start a new "Run" of the Weather Generation System again with a brand new Weather Record.

Extension Details

General Information

All Controls and Entryfields should be self-explanatory. Notes are provided below for those that may not be.

Some Fields will be Hidden when Empty (strings) or when 0 (number).

All Text Entryfields are multi-line.

The GRAPH-T Classification System

This Extension uses a sub-set of the GRAPH-T Classification System for Worlds. GRAPH-T stands for Gravity, Radiation, Atmosphere, Pressure, Hydrosphere and Temperature, and these six physical characteristics help to define what a given World is like, and hence what that world's Weather is like. Each is rated from 0 to 5, and thus the ratings for these six characteristics form a simple 6-digit "GRAPH-T Code". The Extension uses the GRAPH-T System to help determine Hydrosphere and Temperature only.

Accessing The DOE: Weather System

The DOE: Weather System is accessed from the Menubar/Sidebar by clicking on the Small Weather Button located with the other Small Buttons.

This opens the Weather Record List Window, which consists of a List of Weather Records. In addition, there is the standard Filter Box along the bottom.</p>

Weather Record

A Weather Record consists of three Pages (detailed below), the Record Name, and the two Generate Weather Buttons.

The Name Field is a Read-Only Field whose value is generated by the DOE: Weather Extension based on the Location and the Current Date or Current Day Entryfields so as to provide a unique (or near-unique) Record Name.

Main Page

The Main Page contains the current Location, Date/Day, Sunrise & Sunset, and Weather Information.

Drag a Town, Location, World or Plane Of Existence Shortcut from the DOE: Locations Extension to the Location entry to set a Town, Location, World or Plane Of Existence Record as the Weather Record's "parent".

  • All of the relevant details from the Locations Record will be copied to the Details Page of the Weather Record.
  • The DOE: Weather Extension will "walk" the Locations Record hierarchy to gather all of the relevant details.
  • If the DOE: Weather Extension does not find a particular item of data in the DOE: Locations Extension a default value will be used.
  • Once a Locations Record has been copied if the details of that Record are changed the changes will NOT be copied to the Weather Record. Link the Locations Record to the Weather Record again or manually change the Weather Record details to match.
  • Note that manually changing the Weather Record details in one Weather Record does NOT change those details in pre-existing subsequent or previous Weather Records.
  • Instead of Dragging-And-Dropping a Locations Record simply type in some text for the Location. A Locations Record will NOT become a parent of the Weather Record if you do this.

The Use Campaign Calendar Checkbox is used to determine if the Calendar System will be used to display Dates or if a "Julian Calendar" System (where there is no Month, just the Day within the Year) will be used.

The Current Date Entryfield records the Date of the Weather Record. If set to the string "None Set" then it will be hidden when the Weather Record is Locked. Only visible if the Use Campaign Calendar Checkbox is checked. Either the Current Date Entryfield or the Current Day Numberfield MUST be set or the Weather generated will be incorrect.

The Use Current Date Button determines if a Campaign Calendar has been set and if so, places the Current Date as set in the Calendar System into the Current Date Entryfield. If there is no Campaign Calendar in use then the string "None Set" will be placed in the Current Date Entryfield. Only visible if the Use Campaign Calendar Checkbox is checked.

The Current Day Numberfield records the Day of the Year of the Weather Record. If set to 0 then it will be hidden when the Weather Record is Locked. Only visible if the Use Campaign Calendar Checkbox is unchecked. Either the Current Date Entryfield or the Current Day Numberfield MUST be set or the Weather generated will be incorrect.

The Current Year Numberfield records the Year of the Weather Record. If set to 0 then it will be hidden when the Weather Record is Locked. Only visible if the Use Campaign Calendar Checkbox is unchecked.

The Sunrise Entryfield is a Read-Only field that records the time of the Sunrise to the nearest 5 minutes. Adjusted for Day Length, Obliquity/Tilt and Date/Day of Year.

The Sunset Entryfield is a Read-Only field that records the time of the Sunrise to the nearest 5 minutes. Adjusted for Day Length, Obliquity/Tilt and Date/Day of Year.

The Temperature Numberfields show the Low and High Temperature for that Day. While these two values can be manually set, it is best to leave them alone and let the DOE: Weather Extension set them.

The Effective Temperature Entryfields are Read-Only fields showing the Effective Low and High Temperature for that Day. The Effective Temperature is the Temperature felt by the PCs once the effects of Wind Chill and/or Humidity are taken into account. They are only displayed if the Wind Chill and/or Humidity Options from the Options System are turned on and the Effective Temperature is different from the actual Temperature.

The Temperature Measure Entryfields are Read-Only fields that display the units that the Temperature and Effective Temperature are measured in. They are set via an Option in the Options System.

The Humidity Combobox has five values:

  • Dry (0%-20%)
  • Low (21%-40%)
  • Medium (41%-70%)
  • High (71%-90%)
  • Saturated (91%-100%)
  • While this value can be manually set, it is best to leave it alone and let the DOE: Weather Extension set it.

The Wind Numberfield shows the average Wind Speed for the day. While this value can be manually set, it is best to leave it alone and let the DOE: Weather Extension set it.

The Wind Direction Combobox has eight values: the eight Compass Directions. It is only displayed if the Wind Speed is greater than 0. While this value can be manually set, it is best to leave it alone and let the DOE: Weather Extension set it.

The Gusting To Speed Entryfield is a Read-Only field showing the maximum speed the Wind will gust to on that Day. It is only displayed if the Wind Speed is greater than 0.

The Wind Speed Measure Entryfields are Read-Only fields that display the units that the Wind Speed and Gusting To Speed are measured in. They are set via an Option in the Options System.

The Precipitation Combobox has six values:

  • None
  • Trace
  • Light
  • Moderate
  • Heavy
  • Downpour
  • For the purpose of this Extension:
    • Trace Precipitation is less than 1/4" (6mm) of Rain or 1/2" (12mm) of Snow
    • Light Precipitation is up to 1/2" (12mm) of Rain or 1" (2.5cm) of Snow
    • Moderate Precipitation is up to 3/4" (20mm) of Rain or 2" (5cm) of Snow
    • Heavy Precipitation is up to 1 1/2" (38mm) of Rain or 4" (10cm) of Snow
    • A Downpour is more than 1 1/2" (38mm) of Rain or 4" (10cm) of Snow
  • While this value can be manually set, it is best to leave it alone and let the DOE: Weather Extension set it.

The Precipitation Type Entryfield is a Read-Only field showing the type of Precipitation occurring throughout the day: Rain, Sleet or Snow. It is set determined by the day's Temperature. It is only displayed if the Precipitation Combobox is not "None".

The Precipitation Falling Entryfield is a Read-Only field showing the duration of the Precipitation. It is set determined by the day's Wind Speed. It is only displayed if the Precipitation Combobox is not "None".

The Special Weather Entryfield is a Read-Only field showing any Special or Unusual Weather that occurs throughout the day, such as a Cold Snap, Heat Wave, Tornado, Mist/Fog, etc. Some Special Weather lasts for days and so will be in effect on subsequent Weather Records. The DOE: Weather Extension has some quite complex logic behind it that helps determine the effects on Temperature, Humidity, Wind and Precipitation when Special Weather is occurring, but only when the Weather is not manually adjusted once set - another reason to leave determining the Weather to the DOE: Weather Extension.

Details Page

The Details Page contains all of the base information about the Location that feeds into determining the Weather.

The Calendar Entryfield records what Calendar the Weather Record uses.

The Use Campaign Calendar Button determines if a Campaign Calendar has been set and if so, places the name of the calendar into the Calendar Entryfied and the number of days in the year into the Year Length Numberfield. If there is no Campaign Calendar in use then the string "None Set" will be placed in the Calendar Entryfield.

The Year Length Numberfield is used to record the number of time periods in the Location's Year.

The Year Length Combobox has three values: Days, Hours and Minutes. It will automatically recalculate and display the correct value in the Year Length Numberfield so that the amount of time in the Year Length Numberfield remains the same.

The Day Length Numberfield records the number of time periods in the Location's Day. It is used to calculate the time of Sunrise and Sunset.

The Day Length Combobox has three values: Days, Hours and Minutes. It will automatically recalculate and display the correct value in the Day Length Numberfield so that the amount of time in the Day Length Numberfield remains the same.

The Summer Solstice Entryfield records the Day and Month of the Summer Solstice of the Northern Hemisphere of the Location. This value is used to determine the starting point of a "Weather Year". If set to the string "None Set" then it will be hidden when the Weather Record is Locked. Only visible if the Use Campaign Calendar Checkbox is checked. Either the Summer Solstice Entryfield or the Summer Solstice Numberfield MUST be set or the Weather generated will be incorrect.

The Set Summer Solstice Button determines if a Campaign Calendar has been set and if so, places the selected Day and Month from the Calendar System into the Summer Solstice Entryfied. If there is no Campaign Calendar in use then the string "None Set" will be placed in the Summer Solstice Entryfield. Only visible is the Use Campaign Calendar Checkbox is checked.

The Summer Solstice Numberfield records the Day of the Year of the Summer Solstice of the Northern Hemisphere of the Location. This value is used to determine the starting point of a "Weather Year". If set to 0 then it will be hidden when the Weather Record is Locked. Only visible if the Use Campaign Calendar Checkbox is unchecked. Either the Summer Solstice Entryfield or the Summer Solstice Numberfield MUST be set or the Weather generated will be incorrect.

The On A Plane Of Existence Checkbox is used to determine if the Location is on a Plane Of Existence. When checked certain other fields are ignored or modified when determining the Weather.

The Obliquity/Tilt of a Location's parent World is how far the World's Axis of Rotation is offset from its Orbital Axis. An Obliquity of 0 and the World spins like a top; an Obliquity of 90 and it rolls around like a ball. Obliquity is used to calculate the World's Seasons, Sunrise and Sunset. Not visible when the On A Plane Of Existence Checkbox is checked.

The Spin Direction Combobox is the direction that the Location's parent World rotates about its own axis. It has three values:

  • West-To-East (eg the Earth)
  • East-To-West
  • Does Not Spin
  • Not visible when the On A Plane Of Existence Checkbox is checked.

The Sun Movement Combobox is the direction that the Sun(s) travel across the sky on a Plane Of Existence. It has three values:

  • East-To-West (eg simulating conditions on the Earth)
  • West-To-East
  • Does Not Spin
  • Visible only when the On A Plane Of Existence Checkbox is checked.

The Temperature Combobox has the standard GRAPH-T ratings of:

  • Freezing (T0)
  • Cold (T1)
  • Cool (T2)
  • Normal (T3)
  • Hot (T4)
  • Boiling (T5)
  • The Temperature Combobox provides a global adjustment to the Daily Low and High Temperatures generated by the DOE: Weather Extension.

The Hydrosphere Combobox has the standard GRAPH-T ratings of:

  • Barren (H0)
  • Parched (H1)
  • Dry (H2)
  • Normal (H3)
  • Damp (H4)
  • Sopping (H5)
  • The Hydrosphere Combobox provides a global adjustment to the Daily Precipitation generated by the DOE: Weather Extension.

The Climate Zone Combobox has five values:

  • Arctic
  • Subarctic
  • Temperate
  • Subtropical
  • Tropical
  • For the purpose of this Extension (and the DOE: Locations Extension):
    • Arctic Climate is defined as being from 66-90 Degrees (North or South)
    • Subarctic Climate is defined as being from 51-65 Degrees
    • Temperate Climate is defined as being from 31-50 Degrees
    • Subtropical Climate is defined as being from 16-30 Degrees
    • Tropical Climate is defined as being from 0-15 Degrees
  • Each time a Climate Zone is Selected the Latitude Numberfield is set to a Default Value roughly mid-range for the Climate Zone. The Latitude Numberfield can be overridden, but each Selection of a Climate Zone will reset the Latitude Numberfield to the relevant Default Value.
  • The Climate Zone will also reduce the number of options for the Terrain Combobox when set to "Arctic" - no Forests or Forest Marshes exist in the Arctic.

The Latitude Numberfield can be set from 0 to 90. It will be overridden by the Climate Zone Combobox, so set the Climate Zone first. Not visible when the On A Plane Of Existence Checkbox is checked.

The Latitude Combobox has two values: North and South. Not visible when the On A Plane Of Existence Checkbox is checked.

The Terrain Combobox has nine values:

  • Coast/Aquatic
  • Desert
  • Forest (including Jungle
  • Hills
  • Coastal Marsh
  • Forest Marsh - eg Jungle Swamps
  • Scrub Marsh - eg Marshy Moorlands
  • Mountains
  • Plains
  • For the purpose of this Extension (and the DOE: Locations Extension):
    • Coast Marsh is considered Coast.
    • Forest Marsh is considered Forest.
    • Scrub Mash is considered Plains.
  • Also the purpose of this Extension (and the DOE: Locations Extension):
    • Coast and Desert have a Default Altitude of 0 (Feet by default).
    • Forest and Plains have a Default Altitude of 500.
    • Hills have a Default Altitude of 2,000.
    • Mountains have a Default Altitude of 4,000.
  • The Terrain Combobox will override the Altitude Numberfield with the relevant Default Value when Selected, similar to the Climate Zone Combobox.

The Altitude Numberfield has no limits. It will be overridden by the Terrain Combobox, so set the Terrain first.

The Altitude Combobox has two values: Feet and Meters. It will recalculate the value in the Altitude Numberfield for the new Units of Measure, so it is best to set this value first, before manually setting the Altitude Numberfield.

  • When this Extension is used with the DOE: WMC Extension the Altitude Combobox is replaced with the Altitude Measure Entryfield, allowing any Unit of Length to be defined and used as the Altitude Measure. See the DOE: WMC Extension Manual for more details.

The six Dice Numberfields are placeholders for the six Die values that provide the randomization for determining the Weather. They have been provided so that you can manual set the Weather if you so desire. You will need to experiment with these values to see how they work.

  • The best way to re-determine the Weather if you do make a manual change to the settings in this Extension is to change the first of these Dice Numberfields to a different value to what it currently is, then change it back to its original value. This will trigger the Weather Determination functions again. Please note that it is NOT recommended to manually modify any of the settings in the DOE: Weather Extension unless you are not using the DOE: Locations Extension and are starting a new "Weather Run".

The GM Notes Field is a FormattedText Field and will NEVER be visible to Players.

Sounds Page

The Sounds Page contains a List of Sound Links, along with a List Edit Button (GM Only).

Each Entry in the List consists of a Name, a GM Only Checkbox, a Soundlink Icon and, when the List is in Edit Mode, a Delete Item Button.

When the GM Only Checkbox is Checked the Sound Link is not displayed to the Players.

Drag and Drop Sound Links from the Sound Board of the DOE: Sound Extension to set.

Notes Page

The Notes Page contains a Formatted Text Field which will be visible to the Players (if shared).

Options

The DOE: Weather Extension adds four Options to the Options System: Include Humidity and/or Wind Chill Effects In The Temperature and settings for the Wind Speed and Temperature Measures.

Note that these Options are global - effecting ALL Weather Records within a Campaign. Also note that changing these Options once a large number of Weather Records exist will have an effect on the performance of your Computer as various values are recalculated across ALL Weather Records. It is recommended that you set these Options BEFORE creating a large number of Weather Records.

Useful Links

This Extension

Other Extensions By Dulux-Oz

Copyright Information

This Software is Copyright Peregrine I.T. Pty Ltd © 2004-2017 except where explicitly stated otherwise.

'Purple Die Over Australia' is Copyright Peregrine I.T. Pty Ltd © 2004-2017.

'Fantasy Grounds' is a trademark of SmiteWorks USA, LLC.

'Fantasy Grounds' is Copyright © 2004-2017 SmiteWorks USA LLC.

Copyright to other material within this Manual/Extension may be held by other Individuals and/or Entities. Nothing in or from this Manual/Extension in printed, electronic and/or any other form may be used, copied, transmitted or otherwise manipulated in ANY way without the explicit written consent of Matthew James BLACK or, where applicable, any and all other Copyright holders.

License Agreement

Please see the Extension Module (available from this Extension's Forum Page) for full Licensing details.

Donations

If you like this Extension and find it useful, you may like to consider making a Donation to the Author so that this Extension and similar Software can continue to be maintained and developed.

Donations can be made via PayPal to:

Thankyou.

Developer Notes

The following Notes are provided to enable other Developers to write Rulesets and Extensions which will be compatible with this one.

The Author is happy to assist fellow Developers to get their Ruleset and/or Extension working with this Extension - please contact the Author via the Fantasy Grounds Forums.

Extension Properties

This Extension includes the following Properties Tags:

<exclusiongroup>DOEWeather</exclusiongroup>
<loadorder>50</loadorder>

Return to the Extensions Page.