Customized API Script

Do you need a ‘Customized’ API Script?

• No, if your product only communicates with Obsidian devices owned by the same user, for example, a HUD that controls the Obsidian Device worn by the same avatar or a wearable piece of jewelry that needs to react to Obsidian state to which it is visually attached. This kind of API Script is already included in the Obsidian box and unpacks under the / dev folder. On top of that:

  • AVsitter Plugin is available for furniture creators to enable communication between furniture and Obsidian devices owned by different users.

    Furniture creators do not need a 'Customized' API Script. This use case is fully covered by the standard AVsitter Dev Kit.

  • Express API scripts are available for common use cases.

  • You can overcome the same-owner restriction by using a proxy/relay device worn by the other owner to establish communication with their Obsidian. This wearing requirement acts as a safeguard against unwanted communication from malicious devices.

• Yes, if your product needs to communicate with Obsidian devices that you do not own, for example, a shared HUD that controls multiple avatars’ Obsidian devices in a group. In this case, you will need to apply for a ‘Customized’ API Script as described below.

Apply for ‘Customized’ API Script

To obtain a ‘Customized’ API Script for cross-owner device communication, please send us your request via notecard. Please bear in mind that we may refuse to provide you with the script if you do not yet represent a reputable store. The ‘Customized’ API Script will include your brand name and will enable secure communication between devices owned by different users.

Contact Pi Rain in Second Life to request your ‘Customized’ API Script, providing the following:

• Please list all creators’ legacy names that you use when selling meshes so that we can add them to the list of valid creators.
• You will need to provide details about your brand name and intended use case for cross-owner communication.
• Please name the notecard ‘Custom API Request’ so it stands out from the rest.

Please refer to the API Reference to see how you will interact with the script.

What if I am a brand new creator / developer?

Please create a working prototype first using the standard API Script included in the Obsidian box. Once you have a working prototype and are ready to open your store, you can then request the ‘Customized’ API Script as described above along with your prototype for our review.

Please use Proxy-based communication technique to mimic cross-owner communication during development for your prototype.