Skip to content

Commit

Permalink
Merge pull request #7 from Mudpuppy12/master
Browse files Browse the repository at this point in the history
Documentation updates
  • Loading branch information
lynnfaraday authored Sep 24, 2019
2 parents c63c4da + be2e837 commit 3693501
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions plugins/openweather/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,26 @@ in game do
ruby Openweather.current_weather
</pre> This should give all the variables the API got for the area and will help in debugging.

# Oddities.
Seasons and time of day (ie, it's day or night) are not provided by Openweather. These come from the ICTime plugin in base AresMUSH. The base ICTime module does not have timezones, but there are code hooks where you can differentiate ICTime by area if you add custom code.
# Oddities and wierdness
* Seasons and time of day (ie, it's day or night) are not provided by Openweather. These come from the ICTime plugin in base AresMUSH. The base ICTime module does not have timezones, but there are code hooks where you can differentiate ICTime by area if you add custom code.
* Openweather makes the API call in the background, so inital startup may take
a second or two to populate the data.

# Customizations
Feel free to change the descriptions in the openweather.yml file, and or
language in the ~/aresmush/plugins/openweather/locales/locale_en.yml

# Common Gotchas
* Make sure when adding the API key that it is on one line (no dashes) and falls
under the secrets subkey.

<pre>
secrets:
openweather_api_key: your_api_key
</pre>

* If you need to make a change or fix in the config files do an **openweather/reset**. That will force a weather update using the new configs.

# Author
Dennis De Marco ([email protected])/Fenris@SpirtLakeMU
# Reference Links
Expand Down
2 changes: 1 addition & 1 deletion plugins/openweather/game/config/openweather.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ openweather:
Offstage: none
Polar:
coords:
lon: 40.92
lat: -74.7
lon: 40.92
Vegas:
zip: 89109

Expand Down

0 comments on commit 3693501

Please sign in to comment.