Skip to main content

Weather

The Weather module retrieves current weather conditions for a specified location using WeatherAPI.com and exposes them to the ChatBox animation system and avatar parameters.

Features

  • Real-time weather data powered by WeatherAPI.com
  • Temperature in Celsius and Fahrenheit
  • Humidity and weather condition information
  • Weather condition codes for avatar integration

Configuration

Location Setting

Enter a location in the module settings. WeatherAPI.com supports a wide range of formats:

  • City names: London, New York, Tokyo
  • City and country: Paris, France (recommended for accuracy)
  • Postcodes / ZIP codes: 10001, SW1A 1AA
  • Coordinates: 51.5074,-0.1278
  • IP lookup: auto:ip
  • Airport codes: JFK, LHR

For best results, use the City, Country format (for example, Leeds, UK) to avoid ambiguity.

Available Variables

The Weather module exposes the following variables to the ChatBox animation system:

VariableTypeDescription
TempCNumberCurrent temperature in Celsius
TempFNumberCurrent temperature in Fahrenheit
HumidityNumberRelative humidity percentage (0-100)
ConditionStringHuman-readable weather condition (for example, Sunny or Light rain)

Avatar Parameters

The Weather module can send data to your avatar through VRChat OSC parameters:

Parameter NameTypeDescription
VRCOSC/Weather/CodeintCurrent weather condition code (0-48)

Weather Codes

The Weather module provides a weather condition code through VRCOSC/Weather/Code. These values are based on WeatherAPI.com's condition codes, but remapped into a simplified 0-48 range.

You can use these codes to drive avatar behaviour, such as:

  • Switching outfits for rain or snow
  • Triggering weather-themed animations
  • Enabling seasonal visual effects
  • Reacting dynamically to current conditions

Code Reference

CodeConditionCodeCondition
0Unknown25Light freezing rain
1Sunny/Clear26Moderate or heavy freezing rain
2Partly Cloudy27Light sleet
3Cloudy28Moderate or heavy sleet
4Overcast29Patchy light snow
5Mist30Light snow
6Patchy rain possible31Patchy moderate snow
7Patchy snow possible32Moderate snow
8Patchy sleet possible33Patchy heavy snow
9Patchy freezing drizzle possible34Heavy snow
10Thundery outbreaks possible35Ice pellets
11Blowing snow36Light rain shower
12Blizzard37Moderate or heavy rain shower
13Fog38Torrential rain shower
14Freezing fog39Light sleet showers
15Patchy light drizzle40Moderate or heavy sleet showers
16Light drizzle41Light snow showers
17Freezing drizzle42Moderate or heavy snow showers
18Heavy freezing drizzle43Light showers of ice pellets
19Patchy light rain44Moderate or heavy showers of ice pellets
20Light rain45Patchy light rain with thunder
21Moderate rain at times46Moderate or heavy rain with thunder
22Moderate rain47Patchy light snow with thunder
23Heavy rain at times48Moderate or heavy snow with thunder
24Heavy rain

Example Usage

Code RangeSuggested Avatar Response
1-4Default or clear-weather outfit
6, 19-24, 36-38Rain gear or umbrella
7, 29-34, 41-42Winter clothing
10, 45-48Storm or lightning effects

Day and Night Conditions

Some conditions use different text descriptions during the day and night. For example, Sunny may become Clear at night. The weather code itself does not change.

ChatBox States

The Weather module provides the following state:

  • Default: Active when weather data is available

Use this state in the ChatBox animation system to control when weather information is displayed.

Troubleshooting

Weather data not loading

  • Verify the configured location is valid
  • Try the City, Country format
  • Check your internet connection
  • Ensure WeatherAPI.com is accessible from your network

Weather code shows as 0

A value of 0 means the weather service could not determine the current condition.

  • Wait for the next automatic update
  • Restart the Weather module
  • Verify the configured location exists in WeatherAPI.com's database

Location not found

  • Double-check for typos
  • Use the City, Country format
  • Try coordinates if the location name is ambiguous

Sunrise or sunset times seem incorrect

  • Verify the configured location is accurate
  • Coordinates provide the most precise results

API Information

This module uses the free tier of WeatherAPI.com to provide:

  • Current weather conditions
  • Astronomy data (sunrise and sunset)
  • Weather condition codes

For additional information, see the WeatherAPI.com documentation.