JLU5-SupyPlugins/Weather/README.md

Limnoria plugin for Weather Underground

Installation

1. Download the plugin, either via Git or Limnoria's PluginDownloader (install GLolol Weather).

2. Load the plugin:

/msg bot load Weather

3. Fetch an API key from Wunderground by signing up (free). Once you get this key, you will need to set it up on your bot:

/msg <yourbot> config plugins.Weather.apiKey <APIKEY>

Usage

When calling the weather command, you can provide locations in one of many forms:

• City names (e.g. Vancouver)
• U.S. ZIP codes (e.g. 10002)
• Canadian, U.K. postal codes (e.g. V6C 3T4)
• City, country pairs (e.g. "Sydney, Australia", "Paris, France")
• City, state/province pairs (e.g. "Washington, D.C.", "Kitchener, Ontario")
• ICAO airport codes (e.g. KJFK)

Example:

<GLolol> @weather 10002
<Atlas> New York, NY :: Mostly Cloudy :: 55F/12C (Humidity: 53%) | Monday: Mostly cloudy. Low 11C. Monday Night: Cloudy. Slight chance of a rain shower. Low 11C. Winds ENE at 10 to 15 km/h.

Saving locations

Users can also have their location remembered by the bot so that they don't have to continually type in their location.

<GLolol> @setweather 10002
<Atlas> Done.

This allows a user to use the weather command without any arguments:

<GLolol> @weather
<Atlas> New York, NY :: Clear :: 64F/17C | Wind: N@7kph | Thursday: Clear. Low 14C. Thursday Night: A clear sky. Low 14C. Winds SSE at 10 to 15 km/h.

User options

Users can also have the bot remember their preferred options, such as using metric units when displaying forecasts:

<GLolol> @setuser metric True
<Atlas> Done.