Skip to main content

Setup the Project

To streamline project setup we're going to use the hello world tutorial as a base.

Either complete that project or download the source code from GitHub.

Rename the project to folder custom-tool and open the folder in a code editor.

Edit the Manifest​

Our custom tool won't use a visible action. Instead it will use a background site that will handle the communication with Owlbear Rodeo.

Edit the manifest in the public folder.

public/manifest.json
{
  "name": "Custom Tool",
  "version": "1.0.0",
  "manifest_version": 1,
  "background_url": "/"
}

Run the Project​

To run the project open a terminal and run:

$ npm install
$ npm run dev

Now install your extension in Owlbear Rodeo by following these steps.