Skip to main content

Quick Start

Functions

Start an interactive skill check mini-game.
Parameters:
  • title (string, required) - Title for the skill check
  • difficulty (string | table, required) - Difficulty level or array of difficulties (see Difficulty Levels)
  • inputs (string | table, optional) - Single input key or array of input keys (default: 'E')
  • size (string, optional) - Size variant: 'normal' or 'compact' (default: 'normal')
Returns:
  • success (boolean) - true if all skill checks completed successfully, false if failed or cancelled
Cancel the currently active skill check.
Check if a skill check is currently active.
Returns:
  • isActive (boolean) - true if a skill check is active, false otherwise

Configuration

Options

string
required
Title displayed for the skill check
string | table
required
Difficulty level or array of difficulty levelsSee Difficulty Levels for available options
string | table
default:"E"
Single input key or array of input keysCan be a single key (e.g., 'E') or multiple keys for sequential checks (e.g., {'W', 'A', 'S', 'D'})
string
default:"normal"
Size variant of the skill check UIAvailable options:
  • 'normal' - Full UI with instructions
  • 'compact' - Minimal UI (just circle and key)

Difficulty Levels

Use predefined difficulty levels for quick setup.
string
Large target area, slow speed
string
Medium target area, medium speed
string
Small target area, fast speed
Example:

Preview

Skill Check Preview

Normal size

Skill Check Compact Preview

Compact size