Skip to content

A Promise-Based API Wrapper for Roblox's Web API w/ Full Open Cloud Support

License

Notifications You must be signed in to change notification settings

ValiantWind/cloudblox

Repository files navigation

Cloudblox

An Promise-Based API Wrapper for Roblox's Web API w/ Open Cloud Support

Not recommended for productive use yet.

This is a big work in progress. Once it works with every available endpoint, it will be ready for productive use. This should happen soon.


To Install:

npm install cloudblox

Future Example use:

// Common JS
const { Client, Users, MessagingService } = require('cloudblox');

// ES6
import { Client, Users, MessagingService } from "cloudblox";


const client = new Client();
// Configuring the client is only required when you are working with methods that need authentication
client.Configure({
	Cookie: "Cookie goes here",
	MessagingService: "MessagingService API Key goes here"
})

Users.getUserInfo(1)

MessagingService.PublishAsync("topic", "message")

Contributing

Contributing would be extremely appreciated. If you have the time, please consider.

View CONTRIBUTING.md on how to properly contribute

License

This package is licensed under the Mozilla Public License 2.0

Roblox Name Guidelines

I have been approved by Roblox to use the name "cloudblox".

This package NOT is affiliated or endorsed by Roblox Corp.

I have simply been given the rights to use "cloudblox" for this package.

Support

If you find a bug, please open an issue describing what it is and how to reproduce it.

If you have any questions or need support, you can message me on Roblox. Click to view my profile.

Alternatively, you can send me a friend request on Discord (Username: valiantwind).