robloxcloudapi

1.2.4 • Public • Published

Roblox Node JS Open Cloud API

There are two APIs in this module right now.

Note

Please setup your cloud API key before beginning.

Link: https://create.roblox.com/dashboard/credentials

Having trouble? View this article: https://create.roblox.com/docs/cloud/open-cloud/managing-api-keys

Introduction to the MessageService API

Before starting this identify your API key and the universe ID you want to access.

const API_KEY = "api key here"
const UniverseID = "universe id here"

Require the module as seen below.

const rbxcloudAPI = require("robloxcloudapi")

Now lets setup our MessageService communicator.

const MessageService = new rbxcloudAPI.MessageService(API_KEY, UniverseID)

From here you can now comunicate with all servers of the game

.sendMessage(Message) // sends Message to all servers of universe
.sendObject(Object) // sends Object to all servers of universe

Introduction to the DataStoreService API

Before starting this identify your API key and the universe ID you want to access.

const API_KEY = "api key here"
const UniverseID = "universe id here"

Require the module as seen below.

const rbxcloudAPI = require("robloxcloudapi")

Now lets setup our DataStore communicator.

const DataStores = new rbxcloudAPI.DataStoreService(API_KEY, UniverseID)

From here you can view and edit your DataStores' entries inside this game by using functions shown below.

.getEntries(datastore_name) // returns a JSON table of all Entries
.getEntry(datastore_name,entryKey) // returns the value of entryKey
.setEntry(datastore_name,entryKey,value) // Sets entry to the value given

Package Sidebar

Install

npm i robloxcloudapi

Weekly Downloads

2

Version

1.2.4

License

ISC

Unpacked Size

5.34 kB

Total Files

3

Last publish

Collaborators

  • load_lua