PsychoticNinja/JLU5-SupyPlugins
1
0
Fork 0
mirror of https://github.com/jlu5/SupyPlugins.git synced 2025-05-06 11:33:41 -05:00
Code Issues Projects Releases Wiki Activity

Weather: README updates

Browse Source 
Some of the plugin's output syntax has changed, along with the 'wunderground' command being renamed to 'weather'.
This commit is contained in:
James Lu 2015-05-07 17:58:30 -07:00
parent 90bc8ef01d
commit 1f12245f05
1 changed files with 12 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,15 +1,14 @@
[![Build Status](https://travis-ci.org/GLolol/Supybot-Weather.svg?branch=master)](https://travis-ci.org/GLolol/Supybot-Weather)
# Limnoria plugin for Weather Underground (GLolol's fork)
# Limnoria plugin for Weather Underground
## Installation
You will need a working Limnoria bot on Python 2.7/3.2+ for this to work.
1) Go into your Limnoria plugin dir, usually `~/supybot/plugins` and run:
1) Go into your Limnoria plugin dir (usually `~/limnoria/plugins`), and run:
```
git clone https://github.com/GLolol/Supybot-Weather
git clone https://github.com/GLolol/Supybot-Weather Weather
```
Alternatively, you can fetch this plugin (albeit a slightly older version) via Limnoria's PluginDownloader using: `install GLolol Weather`.
@ -23,25 +22,18 @@ Alternatively, you can fetch this plugin (albeit a slightly older version) via L
3) [Fetch an API key from Wunderground](http://www.wunderground.com/weather/api/) by signing up (free).
Once getting this key, you will need to set it on your bot before things will work.
```
/msg <yourbot> config plugins.Weather.apiKey <APIKEY>
```
4) *Optional:* There are some config variables that can be set for the bot. They mainly control output stuff.
```
/msg bot config search Weather
```
## Example Usage
When calling the `wunderground` command, you can use zip codes (10002), cities (New York, NY), etc. Weather Underground is pretty
When calling the `weather` command, you can use zip codes (10002), cities (New York, NY), etc. Weather Underground is pretty
intelligent here.
```
<spline> @wunderground 10002
<myybot> New York, NY :: Rain :: 52F | Visibility: 4.0mi | Saturday: Rain. High around 55F...
<GLolol> @weather 10002
<Atlas> New York, NY :: Rain :: 52F | Visibility: 4.0mi | Saturday: Rain. High around 55F...
```
## Features
@ -56,20 +48,20 @@ Users can also have their location remembered by the plugin's internal database
they will not have to continually type in their location.
```
<spline> @setweather 10002
<myybot> I have changed spline's weather ID to 10002
<GLolol> @setweather 10002
<Atlas> Done.
```
This now allows a user to type in the weather command w/o any arguments:
```
<spline> @wunderground
<myybot> Manchester, NH :: Rain :: 45F | Visibility: 10.0mi | Saturday: Occasional light rain. High 56F. ...
<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.
```
Users can also have the bot remember their preferred options, such as using metric units when displaying weather:
```
<spline> @setuser metric False
<myybot> I have changed spline's metric setting to 0
<GLolol> @setuser metric False
<Atlas> Done.
```