Peak Chess Documentation

Welcome to the official documentation for Peak Chess, a standalone FiveM chess resource with PvP tables, AI games, spectator support, optional wagers, and a React/Vite NUI.

Peak Chess is designed to run with no mandatory framework, target system, database, or peak-bridge dependency. Standalone no-wager chess works by default. If peak-bridge, ESX, QBCore, or Qbox is present, the resource can use those integrations for identity, notifications, and money.

The only required asset for the full 3D table experience is the bzzz_chess prop pack.

Key Features

• Standalone PvP chess tables
• AI opponents with configurable easy, medium, and hard levels
• Spectator HUD for active matches
• Legal move validation, check, checkmate, stalemate, promotion, and resignation
• Optional wagers with server-side economy validation
• Optional peak-bridge support
• ESX, QBCore, and Qbox fallback wrappers
• Dependency-free drawtext interaction by default
• Optional ox_target, qb-target, and var-interact support
• React + Vite NUI with lobby, setup, HUD, promotion, and result states
• No backdrop-filter, backdrop-blur, or blur overlay dependency in the chess UI

1. Resource Placement

Place the folder in your server resources as:

text
resources/[peak]/peak-chess

2. Asset Pack

Install and ensure the bzzz_chess prop pack before peak-chess.

cfg
ensure your_bzzz_chess_prop_pack
ensure peak-chess

If you use peak-bridge, start it before Peak Chess:

cfg
ensure peak-bridge
ensure your_bzzz_chess_prop_pack
ensure peak-chess

3. Configuration

Open shared/sh.lua and review:

• Shared.Framework for auto-detection or manual framework selection
• Config.Locations for table coordinates
• Config.Target.system for interaction handling
• Config.Betting for wager settings
• Config.AI for engine levels and delays

Required

• FiveM cerulean runtime
• bzzz_chess prop pack for the complete 3D chess table experience

Optional

• peak-bridge
• ESX
• QBCore
• Qbox
• qbx_core
• ox_target
• qb-target
• var-interact

There is no SQL requirement.

With Shared.Framework.autoDetect = true, Peak Chess checks:

1. peak-bridge
2. es_extended
3. qb-core
4. qbx_core
5. Standalone

peak-bridge is used only when it is started and ready. If it is absent, Peak Chess falls back to local ESX/QBCore/Qbox wrappers or standalone mode.

Standalone mode supports playable zero-wager chess. Non-zero wagers require a money provider through peak-bridge, ESX, QBCore, or Qbox.

If no money provider is available:

• The UI hides wager controls.
• Server-side wager values are sanitized to 0.
• PvP and AI chess remain playable.

The NUI source is in web/ and builds to web/build, which is the path loaded by fxmanifest.lua.

bash
cd web
npm install
npm run build

Debug browser views:

text
?debug=lobby
?debug=hud
?debug=promotion
?debug=all

Server Exports

lua
exports['peak-chess']:GetMatch(tableId)
exports['peak-chess']:GetPlayerMatch(playerId)
exports['peak-chess']:IsPlayerInGame(playerId)
exports['peak-chess']:GetActiveMatches()
exports['peak-chess']:StartAIGame(playerId, tableId, side, level, bet)
exports['peak-chess']:ForceEndMatch(tableId, winnerColor)

Client Exports

lua
exports['peak-chess']:IsSeated()
exports['peak-chess']:IsInGame()
exports['peak-chess']:GetCurrentTable()
exports['peak-chess']:GetColor()
exports['peak-chess']:OpenLobby(tableId)

NUI Messages

• lobby
• hud
• promotion
• gameover
• closeAll

NUI Callbacks

• sit
• spectate
• startAI
• setReady
• resign
• promote
• leave
• closeLobby

• Start without peak-bridge and play a zero-wager PvP game.
• Start with peak-bridge and confirm identity, notification, and money integration.
• Start an AI game.
• Complete a PvP ready flow.
• Test legal and illegal moves.
• Promote a pawn.
• Resign a match.
• Reach checkmate and stalemate.
• Use spectator HUD.
• Restart the resource and confirm cleanup.

Join the Peak Studios Discord for updates and support: Peak Studios Discord