Connecting Roblox Studio

Connect your live game to BloxyOps events

Integrating BloxyOps into your game means you can make events in web, part of your game instantly, without pushing new builds in the game editor. The Roblox script calls our servers, and surfaces your event right into the experience.

The BloxyOps plugin is currently in development. In the meantime, we maintain a working sample project in Github, and provide this integration guide

Github Repo

https://github.com/jtritell/BloxyOpsExample

Settings

First, enable your application to call external Http requests within Roblox studio

Go to Game Settings => Securtity => Allow HTTP Requests and check this toggle

API Key Setup

Next, find or create your API key in the Bloxy Ops dashboard. Click the settings (gear icon) button next to the game select, then copy your developer token. You will need this to securely connect to your game data.

Your API Key can be used to read all BloxyOps information about your game, but cannot edit your game in BloxyOps or your Roblox account. Keep this key secure.

If you are using the plugin code from Github:

In Roblox Studio, select the asset ServerScriptService -> Server -> RobloxLiveOps . Add an attribute with name `ApiKey` and the value as your copied API key

Testing APIs in the Doc Site

Use these APIs for reference and testing: https://bloxyops.com/docs

You can use this API docs site to test request and responses to our API. And to inspect the values that are returned to your game server

Add fetching code into your game

If you are not using the github example, use this example to call the events API

Run this code in a server side script. HTTP requests can only be called by server side code.

local ROBLOPS_URL = "https://bloxyops.com/api/Event"
local HEADERS = {
	['X-Api-Key'] = apiKey
}

local data
pcall(function()
	-- Make the request to our endpoint URL
	local response = HttpService:GetAsync(ROBLOPS_URL, false, HEADERS)

	-- Parse the JSON response and store in a global variable
	local data = HttpService:JSONDecode(response)
end)

-- Did our request fail or our JSON fail to parse?
if not data then
	return false
end

To see more on calling HTTP, see the Roblox Documentation

The parsed JSON will contain definition from the API spec. Use events to send updates to the game clients.