GodotNWS brings real U.S. weather data directly into your Godot 4 projects. Once installed and enabled, the plugin registers an autoload singleton calledDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/OdintheDoggo/GodotNWS/llms.txt
Use this file to discover all available pages before exploring further.
Nws that you can call from anywhere in your scene tree. Set a location once, then fetch forecasts, current conditions, active alerts, radar GIFs, and more — all delivered asynchronously through Godot signals.
Installation
Add GodotNWS to your project and enable the plugin in the Godot editor.
Quickstart
Set up a location and display a live weather forecast in under five minutes.
API Reference
Full reference for every method, signal, and data class in the
Nws singleton.Guides
Step-by-step walkthroughs for forecasts, observations, alerts, and imagery.
How It Works
GodotNWS wraps the free api.weather.gov REST API. No API key or account is required. Every fetch call spawns an internalHTTPRequest node, makes the network call, and emits a typed signal when the response arrives. Your code connects to those signals and handles the data.
Install the plugin
Copy the
addons/GodotNws folder into your project’s addons/ directory and enable GodotNWS in Project → Project Settings → Plugins.Set your location
Call
Nws.setup(latitude, longitude) with a U.S. coordinate pair, or call Nws.setup_ip() to auto-detect location from the device’s IP address. Wait for the location_setup_complete signal before fetching data.Fetch weather data
Call any fetch method —
Nws.fetch_forecast(false), Nws.fetch_current_observations(false), Nws.fetch_alerts(), and more. Each method emits its own signal when data is ready.What You Can Fetch
Forecasts
Daily and hourly forecasts with temperature, wind, precipitation chance, and optional weather icons.
Observations
Current conditions at the nearest station: temperature, dewpoint, wind, pressure, humidity, and more.
Alerts
Active NWS alerts for your area with severity, urgency, and full descriptive text.
Radar & Imagery
Animated radar GIFs, graphicast images, forecast charts, the U.S. warning map, and drought monitor.
GodotNWS only covers locations within the United States and its territories — the NWS API does not provide data for international locations.