RGreview-game-corethe engine behind concept-first review games

Getting Started

Quick Start

Minimal imports for questions, concepts, generators, scheduling, and workflow contracts.

Route: /docs/quick-start

If you are starting a new consumer repo, keep the integration narrow at first:

  1. define your Question and ConceptNode shapes
  2. add a scheduler policy
  3. wire a small workflow shell around session and debug helpers

Minimal content types

import type { ConceptNode, Question } from '@brandon-gottshall/review-game-core'

// `Question.type` is the renderer discriminator — each game defines its own union.
// Learning stages are tracked by the quiz engine's `QuizEnginePhase`, not by this field.
type CourseQuestionType = 'multiple_choice' | 'numeric' | 'code_trace'

export type CourseQuestion = Question<CourseQuestionType>
export type CourseConcept = ConceptNode

Minimal scheduler path

import {
  applyConceptOutcome,
  buildInitialConceptSchedule,
  createSchedulerPolicy,
  pickNextConceptId,
} from '@brandon-gottshall/review-game-core'

Minimal workflow path

import {
  buildSessionStorageKey,
  createSessionIdentity,
  createSessionSnapshot,
} from '@brandon-gottshall/review-game-core'

From there, branch into the docs that match your needs: