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

add v1.4.0 changes and some tiny changes

Jack
2024-07-23 18:05:52 -04:00
parent 63e9db1782
commit 520cb25dcc
1 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Home.md

@@ -1,10 +1,10 @@
![header image](https://raw.githubusercontent.com/Jack1424/RealTimeWeather/master/media/4SplitSingleLineCloseColors.png)
# Installation Instructions
If you need any help installing RealTimeWeather, or are looking for more information, you're in the right place!
If you need help installing RealTimeWeather or want more information, you're in the right place!
## Compatibility
RealTimeWeather uses the version 1.13 Bukkit API. This allows it to support servers running versions all the way back to 1.7. It can run on any servers that use the Bukkit API or any of its forks, but I highly recommend using a [Paper](https://papermc.io/) server for better speed, support, and stability.
RealTimeWeather uses the 1.13 Bukkit API, which allows it to support servers running versions back to 1.7. It can run on any server that uses the Bukkit API or any of its forks, but I highly recommend using a [Paper](https://papermc.io/) server for better speed, support, and stability.
## Downloading RealTimeWeather
You can download RealTimeWeather from [Modrinth](https://modrinth.com/plugin/realtimeweather/versions), [Hangar](https://hangar.papermc.io/Jack1424/RealTimeWeather/versions), or from a [GitHub release](https://github.com/Jack1424/RealTimeWeather/releases). Download the latest version of the .jar file. You can use older versions if you want, but I will not provide support for them.
@@ -21,14 +21,24 @@ Setting up RealTimeWeather is simple. Once you've followed the previous instruct
Currently, RealTimeWeather does not support per-world settings. RealTimeWeather will apply these configuration settings to every world on your server. Per-world settings should be added in the future.
By default, all of RealTimeWeather's features will be disabled. There are comments in the configuration file that explain what each option does, but I'll provide more detailed explanations below if you need them.
By default, all of RealTimeWeather's features are disabled. The configuration file contains comments explaining each option, but I'll provide more detailed explanations below if you need them.
**Note:** All interval values are in ticks. You can find a tick calculator [here](https://mapmaking.fr/tick/).
**Note:** All values that are surrounded by `''` must stay surrounded by them.
**RealTimeWeather Settings**
- `UpdateCheckInterval` (default: `1734000`)
This sets how often RealTimeWeather will check for updates. Set this to `0` to disable update checks.
- `Debug` (default: `false`)
Setting this to `true` will provide more messages from RealTimeWeather in the console. This is useful for diagnosing problems.
**Time Sync Settings**
- `SyncTime` (default: `false`)
Set this to `true` to enable time syncing. **Make sure that you choose a timezone after enabling this.** If this is set to 'false', all settings in the time section will be ignored.
- `TimeSyncAllWorlds` (default: `true`)
By default, RealTimeWeather will sync the time in every world on your server (except nether and end worlds). Set this to `false` to specify which worlds you want to sync the time in below.
- `TimeSyncWorlds` (default: ` - world`)
If you set `TimeSyncAllWorlds` to `false`, list the worlds that you want to sync the time in here. End and nether worlds will be skipped even if they are listed here.
- `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 (not recommended).
- `DisableBedsAtNight` (default: `true`)
@@ -51,6 +61,10 @@ If you set `SunriseSunset` to `custom`, put the sunrise/sunset times that you wa
**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**. If this is set to 'false', all settings in the time section will be ignored.
- `WeatherSyncAllWorlds` (default: `true`)
By default, RealTimeWeather will sync the weather in every world on your server (except nether and end worlds). Set this to `false` to specify which worlds you want to sync the weather in below.
- `WeatherSyncWorlds` (default: ` - world`)
If you set `WeatherSyncAllWorlds` to `false`, list the worlds that you want to sync the weather in here. End and nether worlds will be skipped even if they are listed here.
- `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.
- `DisableBedsDuringThunder` (default: `true`)
@@ -66,10 +80,6 @@ Put your OpenWeather API key here. There are instructions on how to get an API k
- `WeatherLongitude` (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`)
Setting this to `true` will provide more messages from RealTimeWeather in the console. This is useful for diagnosing problems.
### Getting an OpenWeather API key
To use the weather sync feature, you need to get an API key from OpenWeatherMap. Each person should have their own API key. Do not share your API key with anyone or use anyone else's API key.
@@ -79,7 +89,7 @@ To get an API key, go to [openweathermap.org](https://openweathermap.org) and cr
Once you've made an account, click on your account name in the upper right corner (where the `Sign In` button was) and then click on `My API keys`. Under the `Create key` section on the right side of the page, type in a name for your API key (it can be anything) and then click `Generate`. Wait a few seconds, and your API key will appear on the left (it's the long jumble of letters and numbers).
**NOTE:** OpenWeatherMap has a limit of 60 weather syncs per minute. If you're planning on running multiple servers or syncing the weather more often, you might need to either raise the value of `WeatherSyncInterval` or purchase a plan from OpenWeatherMap [here](https://home.openweathermap.org/subscriptions).
**NOTE:** OpenWeatherMap has a limit of 60 weather syncs per minute. If you plan on running multiple servers or syncing the weather more often, you might need to increase the value of `WeatherSyncInterval` or purchase a plan from OpenWeatherMap [here](https://home.openweathermap.org/subscriptions).
# Troubleshooting
If you're having any issues, try out the troubleshooting steps below before asking for help.
@@ -89,7 +99,7 @@ This error could be caused by multiple things.
The simplest solution to this problem is that you copied and/or pasted the API key incorrectly. Ensure that you copy your entire API key from OpenWeatherMap and that it's the only thing in between the `' '` in your configuration file.
If you've made sure that the API key in your configuration file was copied correctly, and your issue still continues, you may need to wait up to an hour for your API to become active. Usually, this process should only take a few minutes at most, but it can take longer. Continue checking your API key for at least an hour.
If you've made sure that the API key in your configuration file was copied correctly and your issue still continues, you may need to wait up to an hour for your API to become active. This process should only take a few minutes at most, but it can take longer. Continue checking your API key for at least an hour.
If you want an easier way to check if your API key is correct, try pasting `https://api.openweathermap.org/geo/1.0/zip?zip=34134,DE&appid=[YOUR_API_KEY]` into your internet browser **(make sure that you replace `[YOUR_API_KEY]`, including the `[ ]`, with your API key**. If you get a response like: