Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cc-scripts.com/llms.txt

Use this file to discover all available pages before exploring further.

​
The export shape

Every minigame is exposed as a single export on cc_minigames. Each one takes an options table and returns a boolean. 
local ok = exports.cc_minigames:Pattern({
    variant    = 'terminal',
    difficulty = 'hard',
    rounds     = 6,
    gridSize   = 5,
})

if ok then
    -- player passed; grant the thing server-side
    TriggerServerEvent('myheist:unlockVault')
else
    -- player failed or cancelled
end
Every option is optional. Omit anything and the difficulty preset fills it in.

​
Generic dispatch

For data-driven heists where the minigame is picked at runtime: 
local ok = exports.cc_minigames:Start('crack', { difficulty = 'hard' })
Start accepts the same name strings as the /minigame command — see the reference table for the full list.

​
Blocking semantics

Exports yield the calling coroutine until the player finishes or cancels. Always call them from inside CreateThread or another already-yielding context. Calling at the top level of a script body will error.
-- Wrong: top-level body, will error
local ok = exports.cc_minigames:Pattern({}) -- ❌

-- Right: inside a thread
CreateThread(function()
    local ok = exports.cc_minigames:Pattern({}) -- ✅
end)

​
Concurrency

Only one minigame can run per client at a time.
  • Starting a second while one is active returns false without showing UI.
  • On resource stop mid-game, any outstanding promise resolves false and NUI focus is released so the player is never stuck.
-- Bail early if a game is already up
if exports.cc_minigames:IsActive() then return end

-- Force-cancel the active session (resolves it as false to whoever is awaiting)
exports.cc_minigames:Stop()

​
Player input

  • Escape cancels any running minigame and returns false.
  • The resource owns NUI focus while a game is up. It is restored automatically on finish, cancel, or resource stop.
  • Every direct player input (clicks, keypresses) plays a click SFX. Boot/success/fail SFX play automatically.

​
Variants

Each game declares which visual variants make sense for it:
VariantWhat it looks likeUsed by
terminalFull-card hacking-terminal chrome with a live log stream.Default for desk-style games (Pattern, Crack, Sequence, …).
bareCompact card with no chrome. Good when the game art is the point.Available on most terminal-style games.
stripLow-screen horizontal band; world stays visible.Locked variant for Lockpick, Fishing, Flick, Cut, Balance, Masher.
screen-4x34:3 layout for projecting onto a CRT prop via DUI.Frequency viewer only.
See per-game restrictions in the reference table.

​
Difficulty

Every game accepts difficulty = 'easy' | 'medium' | 'hard' (default medium). Difficulty drives sane defaults for every other knob — you only need to override individual options when you want a tier-off-tier feel (“hard, but with more attempts than the preset”). The one exception is Fishing, which uses rarity tiers (common → legendary) instead of difficulty.

​
Generic options that work everywhere

These two options are not minigame-specific; they’re handled by the shell on every call.
OptionTypeEffect
targetstringOverride the terminal-variant target string shown in the chrome. Sanitized to alphanumerics, -, _.
embedbooleanRender inline rather than as a fullscreen overlay; do not touch NUI focus. Used by DUI sessions and by callers that already own the NUI focus (e.g. an iframe-style dashboard).

​
Generic API

ExportReturnsDescription
:Start(name, opts)booleanRun any minigame by name.
:IsActive()booleanWhether a minigame (or Control Panel) is currently up.
:Stop()—Force-cancel the active minigame. The pending promise resolves false.
:CreateDuiSession(params)controller tableBuild a DUI-hosted session. See DUI sessions.
:ControlOpen(opts)session idOpen the schematic Control Panel.
:ControlSetDoor(id, state)booleanUpdate a door state in the open panel.
:ControlSetCamera(id, state)booleanUpdate a camera state in the open panel.
:ControlClose()booleanClose the panel.
:ControlIsOpen()booleanWhether the panel is currently open.