About

A powerful Node.JS module that lets you interact with the Roblox Web API easily, fast and reliably.

• It is object-oriented (OO)
• It's got great documentation
• Predictable method -and property names
• Highest coverage of the api of all the other modules on NPM!

Getting Started

Bloxy has 4 dependencies:

• request - To easily deal with HTTP requests
• node-cache - Used for caching
• signalr-client - To connect with a WebSocket endpoint
• @hapi/joi - To deal with type validation

Make sure you are able to install each and every one of these packages as they are all vital to the functionality of this module!

Prerequisites

To be able to use bloxy, here's what you need to know:

• some knowledge of OOP and how it works
• knowledge about JS
• a computer

Installing

Installing bloxy is easy! Simply enter the following command, and you should be good to go👍

npm install bloxy --save

Installing the dependencies may take longer!

Contributing

Please, before making an issue or pull request, please make sure you have done this already:

• Made sure there are no similar issues / PRs like this - if so, rather give them a comment!
• Asked for help in the Roblox API Community - Sometimes, even the best of us need help.
• (Issues only) Follow the style / template as shown in example-issue - Consistency works!

Versioning

| Version | Date | Description | | ------------ | -------- | ------------------ | | 4.0.0 | 21-07-2019 | v4 Release of bloxy (finally!) |

Examples

Check out below for some examples of how to use bloxy!

const bloxy = require("bloxy");
const roblox = new bloxy.Client({
    cookie: ".ROBLOSECURITY"
});

roblox.login().then( (user) => {
    console.log(`Logged in as ${roblox.user.id}`);
    // --> "Logged in as 1234" 
});

const bloxy = require("bloxy");
const roblox = new bloxy({
    cookie: ""
});

roblox.login().then( async () => {
    const group = await roblox.getGroup(12345);
    const promoted = await group.promote(12345);
    	
    console.log(`Promoted user to ${promoted.name}`);
    // --> "Promoted user to <name>"
});

Acknowledgements

• Sentanos - For helpful solutions and ideas - roblox-js

License

This project is licensed under the MIT License.