Skip to content

Home

Jump to bottom
Jack edited this page Mar 8, 2023 · 9 revisions

Installation Instructions

If you need any help installing RealTimeWeather, or are looking for more information, you're in the right place!

Compatibility

RealTimeWeather uses the Bukkit API for version 1.13. 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 server for better speed, support, and stability.

Downloading RealTimeWeather

You can download RealTimeWeather from Modrinth or from a GitHub release. Download the .jar file of the latest version. You can use older versions if you wish, but I will not provide support for them.

Once you've downloaded the .jar file, put it in your server's plugin directory. If you're using a hosting provider, they should have instructions on how to add plugins to your server. If you're hosting your own server, I'm going to assume that you know how to upload files to it.

Setup

Generating the configuration file

Setting up RealTimeWeather is simple. Once you've followed the previous instructions, run your server. RealTimeWeather will start and generate its configuration file. You can find it in the folder named RealTimeWeather in your server's plugin directory. After you see that RealTimeWeather has started successfully, stop your server.

Editing the configuration file

Currently, RealTimeWeather does not support per-world settings. RealTimeWeather will apply these configuration settings to every world on your server. Support for per-world settings will be coming soon.

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.

Note: All interval values are in ticks. You can find a useful tick calculator here.
Note: All values that are surrounded by '' must stay surrounded by them.

Time Sync Settings

  • SyncTime (default: false)
    Set this to true to enable time syncing. Make sure that you choose a timezone after enabling this.
  • 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') Enter the time zone that you'd like to sync with here. You can find a list of timezone names here.

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) 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') Put your OpenWeather API key here. There are instructions on how to get an API key below. Keep your API 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.

Debug

  • Debug (default: false) Setting this to true will provide more logs from RealTimeWeather. This is useful for diagnosing problems.

Getting an OpenWeather API key

To use the weather sync feature, you will 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.

After generating an API key, it may take a bit for it to start working. Please wait an hour before asking for help if RealTimeWeather says that your API key is correct.

To get an API key, go to openweathermap.org and create an account by clicking Sign In in the upper right corner and then clicking Create an Account..

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'll need to purchase a plan from OpenWeatherMap here.

Troubleshooting

If you're having any issues, try out the troubleshooting steps below before asking for help.

API key incorrect error

This error could be caused by multiple things.

The simplest solution to this problem is that you did copy and/or past 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 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:

{"zip":"34134","name":"Kassel","lat":51.2878,"lon":9.4705,"country":"DE"}

and RealTimeWeather still gives you the same error, open an issue here. If you get a response like:

{"cod":401, "message": "Invalid API key. Please see https://openweathermap.org/faq#error401 for more info."}

then you need to keep waiting. If you've waited for more than an hour and nothing has changed, try generating another API key or contacting OpenWeatherMap support.

Clone this wiki locally