STG ScriptsDocumentation
Checkers

Configuration

Every option in STG Checkers shared/config.lua, from language and target system to prop models, animations, the board camera and notifications.

All settings live in stg-checkers/shared/config.lua. The file stays editable in the escrow version. Restart the resource after a change.

Language

Config.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-checkers/locales/.

Target system

Config.TargetSystem = 'auto'

Prop

Type

The floating prompt above the table works with every setting. Players press E to sit down, and the owner presses H to remove the table.

Props

Config.Models = {
    table = 'stg_bzzz_table_a',
    board = 'stg_bzzz_board_a',
    chair = 'stg_bzzz_chair_a',
    checker_w = 'stg_checker_a',
    checker_b = 'stg_checker_b',
}

Prop

Type

A king is the same disc with a second disc stacked on top. All models are streamed from the stream/ folder. The table, board and chair are based on the BzZz chess prop pack and renamed, so they do not clash with it if your server also runs that pack.

Swapping these for your own models works, but the board model must keep the same square layout or the pieces will not line up with the squares.

Animations

Config.Animation = {
    Dict = 'bzzz_chess_animations',
    SitClip = 'bzzz_chess_sit_a',
    MoveClip = 'bzzz_chess_sit_b',
}

Prop

Type

Camera

Config.Camera = {
    Height = 0.72,
    Back = 0.8,
    Fov = 45.0,
}

While seated, a camera looks down at the board from the player's side.

Prop

Type

Notifications

Config.Functions = {
    Notify = function(type, message)
        lib.notify({ type = type, description = message })
    end,
    ShowHelpNotify = function(message)
        lib.showTextUI(message, { position = 'left-center' })
    end,
    HideHelpNotify = function()
        lib.hideTextUI()
    end,
}

Prop

Type

Still having trouble?

Open a ticket on our Discord. Our team answers around 15 hours a day.

Get help on Discord

On this page