Skip to main content

Documentation 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.

Installing GodotNWS is a straightforward process that mirrors how any Godot 4 editor plugin is added to a project. You copy a folder, flip a toggle in Project Settings, and the global Nws singleton becomes available everywhere in your codebase. No package manager, no external dependencies, and no API key registration is required — the U.S. National Weather Service API is free and open.
1

Download the plugin from GitHub

Visit the GodotNWS repository and download the source. You can either:
  • Click Code → Download ZIP and extract it, or
  • Clone the repository with Git:
git clone https://github.com/OdintheDoggo/GodotNWS.git
The file you need is the addons/GodotNws/ folder found at the root of the downloaded or cloned repository.
2

Copy the plugin folder into your project

Inside your Godot project’s root directory, create an addons/ folder if one does not already exist. Then copy the entire GodotNws folder into it so that the final structure looks like this:
your_project/
└── addons/
    └── GodotNws/
        ├── plugin.cfg
        ├── NWS.gd
        ├── NwsSingleton.gd
        ├── forecastperiod.gd
        ├── hourlyforecastperiod.gd
        ├── observations.gd
        ├── alert.gd
        └── weatherstory.gd
Do not rename the folder — Godot locates the plugin by the path declared inside plugin.cfg.
3

Enable the plugin in the Godot editor

Open your project in the Godot editor, then navigate to:Project → Project Settings → PluginsFind GodotNWS in the plugin list and toggle the Enable checkbox. The status column will change to Active.If the plugin does not appear, verify that addons/GodotNws/plugin.cfg exists and that Godot has finished scanning the filesystem (try Project → Reload Current Project if needed).
4

Verify the Nws autoload is registered

After enabling the plugin, navigate to:Project → Project Settings → AutoloadYou should see an entry named Nws pointing to res://addons/godotnws/NwsSingleton.gd. This confirms the singleton was registered successfully.In any script, you can also verify at runtime:
func _ready() -> void:
    # SetUp is false until setup() or setup_ip() is called
    print(Nws.SetUp)  # prints false

​
How the Autoload Is Registered

When you enable GodotNWS, the editor plugin’s _enable_plugin() method in NWS.gd calls: 
add_autoload_singleton("Nws", "res://addons/godotnws/NwsSingleton.gd")
Note that the autoload path uses an all-lowercase godotnws directory name. The folder on disk is named GodotNws (capital G, lowercase nws), but the path registered in the autoload uses godotnws (all lowercase). Godot’s filesystem is case-insensitive on Windows but case-sensitive on Linux and macOS — the plugin handles this internally, so no manual adjustment is needed as long as you have not renamed the folder. This is why Nws appears globally without any additional setup on your part. Godot adds it to the autoload list and instantiates it before any of your scenes load, making it available from the very first _ready() call in your project.
GodotNWS requires Godot 4.1 or later. The plugin uses typed array signals and HTTPRequest features that are not available in Godot 3.x or early Godot 4.0 builds. Using an older version of the engine will produce errors on startup.
Disabling the plugin is equally clean. When you toggle GodotNWS off in Project Settings, the editor plugin’s _disable_plugin() method calls remove_autoload_singleton("Nws"), which removes the entry from your autoload list automatically. No manual cleanup is needed.
With the plugin installed and enabled, you’re ready to configure a location and start fetching weather data. Continue to the Quickstart guide to see a working example in under five minutes.

Build docs developers (and LLMs) love

Get started for freeTalk to us