Overview
Open Portal Schema is a set of json properties that together allow you to specify how portals look and behave.
Properties are grouped into 7 categories: basic, presentation, destination, interaction, assets, policy and custom. The complete list of properties are available in the full documentation of Open Portal Schema.
Each category plays a different role in Open Portal Schema:
Basic properties
Basic properties are core properties that are universal for all portals. They provide key information to both users (e.g. title and description) and the portal-hosting environment (version of Open Portal Schema used).
Presentation properties
Presentation properties allow developers to specify how the portal should be presented to the user both visually and audibly. Developers can define as many media options as they like, and the client device and client environment in turn decide the best option(s) to present the portal to the user, based on available hardware and software to optimize the user experience.
Destination properties
Destination properties enable developers to specify the teleportation destination, whether it is an HTTP link, a deeplink, or virtual world information.
Interaction properties
Interaction properties serve as user interaction event handlers. They define responses to user interaction events occurring at or near the portal, such as swipe gestures, as well as voice and chat interactions.
Assets properties
Assets properties allow developers to declare which digital assets, avatars and asset sources their worlds can accept.
Policy properties
Policy properties enable developers to declare policies applicable to their worlds, such as which web3 identity systems are integrated and also any entrance fee levied upon users teleporting into their worlds.
Custom properties
Custom properties are developer-defined properties. They can be used for purposes like analytics, traffic analysis and other reasons developers see fit.
To increase feature set and expressiveness for power developers while preserving friendliness for casual creators, many properties are optional and need not be defined. So, portals are designed to be both flexible and powerful: they can be created rapidly in a minimalistic fashion or crafted meticulously to leverage various features of Open Portal Schema. See examples of portals in the next section.