Overview

The following documentation will cover how you can use the Vatom CLI to create custom plugins for metaverse spaces which you can publish to the Vatom Market for sale. You are able to set your own price and earn money on every install. Plugins allow you to register new UI buttons, add panels, and create overlays.

Plugins are JavaScript files which are downloaded and run within their own sandbox. This means they have no access to the DOM or any of the normal web APIs.

All plugins inside of Vatom Spaces extend an abstract class called BasePlugin and all components extend an abstract class called BaseComponent.

Creating, publishing and updating plugins is done by using the Vatom CLI.

Why should I build plugins?

Plugins enable developers to build out their own features within the metaverse, customize the appearance of their space, integrate tools and technologies into the metaverse and to profit from their plugins being sold in the marketplace.

The Vatom platform is used by some of the largest brands in the world. These brands hold regular events in the metaverse and require plugins to customize their worlds. With thousands of client brands, over 20,000 spaces and roughly 3 million users, you have the metaverse at the tip of your fingers to be a creator for the massess and watch your code come to life.

Create a revenue stream with every plugin purchase or gain development experience using our plugin development toolkit. Join a community of developers and get started building today.

Preparation

Before you can create plugins for Spaces, please make sure you have comepleted the following:

1. Sign up with Vatom. You can do this by registering at studio.vatom.com.

2. Find your Business ID. Your Business ID is used when publishing your plugin, so you should copy the ID down for ease of use in the future. Go to Vatom Studio, click on your picture profile (top right), then Settings. You can view your Business ID under Profile.

3. Add a Developer role. To be able to test and publish your plugin in a Space, you need the Developer role on your profile. Go to Vatom Studio, click on your profile pic > Settings > Users, then click on + Add Role and choose Developer.

4. (Optional) Add your banking details. In order to receive payments, you need to configure your banking info by signing up on Stripe. This also serves as your KYC. Go to Vatom Studio, click on your profile pic > Settings > Banking Info, then click on Complete Setup.

   Note: This can be skipped if you are only going to submit free plugins to the Vatom Market.

5. (Optional) Convert an individual account to a business profile if you would like to add a business logo, add more than 1 user and manage your business account. Go to Vatom Studio, click on your profile pic > Settings > Profile, then click on Upgrade to Business Account.

   Note: This step is not required if you don't wish to customize your page in the Vatom Market.

6. Set up the Vatom CLI on your system. See the Vatom CLI docs here.

7. Login to the CLI by running vatom auth.

You are now ready to create a plugin! See Creating a Plugin to get started.