Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rblx.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A JavaScript wrapper for the ROBLOX OpenCloud API.

Introduction

Recently at RDC 2022, ROBLOX announced OpenCloud API endpoints for DataStore, MessagingService and more to programatically access Roblox Studio Services from external sources. These would have official libraries for languages such as Python and JavaScript eventually, but until then, roblox.js bridges this gap as an API wrapper.

Installation

Yarn:

yarn add rblx.js

NPM:

npm i rblx.js

Usage

Roblox.js is a OpenCloud API wrapper with full TypeScript support. Once installed, you can access the following classes:

Datastore
MessagingService

Functions are named similar to the Lua equivalents and follow a similar structure. Each class is initialized with a universeId and an apiKey from https://create.roblox.com/credentials.

Documentation

For detailed documentations and examples check out the wiki or the docs directory.

rblx.js