How does ZKAPI work?

Resources Community Tutorials
, , , ,
1

The ZKAPI is used for the ZKPrecense plugin, which allows you to use this bridge between Discord and Studio for other plugins. For example, when you use a random animation plugin that is compatible with ZKPrecense, it could display a custom status

How it works

First, your plugin needs to look up the ZKAPI in CoreGUI.APIZKP

local CoreGUI = game:GetService("CoreGui")
local PosiblePluginZKP = PlugUI:WaitForChild("APIZKP", 10) -- Make sure you are using ZKPrecense and API is aviable

if PosiblePluginZKP then
	local ZKApi = require(PosiblePluginZKP).new()
	ZKApi.Enabled = true -- When your plugin isnt enabled like closed Pluggin Window put this on false
end

From there, every 15 seconds (just when the ZKPrecense is about to update) it will check through a function the last plugin that used ZKAPI.new() and has ZKAPI.Enabled set to true

ZKApi.Update = function()
		return {
			Details = "Example cuz state",
			State = "This is a Example of a other Plugin Using ZKPrecese API :D",

			LImage = "https://tr.rbxcdn.com/180DAY-09b17f8a398c825ae1e054ec0c2aa7a6/150/150/Image/Webp/noFilter",
			LImageDesc = "Test of Custom ZKP API",

			SImage = "https://tr.rbxcdn.com/180DAY-f89b57c40384020d929a813c2c961ef2/420/420/Decal/Webp/noFilter",
			SImageDesc = "API Little Logo 🗣️🔥"
		}
	end

13 sin tĂ­tulo_20260223195734
13 sin tĂ­tulo_20260223195734571Ă—227 49.9 KB

14 sin tĂ­tulo_20260223200049
14 sin tĂ­tulo_20260223200049560Ă—222 48.3 KB

PLEASE DO NOT KEEP ZKAPI.Enabled. ALWAYS SET IT TO FALSE WHEN THE PLUGIN IS NOT ACTIVE

And that’s it! If you want me to add more things to the API, let me know here :3c