Studios
Tebexhouse-3.jpg

Configuration

SoonTebexQbox
PAGE 03 OF 07  ·  INSTALLATION → CONFIGURATION → TEBEX SETUPdocs.glitchstudios.dev
Browse docs

Everything is in config.lua, with a comment on each setting. Put your own changes in config.server.lua, which loads after it, so updates never overwrite your settings:

Config.StoreTitle = 'My Token Store'
Config.TokenName = 'Coins'
Config.Currency = 'GBP'
Config.VehicleGarage = 'pillboxgarage'
Config.Integrations.hud = false

Main settings#

Setting Default What it does
Config.Command 'tebex' Command that opens the store, or sets a waypoint when you are far from the TV
Config.StoreTitle 'Token Store' Notification title, store header and logo
Config.WebhookUsername 'Token Store' Name on log posts sent through glitch-admin
Config.TokenName 'Tokens' What the store currency is called
Config.Currency 'USD' Currency of the Tebex package prices
Config.Integrations all true Switches for the optional resources
Config.PhoneResource 'sd-phone' Phone resource used for verified ticks
Config.RentalTable false Table with a vehicle_id column that lists rented vehicles, whose plates cannot be changed. Leave it false if you have none
Config.CallCooldownMs 1500 Wait between database-backed store calls per player
Config.BoostConfirmSeconds 30 How long the XP boost confirm dialog stays open
Config.DiscordTierCacheSeconds 60 How long a Discord role tier is remembered per player
Config.DiscordGraceHours 48 Hours an offline Discord-tier member keeps their perks
Config.Debug false Turns on the /tebextv placement tool

The TV#

Config.Screen decides where the TV stands. standAt is an example position, so change it to a spot facing a flat wall. The TV is placed on the first wall straight ahead of that spot.

Key Default What it does
standAt example vector4 Where you stand facing the wall (coordinates and heading)
tv nil Exact TV placement (origin and heading) instead of standAt. /tebextv prints the current one
model 'prop_tv_flat_01' TV prop
winding 'ccw' Triangle order of the picture: 'ccw', 'cw' or 'both'
screenSide -1 Which side of the model is the glass: -1 or 1
height 1.65 Middle of the screen above the ground, in metres
wallGap 0.02 Space between the wall and the back of the TV
inset table Picture inset from the model's edges as fractions of width and height
resolution { 1280, 720 } Size of the page drawn onto the TV
range 45.0 The TV and page spawn inside this distance
drawDistance 30.0 Distance the picture is drawn from
useDistance 2.5 Range of the ox_target option
commandDistance 8.0 /tebex opens the store within this distance of standAt, otherwise it sets a waypoint
fov 38.0 Camera field of view while using the screen
transitionMs 600 Camera transition time

Config.Blip sets the map blip at the TV (sprite, color, scale, label). Set it to nil for none.

Config.StoreUrl = 'https://your-store.tebex.io'
Config.StoreLabel = 'your-store.tebex.io'
Config.PackageUrl = 'https://your-store.tebex.io/package/%d'

StoreUrl is where "Open in browser" goes. PackageUrl is used when a player clicks a pack or tier, with the package id in place of %d. Product art comes from Config.VehicleImageUrls (each URL is tried in turn, %s is the spawn name) and Config.ItemImageBase (the item name plus .png is added).

Packages#

Config.Packages lists every Tebex package, matched by its Tebex name. Case, spaces, punctuation and anything after the first : are ignored when matching, so renaming a package in Tebex means renaming it here too.

type Fields What it does
tokens id, name, price, tokens, bonus, image A token pack. bonus is only the label on the page
membership id, name, price, tokens, xpboosts, perks, flags, popular, image A monthly tier. Gives tokens and xpboosts on purchase and every renewal
other id, name, price, grants Gives its grants only and is not shown on the Get tokens page

Membership flags are what other resources check while the tier is active:

Flag Meaning
apartments Pick your apartment building and larger rooms (read by your housing resource)
charslots Extra character slots (qbx_multicharacter). Locked, not deleted, when it ends
discount Dealership discount in percent, applied by your dealership
verified Verified tick on Squawk and Photogram (sd-phone)
number Custom phone number at the Plate Studio (glitch-garages)
plates Unlimited custom plates at the Plate Studio (glitch-garages)
tvs Personal TVs that staff may place for them (glitch-admin Supporter TVs)

grants is a list of extra rewards on any package type:

Grant Example
Tokens { type = 'tokens', amount = 2500 }
Perk { type = 'perk', perk = 'xpboost', amount = 1 } (XP boost items, plate credits, VIP days or character slots)
Vehicle { type = 'vehicle', model = 'zentorno', garage = 'pillboxgarage' }. The garage defaults to Config.VehicleGarage
Item { type = 'item', name = 'lockpick', count = 1 }
Staff order { type = 'staff', label = 'Something' } logs a post and shows in /tebexorders

Config.MembershipDays (default 33) is how long a purchase or renewal lasts. It is a month plus a couple of days so a late renewal does not drop the perks.

Products#

Config.Products is the token catalogue. Prices are in tokens and only the server reads them.

Field What it does
id, cat, name, price, desc Basics. cat is a category id
model, maker, stats Vehicle photo, maker and four bars (speed, acceleration, braking, traction) from 0 to 100
img, image, icon Item image from ox_inventory, your own picture in html/, or a fallback drawing
info, includes Detail rows as { label, value }, and the product ids inside a bundle
tag, featured, once Label, show on Featured, and one purchase per account
package, cash A real-money product that opens the Tebex package page and is never sold for tokens
grant How it is delivered (below)
grant What it does
{ type = 'vehicle', model = 'zentorno' } Owned car in Config.VehicleGarage
{ type = 'item', name = 'x', count = 1 } ox_inventory item on the character
{ type = 'vip', days = 30 } VIP queue priority, stacking. Your queue reads it through HasPerk
{ type = 'charslot', count = 1 } A paid qbx_multicharacter slot
{ type = 'credit', perk = 'xpboost' } A credit used from My account (xpboost or plate)
none A staff order

Config.Categories sets the tabs: featured, vehicles, cosmetics, perks, items, housing and bundles. A category with disabled = true hides the tab and its products, and the server refuses to sell them on their own. They can still be delivered inside a bundle. cosmetics and housing are disabled by default.

XP boost#

Setting Default
Config.XPBoostItem 'xpboost'
Config.XPBoost { multiplier = 2.0, minutes = 60, categories = 'all' }

categories is 'all' or a glitch-xpSystem category id or list. A boost started while one is running adds its time.

Staff access#

Config.FullAccessAce (default nil) and Config.FullAccessRoles (default {}) name the staff who get every membership perk. Roles come from glitch-admin's Discord role list and need Config.Integrations.admin.

Text#

Player-facing server and client text lives in locales/en.json (ox_lib locale files). The labels on the page itself are in html/app.js.