PsychoticNinja/JLU5-SupyPlugins
1
0
Fork 0
mirror of https://github.com/jlu5/SupyPlugins.git synced 2025-04-28 14:01:04 -05:00
Code Issues Projects Releases Wiki Activity

Update README.

Browse Source
This commit is contained in:
spline 2013-01-02 16:34:44 -05:00
parent 2698dd8345
commit 1ec2eea5ae
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,6 +1,43 @@
Supybot-Weather
===============
Overview
This is a Supybot plugin for displaying Weather via Weather Underground (http://www.wunderground.com)
They've got a nice JSON api that is free to use when you register and grab an API key. You will need
an API key to use this plugin. Configure it via:
/msg bot config plugin.Weather.apiKey <apiKey>
I made this plugin because quite a few Weather plugins didn't work well and WunderWeather, which uses
this API, is on their older XML api that they don't have documented anymore and, one would assume, will
be depreciated at some point.
There are a ton of options to configure. You can look through these via /msg <bot> config search Weather
Many of these are also available via --options when calling the wunderground command.
I suggest adding an alias to this command to make it easier.
/msg bot Alias add weather wunderground
Another feature that will make you and your users happy is an internal database that can remember your
location and setting for metric. I've seen this before with another bot and wanted to implement this.
Basically, instead of having to type wunderground 10152 (or wherever you are), you can just type in
wunderground. This can be done via setting a location with the setweather command.
/msg <bot> setweather 10152
/msg <bot> setmetric False (to use imperial units)
The bot's db is very simple and only remembers a nick and setting. So, if you change nicks, it will not
remember you unless you set it on this new nick.
Use:
/msg <bot> getweather
/msg <bot> getmetric
To check settings here. This is optional but a neat feature. This only works if you don't give it an input.
So, if you /msg bot wunderground --metric, it will display the weather you set in setweather but in --metric.
Options
This plugin has a bit of configuration that can be done with it. We'll start with the basics: