Customization

We provide advanced and flexible set of customization options:

chevron-rightBasic Optionshashtag
Config = {}

Config.InteractionRange = 1.5

-- Game settings defaults
Config.DefaultGameSettings = {
    -- Draw rules (each can be toggled independently)
    fiftyMoveRule = true,           -- Draw after 50 moves without pawn move or capture (1880)
    threefoldRepetition = false,     -- Draw when same position occurs 3 times (1920)
    insufficientMaterial = false,    -- Draw when neither side can checkmate (1920)
}

-- ============================================================================
-- FRAMEWORK INTEGRATION
-- ============================================================================
-- Framework detection: 'auto' | 'vorp' | 'rsg' | 'custom'
-- 'auto' detects VORP or RSG automatically; falls back to 'custom'
Config.Framework = 'auto'

-- Chess sets: each inventory item maps to a set of board + piece models
Config.DefaultChessSet = 'classic'

-- Map inventory item name → chess set ID
Config.ChessBoardItems = {
    ['chessboard'] = 'classic',
    ['chessboard_marble'] = 'marble',
}

-- Chess set definitions (board model + piece models)
Config.ChessSets = {
    ['classic'] = {
        boardModel = `p_chessset01x`,
        pieceModels = {
            white_k = `p_wking_01x`,  white_q = `p_wqueen_01x`,  white_r = `p_wrook_01x`,
            white_b = `p_wbishop_01x`, white_n = `p_wknight_01x`, white_p = `p_wpawn_01x`,
            black_k = `p_bking_01x`,  black_q = `p_bqueen_01x`,  black_r = `p_brook_01x`,
            black_b = `p_bbishop_01x`, black_n = `p_bknight_01x`, black_p = `p_bpawn_01x`,
        },
    },
    ['marble'] = {
        boardModel = `p_chessset01`,
        pieceModels = {
            white_k = `p_wking_01`,  white_q = `p_wqueen_01`,  white_r = `p_wrook_01`,
            white_b = `p_wbishop_01`, white_n = `p_wknight_01`, white_p = `p_wpawn_01`,
            black_k = `p_bking_01`,  black_q = `p_bqueen_01`,  black_r = `p_brook_01`,
            black_b = `p_bbishop_01`, black_n = `p_bknight_01`, black_p = `p_bpawn_01`,
        },
    },
}

-- Max item-placed boards per player (0 = unlimited)
Config.MaxBoardsPerPlayer = 3

-- Command to remotely remove all your placed boards (false = disabled)
Config.PickupBoardsCommand = 'removeboards'

-- Placement settings
Config.PlacementMaxDistance = 3.0  -- Max raycast distance for board placement

-- Selector marker colors
Config.MarkerColors = {
    selector = {r = 160, g = 40, b = 40, a = 170},          -- Muted crimson
    selectorActive = {r = 190, g = 50, b = 30, a = 200},    -- Deeper red when piece selected
    validMoves = {r = 140, g = 50, b = 50, a = 130},        -- Soft dark red for valid moves
}

-- Advanced settings
Config.ObservingRange = 10.0

-- Command for standalone versions
Config.CommandEnabled = false
Config.CommandName = 'placechess'

Last updated