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

NuWeather: update backends in README

Browse Source
This commit is contained in:
James Lu 2022-06-19 15:31:49 -07:00
parent 388e13acc5
commit 4ebcfb1e5a
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
NuWeather/README.md
View File

@ -4,8 +4,9 @@ A weather plugin for Limnoria. It supports multiple weather and geocoding backen
#### Weather Backends #### Weather Backends
- [OpenWeatherMap](https://openweathermap.org/) (default, API key required) - [OpenWeatherMap](https://openweathermap.org/) (default, API key required)
- [weatherstack](https://weatherstack.com/), formerly Apixu (current conditions only, API key required) - [WWIS](https://worldweather.wmo.int/) (**no** API key required, major cities only)
- [Dark Sky](https://darksky.net) (API key required, but new signups are no longer accepted) - [weatherstack](https://weatherstack.com/) (current conditions only, API key required)
- [Dark Sky](https://darksky.net) (**DEPRECATED**: API key required; new signups closed)
#### Geocoding Backends #### Geocoding Backends
- [OpenStreetMap Nominatim](https://nominatim.openstreetmap.org/) (default, no API key required) - [OpenStreetMap Nominatim](https://nominatim.openstreetmap.org/) (default, no API key required)
@ -18,6 +19,8 @@ A weather plugin for Limnoria. It supports multiple weather and geocoding backen
2) Grab an API key. [OpenWeatherMap](https://openweathermap.org/appid) | [weatherstack](https://weatherstack.com/) | ~~[Dark Sky](https://darksky.net/dev)~~ (new signups no longer accepted) 2) Grab an API key. [OpenWeatherMap](https://openweathermap.org/appid) | [weatherstack](https://weatherstack.com/) | ~~[Dark Sky](https://darksky.net/dev)~~ (new signups no longer accepted)
- WWIS is another option that requires no API key, but is limited (in most countries) to major cities
3) Configure it: `/msg yourbot config plugins.NuWeather.apikeys.BACKENDNAME YOUR-API-KEY` 3) Configure it: `/msg yourbot config plugins.NuWeather.apikeys.BACKENDNAME YOUR-API-KEY`
4) Set your default weather location: `setweather <your-preferred-location>` 4) Set your default weather location: `setweather <your-preferred-location>`
@ -58,16 +61,18 @@ config plugins.NuWeather.DBAddressingMode nicks
5) Load the plugin again for these changes to take effect. 5) Load the plugin again for these changes to take effect.
(If you're comfortable with re-creating your database from scratch, the other options tell NuWeather to save location by Supybot account (the default) or ident@host.) (If you're comfortable with re-creating your database from scratch, the other options tell NuWeather to save location by Limnoria account (the default) or ident@host.)
## Location lookup (Geocoding) backends ## Location lookup (Geocoding) backends
* weatherstack provides weather lookup by place name directly, and does not need further configuration. * weatherstack provides weather lookup by place name directly, and does not need further configuration.
* Dark Sky and OpenStreetMap backends use a separate service to translate place names into GPS coordinates, a process known as **geocoding**. * OpenStreetMap, WWIS, and Dark Sky backends use a separate service to translate place names into GPS coordinates, a process known as **geocoding**.
The default geocoding backend is [OpenStreetMap's Nominatim](https://nominatim.openstreetmap.org/); this can be configured via the `plugins.NuWeather.geocodeBackend` option. The default geocoding backend is [OpenStreetMap's Nominatim](https://nominatim.openstreetmap.org/); this can be configured via the `plugins.NuWeather.geocodeBackend` option.
Other options include [Google Maps](https://developers.google.com/maps/documentation/geocoding/start) and [OpenCage](https://opencagedata.com/). Other options include [Google Maps](https://developers.google.com/maps/documentation/geocoding/start) and [OpenCage](https://opencagedata.com/).
These may provide more relevant results for North America (e.g. US ZIP codes), but both require API keys: [Google Maps](https://developers.google.com/maps/documentation/geocoding/get-api-key) (credit card required) | [OpenCage](https://opencagedata.com/api) These may provide more relevant results for North America (e.g. US ZIP codes), but both require API keys:
API keys for geocoding backends are configured as `plugins.NuWeather.apikeys.BACKENDNAME`. - [Google Maps](https://developers.google.com/maps/documentation/geocoding/get-api-key) (requires credit card billing) | [OpenCage](https://opencagedata.com/api)
API keys for geocoding backends are similarly configured as `plugins.NuWeather.apikeys.BACKENDNAME`.