rbxapp v0.0.2

rbxapp

Node.js utility module for locating the install paths of Roblox Studio and Roblox Player.

Prerequisites

• Node.js
• A package manager (npm, yarn, etc.)
• Windows*

* Currently rbxapp is only supported on Windows devices, and uses the registry to detect installation paths. Attempting to use locator functions on another platform will throw.

Install

$ npm i rbxapp

Usage

Finding Studio install path

const { RobloxStudio } = require("rbxapp")
const studio = new RobloxStudio()

(async () => {
    try {
        const paths = await studio.locate()
        console.info(`Roblox Studio is installed at: ${paths.application}`)
    } catch (error) {
        console.error(error)
    }
})()

API

The rbxapp module exports a RobloxStudio and a RobloxPlayer class, both of which are used to locate their respective applications.

RobloxStudio Class

locate(verifyPaths?)

Returns a Promise, which resolves with a StudioApplicationPaths object.

verifyPaths

Type: boolean\ Required: No\ Default: true

Attempts to verify that all paths are present on the filesystem before returning. Will throw if any of the paths could not be found.

RobloxPlayer Class

locate(verifyPaths?)

Returns a Promise, which resolves with a PlayerApplicationPaths object.

verifyPaths

Type: boolean\ Required: No\ Default: true

Attempts to verify that all paths are present on the filesystem before returning. Will throw if any of the paths could not be found.

StudioApplicationPaths

Type: object

PlayerApplicationPaths

Type: object

The only difference is lack of plugins directory.