0.1.5 • Published 3 years ago
rbxlaunch-fork v0.1.5
rbxlaunch-fork
Directly launch Roblox games and Studio sessions from within Node.js applications.
Prerequisites
* Currently rbxlaunch-fork
is only supported on Windows devices, due to the rbxapp
library's limitations.
Install
$ npm i rbxlaunch-fork
Usage
Launching Studio
rbxlaunch = require("rbxlaunch-fork")
(async () => {
try {
await rbxlaunch.studio()
console.info("Roblox Studio launched successfully!")
} catch (error) {
console.error(error)
}
})()
Launching a Game
A cookie is required to launch games, due to Roblox requiring an authentication ticket to be generated before allowing a player to join the game.
rbxlaunch = require("rbxlaunch-fork")
(async () => {
try {
await rbxlaunch.game({
placeId: 4901843753, // place ID for rotopia
cookie: "_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in", // to authenticate the request
})
console.info("rotopia launched successfully!")
} catch (error) {
console.error(error)
}
})()
API
game(options)
Returns a Promise, which resolves with a ChildProcess object. Games are launched using the default roblox-player:
protocol, as the Roblox website does.
options
Type: object
key | type | required | default | description |
---|---|---|---|---|
cookie | string | Yes | null | The cookie used to authenticate the user |
placeId | number | * | null | The ID of the place to join |
instanceId | string | * | null | The game instance ID to join |
isPrivate | boolean | No | false | Determines whether instance ID leads to a public or private server |
userId | number | No | null | Used to join another user in-game |
universeId | number | No | null | If provided, will be resolved to the root place ID of the universe |
- *
placeId
is required when not following another user in-game. - *
instanceId
is required whenisPrivate
is set totrue
studio(options?)
Returns a Promise, which resolves with a ChildProcess object. Games are launched using the RobloxStudioLauncherBeta application, rather than via a protocol. This is to allow local files to be opened.
options
Type: object
key | type | required | default | description |
---|---|---|---|---|
placeId | number | No | null | The ID of the place to open in Studio |
file | string | No | null | The path to the .rbxl or .rbxlx file to open in Studio |
Caveats
- Launching Roblox Studio is currently only supported on Windows.