Sending feedback from Luau

How a Roblox game's server sends player feedback to the platform from Luau, through the Template's PlatformService, and what a game not built on the Template does.

Building on the platform / Sending feedback over HTTP

A game built on the Blockout Roblox Template sends player feedback with PlatformService.sendFeedback, and ships a Feedback window that calls it for you. The Template is the Blockout SDK: there is no separate Luau package. A game not built on the Template sends feedback over HTTP itself (Sending feedback over HTTP).

Send feedback

In a Template game, switch the platform on and set the BlockoutApiKey secret (The Template's platform service). Players then send feedback from the Feedback button in Roblox's top bar, beside Settings, with no code. To send feedback from your own server code, call the service:

A server service
local PlatformService = require(script.Parent.PlatformService)task.spawn(function()	local receipt = PlatformService.sendFeedback(player, "bug", "The shop button does nothing")	if not receipt.ok then		warn(`[Feedback] not sent: {receipt.reason}`)	endend)

sendFeedback yields, so call it in task.spawn or a service's start(). It fills in playerId, placeId and serverVersion itself, and keeps one idempotency key across its retries. It does not limit how often a player sends: limit players yourself, as the Feedback window does (one every 30 seconds and 10 an hour). Details: PlatformService.sendFeedback.

The feedback categories

bug

Something is broken. The Template's window labels it Bug.

suggestion

An idea for the game. Labelled Idea.

balance

Too easy, too hard, too slow. Labelled Balance.

praise

What the player likes. Labelled Praise.

other

Anything else. Labelled Other. Player reports from Template games before v1.0.0 arrived in this category too (see player reports).

The text is 1 to 2,000 characters after trimming.

Checking what players send

A client can send anything through a remote. Check the category and the text's type and length on the server, and limit how often each player may send, before calling sendFeedback. The Template's remote guard does this for its window.

Updated