LuaRoblox Edition

Roblox Lua ServerWebGamePost Client

This tutorial explains how to use the Roblox Lua version of the ServerWebGamePost client. Make sure that HttpService is enabled in your game settings.

---

1. Enable HttpService

Before using this module, you need to enable HttpService in your game:

• Open Roblox Studio.
• Go to the "Home" tab and select "Game Settings".
• Under the "Security" tab, enable the option "Allow HTTP Requests".

---

2. Installation

Place the file ServerWebGamePostClient.lua in a module within your game (for example, in ReplicatedStorage or ServerScriptService).

---

3. Using the Client

Define Your Datapacket Processing Callback

Create a function that will process the datapackets received from the server. For example:

-- Example callback to process datapackets
local function processDatapacks(datapack)
    print("Received datapack:")
    print(datapack)
    -- Insert your logic here (e.g., update player stats, log data, etc.)
end

Create a Client Instance

Require the module and create a new instance of the client by specifying the domain, port, and whether HTTPS is used. Then set the callback function:

-- Assuming the module is stored in ReplicatedStorage
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local ServerWebGamePostClient = require(ReplicatedStorage:WaitForChild("ServerWebGamePostClient"))

-- Create a client instance
local domain = "example.com"  -- Server domain or IP
local port = 8080             -- Server port
local isHttps = false         -- Set to true if using HTTPS

local client = ServerWebGamePostClient.new(domain, port, isHttps)
client:setProcessDatapacks(processDatapacks)

Send a Datapacket

To send a datapacket to the server, use the method sendDataPacket. Remember that the datapacket should include an identifier key:

local datapacket = {
    identifier = "client1",   -- Unique client identifier
    data = "Example data"       -- Other data you want to send
}

client:sendDataPacket(datapacket)

Processing the Response

Once the server responds, the callback function you set will be automatically called for each datapacket in the response. Implement the necessary logic in that callback to process each datapacket.

---

Summary

• Enable HttpService: Make sure HTTP requests are enabled in your Roblox game settings.
• Installation: Place the ServerWebGamePost.lua module file in an appropriate location (e.g., ReplicatedStorage).
• Client Setup: Create a client instance by providing the domain, port, and HTTPS flag; set your datapacket processing callback; and send datapackets using sendDataPacket.
• Processing: Your callback function is invoked automatically for each datapacket received in the server response.

Note

Ensure that your server endpoint is correctly configured to handle the HTTP requests from your Roblox game.

With this tutorial, you can integrate and use the Roblox Lua version of ServerWebGamePost in your game.