Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/SdazaP/ruTournament/llms.txt

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

This reference covers the 12 predefined WCA events available when creating a new tournament category in ruTournament. Each event has a short display abbreviation, a Tailwind CSS colour token used in the UI, and a corresponding csTimer puzzle-type identifier used during scramble generation. Understanding how event names map to csTimer puzzle types is important when troubleshooting missing or incorrect scrambles.

​
Predefined events

The table below lists every event defined in WCA_EVENT_CONFIG (src/common/wcaEvents.ts), together with the csTimer puzzle type and inspection time parameter drawn from wcaEventMap in src/pages/Tournament/Scrambles.tsx. The first 12 rows correspond to events with full colour-token support in WCA_EVENT_CONFIG. The final 4 rows (3x3 BLD, 3x3 FM, 4x4 BLD, 5x5 BLD) are present in wcaEventMap only — they support automatic scramble generation but do not appear in WCA_EVENT_CONFIG and therefore have no built-in colour token or abbreviation.
Event keyDisplay nameAbbrcsTimer puzzleInspection (s)
3x33×3 Cube3×33330
2x22×2 Cube2×2222so0
4x44×4 Cube4×4444wca0
5x55×5 Cube5×5555wca60
6x66×6 Cube6×6666wca80
7x77×7 Cube7×7777wca100
3x3 OH3×3 One-HandedOH3330
ClockRubik’s ClockCLKclkwca0
MegaminxMegaminxMGAmgmp70
PyraminxPyraminxPYRpyrso10
SkewbSkewbSKBskbso0
Square-1Square-1SQ1sqrs0
3x3 BLD3×3 Blindfolded—333ni0
3x3 FM3×3 Fewest Moves—333fm0
4x4 BLD4×4 Blindfolded—444bld40
5x5 BLD5×5 Blindfolded—555bld60
3x3 BLD, 3x3 FM, 4x4 BLD, and 5x5 BLD are not listed in WCA_EVENT_CONFIG and therefore have no built-in colour token or abbreviation badge. They are, however, recognised by wcaEventMap in Scrambles.tsx, so naming a custom category with one of these exact key strings will enable automatic scramble generation using the correct csTimer puzzle type.

​
WCA_EVENT_CONFIG

The full configuration object exported from src/common/wcaEvents.ts. Each key is the canonical event name string used throughout the application — in CategoryLocal.name, route parameters, and result views. 
// src/common/wcaEvents.ts
export const WCA_EVENT_CONFIG: Record<string, { abbr: string; color: string; bg: string }> = {
  '3x3':      { abbr: '3×3', color: 'text-blue-400',    bg: 'bg-blue-600' },
  '2x2':      { abbr: '2×2', color: 'text-red-400',     bg: 'bg-red-600' },
  '4x4':      { abbr: '4×4', color: 'text-purple-400',  bg: 'bg-purple-600' },
  '5x5':      { abbr: '5×5', color: 'text-green-400',   bg: 'bg-green-600' },
  '6x6':      { abbr: '6×6', color: 'text-amber-400',   bg: 'bg-amber-600' },
  '7x7':      { abbr: '7×7', color: 'text-pink-400',    bg: 'bg-pink-600' },
  '3x3 OH':   { abbr: 'OH',  color: 'text-indigo-400',  bg: 'bg-indigo-600' },
  'Clock':    { abbr: 'CLK', color: 'text-teal-400',    bg: 'bg-teal-600' },
  'Megaminx': { abbr: 'MGA', color: 'text-orange-400',  bg: 'bg-orange-600' },
  'Pyraminx': { abbr: 'PYR', color: 'text-lime-400',    bg: 'bg-lime-600' },
  'Skewb':    { abbr: 'SKB', color: 'text-cyan-400',    bg: 'bg-cyan-600' },
  'Square-1': { abbr: 'SQ1', color: 'text-violet-400',  bg: 'bg-violet-600' },
};
Each entry exposes three properties:
PropertyTypePurpose
abbrstringShort abbreviation rendered in compact badges and table headers
colorstringTailwind text-colour class for foreground text on dark backgrounds
bgstringTailwind background-colour class for filled badge backgrounds
Consume the config to render a consistent event badge: 
import { WCA_EVENT_CONFIG } from '../common/wcaEvents';

const config = WCA_EVENT_CONFIG[category.name];
if (config) {
  // config.abbr  → e.g. "3×3"
  // config.bg    → e.g. "bg-blue-600"
  // config.color → e.g. "text-blue-400"
}

​
Custom categories

ruTournament fully supports custom (non-WCA) categories. During category creation, type any name that does not match a key in WCA_EVENT_CONFIG and the category will be saved with that name. Custom categories work identically to predefined ones for round management, group generation, competitor assignment, and result entry. There are two limitations to be aware of:
  • No colour token — WCA_EVENT_CONFIG[category.name] will be undefined for custom categories. Components that render event badges should fall back gracefully (e.g. a neutral grey badge).
  • Scramble generation fallback — The scramble generator looks up the category name in wcaEventMap. If no match is found, it falls back to the 333 (3×3) csTimer scrambler. This means custom categories will receive 3×3-style scrambles unless you name them to match a key already present in wcaEventMap.

​
Inspection time

Several larger WCA puzzles require extra time for physical inspection before each solve. This is modelled as the second element of each wcaEventMap tuple in Scrambles.tsx and passed to the csTimer worker at scramble-generation time. 
// src/pages/Tournament/Scrambles.tsx  (excerpt)
const wcaEventMap: Record<string, [string, number]> = {
  '3x3':      ['333',    0],
  '2x2':      ['222so',  0],
  '4x4':      ['444wca', 0],
  '5x5':      ['555wca', 60],   // 1 min inspection
  '6x6':      ['666wca', 80],   // 1 min 20 s inspection
  '7x7':      ['777wca', 100],  // 1 min 40 s inspection
  '3x3 OH':   ['333',    0],
  '3x3 BLD':  ['333ni',  0],
  '3x3 FM':   ['333fm',  0],
  'Clock':    ['clkwca', 0],
  'Megaminx': ['mgmp',   70],   // 1 min 10 s inspection
  'Pyraminx': ['pyrso',  10],   // 10 s inspection
  'Skewb':    ['skbso',  0],
  'Square-1': ['sqrs',   0],
  '4x4 BLD':  ['444bld', 40],   // 40 s inspection
  '5x5 BLD':  ['555bld', 60],   // 1 min inspection
};
The inspection value is in seconds. A value of 0 means no inspection countdown is displayed. This parameter is used by the csTimer scramble engine only and does not affect result entry or average calculation within ruTournament.

Build docs developers (and LLMs) love

Get started for freeTalk to us