minster586/RealTimeWeather
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 8 Wiki Activity

update configuration file instructions with latitude/longitude and command blocking

Jack
2023-04-22 21:33:18 -04:00
parent 846ba6a219
commit 06c6d7af25
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Home.md

@@ -29,23 +29,26 @@ By default, all of RealTimeWeather's features will be disabled. There are commen
**Time Sync Settings**
- `SyncTime` (default: `false`)
Set this to `true` to enable time syncing. **Make sure that you choose a timezone after enabling this**.
- `BlockTimeSetCommand` (default: `true`)
By default, RealTimeWeather will prevent users from using the `/time set` command if `SyncTime` is set to `true`. You can set this to false to re-enable the command.
- `TimeSyncInterval` (default: `100`)
This configuration option allows you to change how often RealTimeWeather updates your server's time. You don't have to change this.
- `Timezone` (default: `'America/New_York'`)
- `Timezone` (default: `'America/New_York'`)
Enter the time zone that you'd like to sync with here. You can find a list of timezone names [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
**Weather Sync Settings**
- `SyncWeather` (default: `false`)
Set this to `true` to enable weather syncing. **Make sure that you set the options below after enabling this**.
- `WeatherSyncInterval` (default: `6000`)
- `BlockWeatherCommand` (default: `true`)
By default, RealTimeWeather will prevent users from using the `/weather` command if `SyncWeather` is set to `true`. You can set this to false to re-enable the command.
- `WeatherSyncInterval` (default: `6000`)
This configuration option changes how often RealTimeWeather will get weather information from OpenWeather and update your server's weather.
**Setting this below 2400 will cause problems**.
- `APIKey` (default: `'API_KEY'`)
- `APIKey` (default: `'API_KEY'`)
Put your OpenWeather API key here. There are instructions on how to get an API key [below](https://github.com/Jack1424/RealTimeWeather/wiki#getting-an-openweather-api-key). **Keep your API key a secret**.
- `ZipCode` (default: `10001`)
Put the zip code of the location that you want to sync your server's weather with here.
- `CountryCode` (default: `US`)
Put the **two letter** country code of the location that you want to sync your server's weather with here. You can find a list of country codes [here](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes).
- `Latitude` (default: `'0'`)
- `Longitude` (default: `'0'`)
Put the latitude and longitude of the location that you want to sync your server's weather with here. You can find the latitude and longitude of a location at [https://www.latlong.net/](https://www.latlong.net/).
**Debug**
- `Debug` (default: `false`)