Configuration
Every option in STG Custom Frame, from language, render distance and removal rules to the admin menu, target system, screenshot webhook and notifications.
The settings live in the stg_customframe/config/ folder:
| File | What it holds |
|---|---|
config.lua | Language, frames, admin menu, target system and notifications |
sv_config.lua | Screenshot webhook URL |
Both files stay editable in the escrow version. Restart the resource after a change.
Language
STG.Language = 'en'Available: en, de, fr, es, pt, it, nl, pl, sv, no, fi, ar, he, jp, zh. To change a text, edit the matching file in stg_customframe/locales/. The web part of each file holds the texts of the frame menu.
Frames
STG.Distance = 50.0
STG.OnlyOwnerCanRemove = trueProp
Type
Taking a frame down plays a 3 second animation and gives the frame item back.
Admin menu
STG.AdminCommand = "frameadmin"
STG.AdminGroups = {"god", "admin", "superadmin"}Prop
Type
The admin menu lists every frame on the server with its owner identifier and position. Pick a frame to Teleport to it or Delete Frame. A frame deleted from the admin menu does not give the item back to its owner.
Target system
STG.TargetSystem = 'auto'Prop
Type
- With a target system: every frame gets an Inspect Frame option, which moves the camera in front of the picture (close it with E or Backspace), and a Remove Frame option.
- Without a target system: players walk up to a frame they can remove and press E on the Remove frame prompt. Inspecting is only available with a target system.
Screenshot webhook
STG.webhook = ""Set in sv_config.lua. In-game photos are uploaded to this webhook with screenshot-basic, and the image link is read from the Discord webhook response. While it is empty, the camera button in the frame menu is hidden. See Create a Discord Webhook to get a URL.
Notifications
STG.Functions = {
["helpNotify"] = function(message, icon)
lib.showTextUI(message, {
position = "right-center",
icon = icon,
})
end,
["hideHelpNotify"] = function()
lib.hideTextUI()
end,
["notify"] = function(message, type)
lib.notify({
description = message,
type = type,
duration = 5000,
})
end,
}- helpNotify: the help text shown while placing a frame, while inspecting one and next to a frame you can remove.
- hideHelpNotify: hides that help text.
- notify: regular notifications, for example a missing permission.
Replace the bodies to use your own help text or notification system.
Still having trouble?
Open a ticket on our Discord. Our team answers around 15 hours a day.