Skip to content

README.md

Latest commit

 

History

History
31 lines (27 loc) · 1.47 KB

README.md

File metadata and controls

31 lines (27 loc) · 1.47 KB

RobloxBugReport

Allow your game's users to send bug reports, which automatically open a github issue.

Using the Bug Report tool

To use the bug report tool, you can run the rojo project and then connect in studio.
Alternatively, you can put the contents of the src folder in their respective places, these places are as follows:

  • src/Client -> StarterPlayer/StarterPlayerScripts/RobloxBugReport
  • src/Shared -> ReplicatedStorage/RobloxBugReport
  • src/Server -> ServerScriptService/RobloxBugReport

Note: It is important that you correctly name the folders, otherwise the code will not work.

Once you've done this, you will need some bug report GUI, once the send button is clicked you should call the SendBugReport function from the Client module. This can be done with the following example code:

--!nonstrict
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local RobloxBugReport = ReplicatedStorage:WaitForChild("RobloxBugReport")
assert(RobloxBugReport, "RobloxBugReport folder not found under ReplicatedStorage")
local ClientModule = require(RobloxBugReport.Client)
assert(ClientModule, "Client Module not found under RobloxBugReport")

local UI = PathToPlayerGui
local TitleLabel = UI.PathToTitleLabel
local DescriptionLabel = UI.PathToDescriptionLabel
local SendButton = UI.PathToSendButton
SendButton.Activated:Connect(function()
    local title = TitleLabel.Text
    local description = DescriptionLabel.Text
    return ClientModule(title, description)
end)