Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 1.55 KB

README.md

File metadata and controls

44 lines (26 loc) · 1.55 KB
Raw

compressed-pointcloud

Support displaying compressed pointcloud types in Foxglove Studio. See https://github.com/ros-perception/point_cloud_transport.

A Foxglove Studio Extension

Foxglove Studio allows developers to create extensions, or custom code that is loaded and executed inside the Foxglove Studio application. This can be used to add custom panels. Extensions are authored in TypeScript using the @foxglove/studio SDK.

Develop

Extension development uses the npm package manager to install development dependencies and run build scripts.

To install extension dependencies, run npm from the root of the extension package.

npm install

To build and install the extension into your local Foxglove Studio desktop app, run:

npm run local-install

Open the Foxglove Studio desktop (or ctrl-R to refresh if it is already open). Your extension is installed and available within the app.

Package

Extensions are packaged into .foxe files. These files contain the metadata (package.json) and the build code for the extension.

Before packaging, make sure to set name, publisher, version, and description fields in package.json. When ready to distribute the extension, run:

npm run package

This command will package the extension into a .foxe file in the local directory.

Publish

You can publish the extension for the public marketplace or privately for your organization.

See documentation here: https://foxglove.dev/docs/studio/extensions/publish#packaging-your-extension