Plugin structure

A Re:Earth Visualizer Plugin is a .zip file containing two types of files: a single reearth.yml configuration file and one or more JavaScript files—one for each extension. The reearth.yml file describes the Plugin and declares its extensions, while each JavaScript file contains the logic for its extension. Together, these files are all Visualizer needs to load and run a Plugin.

reearth.yml

Every Plugin must include a file named reearth.yml at the root of the .zip. This YAML file contains Plugin metadata, including its name, version, description, and extensions.

reearth.yml

id: demo-plugin
name: Demo Plugin
version: 1.0.0
extensions:
  - id: demo-widget
    type: widget
    name: Demo Widget

Caution

The id field accepts letters (a-zA-Z), numbers (0-9), hyphens (-), and underscores (_), up to 100 characters. The value reearth is reserved and cannot be used as an ID.

For the complete list of supported fields, see the Plugin manifest schema.

Extension JavaScript

Each extension declared in reearth.yml must have a corresponding JavaScript file. The filename must match the extension id. For example, an extension with id: demo-widget requires a file named demo-widget.js.

Caution

The extension id and its JavaScript filename must match. Avoid spaces and special characters in both.

The JavaScript file contains the logic for that extension. It runs on the WebAssembly side and has full access to the globally exposed Plugin API.

demo-widget.js

reearth.ui.show(`<h1>Hello, World!</h1>`);

Note

Extension JavaScript is executed by QuickJS. Ensure your code is compatible with ECMAScript 2020.

Compose and install

Once reearth.yml and all extension JavaScript files are ready, compress them together into a single .zip file. You can install that .zip into any Re:Earth Visualizer project.

my-plugin.zip
├── reearth.yml
└── demo-widget.js

If your Plugin has more than one extension, include a JavaScript file for each one:

my-plugin.zip
├── reearth.yml
├── demo-widget.js
└── demo-infobox-block.js

Note

Plugins must be 10 MB or less. Non-JavaScript files such as images and CSS cannot be packaged inside the .zip. See Limitations for details.

For a faster development experience that avoids the cycle of building and installing the .zip, see Set up a local development environment.