THU-MAIC/OpenMAIC

Get an immersive, multi-agent learning experience in just one click

English | Simplified Chinese
Live Demo · Quick Start · Lemonade · FunASR · Features · Use Cases · OpenClaw

• 2026-10-04 — v1.2.0-rc.1 (pre-release): server-first. Until 1.1.x, the browser drove course generation step by step and kept courses, keys and model settings itself, so closing the tab stopped a course halfway, every browser had to be configured on its own, and the headless API ran a separate pipeline. In 1.2.0 the server owns all of it: generation runs on the server and survives closed tabs and restarts, models are configured once in openmaic.yml (with defaults, locks and an option to forbid user keys), materials are parsed as soon as they are attached, and the web app and the API share one pipeline. It needs PostgreSQL and a long-running server; Vercel deployments stay on 1.1.x. Read the changelog before upgrading.
• 2026-09-28 — v1.1.2: security — provider requests connect only to validated addresses and refuse redirects (GHSA-g87c-cm4q-cw5x).
• 2026-09-27 — v1.1.1: security — hardened MinerU Cloud parsing (GHSA-cpjc-vgjh-c5jp).
• 2026-09-24 — v1.1.0: agentic classroom chat (ask about any slide element, interactive, or whiteboard drawing); settings rebuilt around the course workflow; Token Plan connections.
• 2026-09-15 — v1.0.3: security — access-code tokens expire, render-service network policy, pinned audio connections, Next.js RCE patch.
• 2026-09-14 — v1.0.2: security — SSRF and DNS-rebinding fixes, classroom overwrite fix.
• 2026-09-06 — v1.0.1: security and stability; tightens two defaults.
• 2026-08-27 — v1.0.0: agent workbench, durable sessions, reusable skills, session materials, provider-neutral capabilities.

Full history in the changelog.

OpenMAIC (Open Multi-Agent Interactive Classroom) is an open-source AI platform that turns any topic or document into a rich, interactive classroom experience. Powered by multi-agent orchestration, it generates slides, quizzes, interactive simulations, and project-based learning activities — all delivered by AI teachers and AI classmates who can speak, draw on a whiteboard, and engage in real-time discussions with you. The built-in OpenMAIC Skill works with OpenClaw as well as agent workbenches such as Codex, DeepSeek, and WorkBuddy, so you can generate classrooms from messaging apps like Feishu, Slack, or Telegram, or right inside your IDE.

• One-click lesson generation — Describe a topic or attach your materials; the AI builds a full lesson in minutes
• Multi-agent classroom — AI teachers and peers lecture, discuss, and interact with you in real time
• Rich scene types — Slides, quizzes, interactive HTML simulations, and project-based learning (PBL)
• Whiteboard & TTS — Agents draw diagrams, write formulas, and explain out loud
• Export anywhere — Download editable .pptx slides or interactive .html pages
• Agent workbench integration — The OpenMAIC Skill supports OpenClaw, Codex, DeepSeek, WorkBuddy, and more — generate classrooms from Feishu, Slack, Telegram, 20+ messaging apps, or your IDE

• Node.js >= 22.19
• pnpm >= 10
• PostgreSQL 16 — courses are stored on the server. For local development pnpm db:up starts one in Docker for you.

git clone https://github.com/THU-MAIC/OpenMAIC.git
cd OpenMAIC
pnpm install

cp .env.example .env.local            # API keys and server options
cp openmaic.example.yml openmaic.yml  # which models the server uses

The copied example needs only OPENAI_API_KEY in .env.local (or change its provider to one you have a key for); everything else in it is commented out until you want it. openmaic.yml declares providers (accounts the server can call) and gives each slot (a use of AI: the outline, slide content, text to speech, web search, …) a model. Keys stay in .env.local and are referenced as ${VAR}:

providers:
  openai:
    preset: openai
    apiKey: ${OPENAI_API_KEY}      # OPENAI_API_KEY=sk-... in .env.local
  anthropic:
    preset: anthropic
    apiKey: ${ANTHROPIC_API_KEY}

slots:
  llm: openai:gpt-5.5              # the default chat model
  course.outline: anthropic:claude-sonnet-4-6
  video: null                      # turn a capability off

The slots you write are the server's defaults; users can change them, or connect services of their own, in the app's model settings unless you lock them or set allowUserKeys: false. The server validates the file at startup and names every mistake by its field (or, for broken YAML, its line).

Providers: OpenAI, Azure OpenAI, Anthropic, Amazon Bedrock, Google Gemini, DeepSeek, Qwen, Kimi, MiniMax, Grok (xAI), OpenRouter, TokenDance, Doubao, Tencent Hunyuan/TokenHub, Xiaomi MiMo, GLM (Zhipu), Ollama, Lemonade and FunASR (local), and any OpenAI-compatible API.

providers:
  minimax:
    preset: minimax
    apiKey: ${MINIMAX_API_KEY}

slots:
  llm: minimax:MiniMax-M3
  image: minimax                   # a provider id alone: the plan's default model
  video: minimax
  tts: minimax
  webSearch: minimax

providers:
  tokendance:
    preset: tokendance
    apiKey: ${TOKENDANCE_API_KEY}

slots:
  llm: tokendance:deepseek-v4.1-flash
  image: tokendance
  video: tokendance
  tts: tokendance
  webSearch: tokendance

providers:
  mimo:
    preset: xiaomi
    apiKey: ${MIMO_API_KEY}
    baseUrl: https://token-plan-cn.xiaomimimo.com/v1
  glm:
    preset: glm
    apiKey: ${GLM_API_KEY}
    baseUrl: https://open.bigmodel.cn/api/paas/v4   # or https://api.z.ai/api/paas/v4

slots:
  llm: mimo:mimo-v2.5-pro
  course.content: glm:glm-5.1

providers:
  bedrock:
    preset: bedrock
    models: [us.anthropic.claude-sonnet-5, us.anthropic.claude-opus-4-8]

slots:
  llm: bedrock:us.anthropic.claude-sonnet-5

pnpm db:up

Then uncomment the local DATABASE_URL line in .env.local:

DATABASE_URL=postgres://openmaic:openmaic-dev@127.0.0.1:5432/openmaic

pnpm db:up starts a development PostgreSQL on 127.0.0.1:5432 (set OPENMAIC_DB_PORT for another port). It is its own Compose project, openmaic-dev-db, shared by every checkout on this machine, with its own container and volume, so it never touches the database of a docker compose up stack. pnpm db:down stops it and keeps the data. Any other PostgreSQL works too.

pnpm dev

Open http://localhost:3000 and start learning! Without a DATABASE_URL the server refuses to start and tells you how to provide one (see Server-backed persistence).

pnpm build && DATABASE_URL=postgres://... pnpm start

Keep the server running as a long-running process (a process manager or a container): course generation runs inside it and continues after the browser leaves the page. See the Deployment guide for the required configuration and for upgrading from 1.1.x.

cp .env.example .env.local
# Edit .env.local with your API keys, then:
docker compose up --build

Open http://localhost:3000. The stack is two containers, the app and PostgreSQL. Courses, generated media and runtime sessions live in the named volumes openmaic-postgres and openmaic-data, which survive docker compose down and rebuilds; docker compose down -v deletes them. To configure models with openmaic.yml, create it from openmaic.example.yml and uncomment its mount in docker-compose.yml; otherwise connect a model service in the model settings once the app is running.

The Compose file is a personal installation: it runs in single-user mode (every browser sees one shared library) and listens on 127.0.0.1:3000 only. To serve other machines, protect it first:

1. Set a long random ACCESS_CODE in .env.local (details). Without it, anyone who can reach the port owns, edits and can delete the whole library.

2. Before the first start, set PERSISTENCE_POSTGRES_PASSWORD to a random value of letters and digits.

3. Publish on the network address:

   OPENMAIC_PUBLISH_ADDRESS=0.0.0.0 docker compose up -d --build

OPENMAIC_PUBLISH_ADDRESS, OPENMAIC_PORT and PERSISTENCE_POSTGRES_PASSWORD come from your shell or a .env file next to docker-compose.yml, not from .env.local. Overriding the Compose defaults, rotating the database password and the full upgrade notes are in Hosting and identity.

ALPINE_MIRROR=mirrors.tuna.tsinghua.edu.cn \
NPM_REGISTRY=https://registry.npmmirror.com \
docker compose up --build

docker build \
  --build-arg ALPINE_MIRROR=mirrors.tuna.tsinghua.edu.cn \
  --build-arg NPM_REGISTRY=https://registry.npmmirror.com \
  -t openmaic:local .

Serverless deployment is supported up to OpenMAIC 1.1.x. From 1.2.0, course generation runs on the server in a process that outlives requests, so OpenMAIC needs a long-running Node.js process with PostgreSQL (the Docker deployment or pnpm start); Vercel and other serverless hosts are not supported, and the repository no longer ships a vercel.json. To deploy 1.1.x on Vercel:

1. Fork this repository on GitHub, unchecking Copy the main branch only.
2. In the fork, set the default branch to release/1.1.x (Settings → General → Default branch).
3. In Vercel, Add New → Project and import the fork. Vercel builds its default branch; configure at least one LLM provider key as described in that branch's .env.example.

Such a deployment can move to a long-running host later without losing data: point the new host's DATABASE_URL at the database it used, if it used one, and serve it at the same address, since browsers keep their data per site; the courses visitors kept in their browsers are imported the first time each browser opens the upgraded app. See Upgrading from 1.1.x for every kind of deployment.

OpenMAIC keeps courses on the server. Course documents, folders, chat history, learner sessions and generated media live in PostgreSQL (media optionally in S3), served by the app itself at /api/persistence. The browser keeps only what belongs to the device, such as settings, playback position and caches; Settings → Clear Local Cache never touches the server.

• DATABASE_URL is required. Without it the server prints the fix and exits with code 1. Compose sets it for you; for development, pnpm db:up starts a database.
• Courses an older build kept in the browser are imported once per browser, automatically, the first time it opens the upgraded app. The browser copy is left untouched.
• Invalid settings stop the server at startup with a one-line [boot] reason instead of a server that answers every request with 500.

Who owns a course. Every request resolves to an owner, and each owner has its own library. Pick one identity mode:

Set the mode before the first start of 1.2.0: classrooms that 1.1.x saved as files are imported for the owner configured then. See Upgrading from 1.1.x for every kind of deployment.

Running OpenMAIC for other people, or embedding it in your own product? Hosting and identity covers:

• who can read and write stored data, and the removed PERSISTENCE_DEV_TOKEN;
• asset collection, quotas and S3 egress (ASSET_*);
• every startup check;
• owner identity: single-user mode, registering auth methods, a signed-JWT gateway recipe and claiming anonymous work;
• host extension hooks for course creation, the library, uploads and asset byte stores.

Protect a deployment with a site-level password in .env.local:

ACCESS_CODE=your-secret-code

Use a long random value, at least 16 characters from a random generator: it is the only secret guarding the deployment. Visitors then see a password prompt, and every API route is gated too. When it is unset (the default in .env.example), middleware.ts checks no credential and every route, the API included, is reachable: an unconfigured deployment is not gated, and there is no second enforcement point. The code is remembered for 7 days in a signed HTTP-only cookie; attempts are rate limited only behind a trusted proxy with TRUST_PROXY_HEADERS=true. See Configuration → ACCESS_CODE.

The Pro workbench, a course-building surface entered from the home page, is off by default. Turn on its build-time entry point and the server runtime; it uses the same PostgreSQL as the rest of the app:

NEXT_PUBLIC_PRO_WORKBENCH_ENABLED=true
OPENMAIC_AGENT_RUNTIME_ENABLED=true
DATABASE_URL=postgres://openmaic:openmaic-dev@postgres:5432/openmaic

The agent runs on the agent slot, which follows the default chat model unless assigned and needs a model with tool calling:

slots:
  llm: openai:gpt-5.5
  agent:
    model: openai:gpt-5.5
    api: openai-completions        # or openai-responses

The agent slot must not set thinking.effort. Its routes, the DEFAULT_MODEL caveat and runner tuning are in Hosting and identity.

OpenMAIC supports Lemonade as a local, OpenAI-compatible provider for LLMs, image generation, TTS, and ASR. No API key is required.

Run Lemonade locally, then point OpenMAIC to it:

providers:
  lemonade:
    preset: lemonade
    baseUrl: http://localhost:13305/v1
  lemonade-tts:
    preset: lemonade-tts
    baseUrl: http://localhost:13305/v1
  lemonade-asr:
    preset: lemonade-asr
    baseUrl: http://localhost:13305/v1
  lemonade-image:
    preset: lemonade-image
    baseUrl: http://localhost:13305/v1

slots:
  llm: lemonade:Gemma-4-26B-A4B-it-GGUF
  tts: lemonade-tts
  asr: lemonade-asr
  image: lemonade-image

With the legacy variables, the same is LEMONADE_BASE_URL, TTS_LEMONADE_BASE_URL, ASR_LEMONADE_BASE_URL and IMAGE_LEMONADE_BASE_URL.

OpenMAIC can transcribe locally through FunASR's OpenAI-compatible server. The built-in provider supports SenseVoiceSmall, Paraformer, and Fun-ASR-Nano and requires no API key.

python -m pip install torch torchaudio
python -m pip install "funasr==1.4.0" fastapi uvicorn python-multipart
# Add vLLM for Fun-ASR-Nano on NVIDIA GPUs
python -m pip install vllm
funasr-server --device cuda --model fun-asr-nano

Point OpenMAIC at the server:

providers:
  funasr:
    preset: funasr-asr
    baseUrl: http://localhost:8000/v1

slots:
  asr: funasr

(Legacy variable: ASR_FUNASR_BASE_URL=http://localhost:8000/v1.)

Use funasr-server --device cpu --model sensevoice for a CPU-only setup. See the FunASR deployment guide for production options.

OpenMAIC can extract timestamped transcripts and prepared video keyframes locally. Install the system ffmpeg package so both ffmpeg and ffprobe are executable on PATH, then assign the asr slot (for example FunASR, Lemonade, or OpenAI) as above. The application resolves the executables at extraction time; ffmpeg is not an npm dependency and is not required to start or use OpenMAIC.

If the executables are unavailable, the local extractor is skipped. A configured AliDocMind provider remains available as the cloud extraction path. When neither local ffmpeg extraction nor AliDocMind is available, audio/video materials are marked failed with an actionable setup message instead of hanging or completing with an empty transcript.

The "Export Video" menu builds a self-contained Hyperframes project entirely in the browser. Turning that into an MP4 needs Chromium + FFmpeg on Node 22, so it runs in an isolated render-service container rather than the app.

It's opt-in. Start it with the video-export compose profile:

docker compose --profile video-export up --build

The app auto-detects the service via RENDER_SERVICE_URL (preset in docker-compose.yml) and enables one-click MP4 rendering. Without the profile — or when RENDER_SERVICE_URL is unset — export degrades to downloading the project ZIP for local CLI rendering. See render-service/README.md for standalone setup and tuning (RENDER_MAX_CONCURRENCY, etc.).

MinerU provides enhanced parsing for complex tables, formulas, and OCR. You can use the MinerU official API or self-host your own instance.

Declare it in openmaic.yml and assign the document slot to it: mineru-cloud for the official API, or mineru with the baseUrl of your own instance.

providers:
  mineru:
    preset: mineru-cloud
    apiKey: ${PDF_MINERU_CLOUD_API_KEY}

slots:
  document: mineru

Without openmaic.yml, the legacy variables PDF_MINERU_CLOUD_API_KEY or PDF_MINERU_BASE_URL in .env.local still work.

VoxCPM2 is an open-source TTS model from OpenBMB with voice cloning. OpenMAIC ships an adapter; run VoxCPM on your own hardware and OpenMAIC will talk to it.

1. Run a VoxCPM backend. Three deployment styles, all behind the same OpenMAIC adapter. You pick which one with options.backend in openmaic.yml (step 2).

See the VoxCPM repo for backend setup.

2. Point OpenMAIC at it. VoxCPM2 runs on your own network, so the deployment configures it in openmaic.yml (no API key required); workspaces cannot add it in Settings → Model Services:

providers:
  voxcpm:
    preset: voxcpm-tts
    baseUrl: http://localhost:8000/v1
    options:
      backend: vllm-omni          # vllm-omni (default) | python-api | nano-vllm

slots:
  tts: voxcpm

Voice registration works only on the vllm-omni backend; python-api and nano-vllm send the voice prompt with each request.

Without openmaic.yml, the legacy TTS_VOXCPM_BASE_URL=http://localhost:8000/v1 sets the endpoint but cannot choose a backend.

3. Manage voices. With VoxCPM2 assigned to the tts slot, open Settings → Model Services → Text-to-Speech → VoxCPM2 (the voice manager appears only when tts resolves to a voxcpm-tts provider). Three voice modes:

• Auto Voice (default): OpenMAIC generates a voice prompt from each agent's persona at synthesis time. No setup required.
• Prompt voice: describe the voice in natural language, e.g. "warm female teacher voice, calm and encouraging, mid-pitch".
• Clone voice: upload a short reference audio clip or record one in the browser. The clip is stored in this browser (IndexedDB) and sent to your VoxCPM backend on each synthesis.

The workbench adds a conversational course-building agent to OpenMAIC. Its durable sessions can be resumed after a worker restart, accept follow-up instructions while running, and stream a replayable event history to the chat surface.

Open it from the Pro control on the home page. The workspace combines a transient, collapsible folders/conversations rail with a chat pane and a classroom pane whose open courses stay in tabs. Workspace controls return to classic mode, and either entry remains gated by the public workbench flag plus the configured server runtime.

The agent works through explicit, validated tools rather than editing opaque blobs:

Twenty-four built-in skills cover curriculum planning, deep research, interactive, lecture, workshop, vocational, and other teaching styles, slide/stage craft, PPTX import, editing, and style reuse. User-authored skills are stored per owner and can be created, read, and patched through the same runtime.

The server-backed workbench also exposes owner-scoped folder routes and a per-viewer stage metadata sidecar for ownership, publication, and generation-complete state. A stage ID acts as the capability for reading a non-deleted course, but stage mutations remain restricted to its owner. The material upload contract stores supported source bytes before lease-fenced document or media extraction records derived text and images; media extraction can select AliDocMind or the optional local ffmpeg/ffprobe provider.

Under the hood, agent sessions are database-backed with leases, heartbeats, crash resume, cancellation, and follow-up steering, and database-maintained revision counters keep per-stage and per-scene freshness monotonic so the workbench refetches only the scenes that changed. Server routes resolve LLM, media, ASR/TTS, and search configuration provider-neutrally: credentials never reach the browser, uniform <CAP>_<PREFIX>_ENABLED=false switches can force off any served capability, startup validation warns about bad model configuration, and unresolved model routes fail loudly instead of guessing a vendor.

OpenMAIC stores course documents, learner runtime records and assets on the server, in PostgreSQL. The @openmaic/storage package defines swappable stores for those primitives — PostgreSQL-backed documents, learner runtime, assets, durable agent sessions, session materials, and user skills, plus browser implementations for embedders — and HTTP clients connect the browser to the embedded persistence endpoint, while the server asset layer can keep bytes in PostgreSQL or S3. Device-scoped KV values (settings, playback position) stay in the browser.

Passive listening? ❌ Hands-on exploration! ✅

As Einstein said: "Play is the highest form of research."

While Standard Mode focuses on quickly generating classroom content, Deep Interactive Mode goes further — creating interactive, explorable, hands-on learning experiences. Students don't just watch knowledge; they adjust experiments, observe simulations, and actively explore how things work.

🌐 3D Visualization Three-dimensional visual representations that make abstract structures more intuitive.	⚙️ Simulation Process simulations and experimental environments for observing dynamic changes and outcomes.
🎮 Game Knowledge-based mini-games that reinforce understanding and memory through interactive challenges.	🧭 Mind Map Structured knowledge organization to help learners build an overall conceptual framework.
💻 Online Programming In-browser coding and instant execution for learning by writing, testing, and iterating.

The AI teacher can actively operate the UI to guide students — highlighting key areas, setting conditions, providing hints, and directing attention at the right moments.

All generated interactive UI is fully responsive — desktop, tablet, or mobile.

Desktop	Mobile
iPad

If you are looking for a version with richer functionality, stronger interactivity, and deeper optimization for high-quality educational UI production, please visit MAIC-UI.

Describe what you want to learn or attach reference materials. PDF, Word, PowerPoint, spreadsheet, text, image, audio, and video inputs can enter the material pipeline; configured extractors turn supported sources into content for generation. OpenMAIC's classic two-stage pipeline handles the rest:

🎓 Slides AI teachers deliver lectures with voice narration, spotlight effects, and laser pointer animations — just like a real classroom.	🧪 Quiz Interactive quizzes (single / multiple choice, short answer) with real-time AI grading and feedback.
🔬 Interactive Simulation HTML-based interactive experiments for visual, hands-on learning — physics simulators, flowcharts, and more.	🏗️ Project-Based Learning (PBL) Choose a role and collaborate with AI agents on structured projects with milestones and deliverables.

Classroom Discussion — Agents proactively initiate discussions; you can jump in anytime or get called on Roundtable Debate — Multiple agents with different personas discuss a topic, with whiteboard illustrations Q&A Mode — Ask questions freely; the AI teacher responds with slides, diagrams, or whiteboard drawings Whiteboard — AI agents draw on a shared whiteboard in real time — solving equations step by step, sketching flowcharts, or illustrating concepts visually.

The OpenMAIC skill package (skills/openmaic/) uses the standard SKILL.md format and can be loaded by various agent workbenches — besides OpenClaw, this includes Codex, DeepSeek, WorkBuddy, and others. It is a guided SOP covering the live demo, local setup, classroom generation, and secondary development on top of the @openmaic/* SDK. OpenClaw is a personal AI assistant that connects to the messaging platforms you already use (Feishu, Slack, Discord, Telegram, WhatsApp, etc.). With this integration, you can generate and view interactive classrooms directly from your chat app without ever touching a terminal.

Just tell your agent assistant what you want to learn — it handles everything else:

• Hosted mode — Grab an access code from open.maic.chat, save it in your config, and generate classrooms instantly — no local setup required
• Self-hosted mode — Clone, install dependencies, configure API keys, and start the server — the skill guides you through each step
• Track progress — Poll the async generation job and send you the link when ready
• Secondary development — Guide you through building on top of OpenMAIC: create your own app with the @openmaic/* SDK (see the extend docs inside the skill)

Every step asks for your confirmation first. No black-box automation.

clawhub install openmaic

{
  "skills": {
    "entries": {
      "openmaic": {
        "config": {
          // Hosted mode: paste your access code from open.maic.chat
          "accessCode": "sk-xxx",
          // Self-hosted mode: local repo path and URL
          "repoDir": "/path/to/OpenMAIC",
          "url": "http://localhost:3000"
        }
      }
    }
  }
}

Importing a classroom ZIP stores its embedded audio, images, video, and posters in the server asset pool before saving the course, so other browsers resolve those assets without the importing browser's cache. A ZIP is also a way to move a course between deployments: export it from one and import it on the other.

Offline / intranet classrooms: When you export a classroom (.maic.zip) or a Resource Pack, OpenMAIC inlines the external assets referenced by interactive scenes (KaTeX, Three.js incl. three/addons, Tailwind CDN, Google Fonts, images) into the exported HTML as data: URIs. The exported course then plays fully offline after import into an air-gapped/intranet instance — no public CDN is contacted at playback time. Assets that can't be fetched at export time (e.g. CORS-restricted image hosts) are reported and left as URLs. Classrooms exported before this feature still reference CDNs and must be re-exported to gain offline support.

• Text-to-Speech — Multiple voice providers with customizable voices
• Speech Recognition — Talk to your AI teacher using your microphone
• Web Search — Agents search the web for up-to-date information during class
• Provider controls — Server-side capability discovery, model resolution, force-off switches, and fail-loud routing keep deployments explicit
• Course freshness — Database-triggered per-scene revision counters, freshness events, and targeted scene fetches keep workbench views synchronized
• i18n — Interface supports 12 locales across 11 languages: Simplified Chinese, Traditional Chinese, English, Japanese, Korean, Russian, Arabic, Portuguese (Brazil), Spanish (Mexico), French, Vietnamese, and German
• Dark Mode — Easy on the eyes for late-night study sessions

"Teach me Python from scratch in 30 min"	"How to play the board game Avalon"
"Analyze the stock prices of Zhipu and MiniMax"	"Break down the latest DeepSeek paper"

We welcome contributions from the community! Whether it's bug reports, feature ideas, or pull requests — every bit helps.

OpenMAIC/
├── app/                        # Next.js App Router
│   ├── api/                    #   Generation, media, persistence, and agent APIs
│   │   ├── agent/              #     Durable session, event, material, and skill control plane
│   │   ├── stages/             #     Owner-scoped course reads, writes, manifests, and scene fetches
│   │   ├── generate/           #     Images, video, TTS and voice registration
│   │   ├── generate-classroom/ #     Async classroom job submission + polling
│   │   ├── chat/               #     Multi-agent discussion (SSE streaming)
│   │   ├── pbl/                #     Project-Based Learning endpoints
│   │   ├── persistence/        #     Embedded persistence service (Runtime/Document Store HTTP contracts)
│   │   ├── export-video/       #     MP4 video export (backs onto render-service)
│   │   └── ...                 #     generation-runs, materials, quiz-grade, parse-pdf, transcription, etc.
│   ├── classroom/[id]/         #   Classroom playback page
│   └── page.tsx                #   Home page (generation input)
│
├── lib/                        # Core business logic
│   ├── generation/             #   Two-stage lesson generation pipeline
│   ├── orchestration/          #   LangGraph multi-agent orchestration (director graph)
│   ├── playback/               #   Playback state machine (idle → playing → live)
│   ├── action/                 #   Action execution engine (speech, whiteboard, effects)
│   ├── ai/                     #   LLM provider abstraction
│   ├── api/                    #   Stage API facade (slide/canvas/scene manipulation)
│   ├── store/                  #   Zustand state stores
│   ├── types/                  #   Centralized TypeScript type definitions
│   ├── audio/                  #   TTS & ASR providers
│   ├── media/                  #   Image & video generation providers
│   ├── persistence/            #   Browser/server persistence wiring and PostgreSQL provider
│   ├── server/agent-runtime/   #   Durable runner, skills, materials, and course-building tools
│   ├── export/                 #   PPTX & HTML export
│   ├── hooks/                  #   React custom hooks (55+)
│   ├── i18n/                   #   Internationalization (zh-CN, zh-TW, en-US, ja-JP, ko-KR, ru-RU, ar-SA, pt-BR, es-MX, fr-FR, vi-VN, de-DE)
│   └── ...                     #   prosemirror, storage, pdf, web-search, utils
│
├── components/                 # React UI components
│   ├── slide-renderer/         #   Canvas-based slide editor & renderer
│   │   ├── Editor/Canvas/      #     Interactive editing canvas
│   │   └── components/element/ #     Element renderers (text, image, shape, table, chart …)
│   ├── scene-renderers/        #   Quiz, Interactive, PBL scene renderers
│   ├── generation/             #   Lesson generation toolbar & progress
│   ├── workbench/              #   Pro workbench conversation and course-reference UI
│   ├── chat/                   #   Chat area & session management
│   ├── settings/               #   Settings panel (providers, TTS, ASR, media …)
│   ├── whiteboard/             #   SVG-based whiteboard drawing
│   ├── agent/                  #   Agent avatar, config, info bar
│   ├── ui/                     #   Base UI primitives (shadcn/ui + Radix)
│   └── ...                     #   audio, roundtable, stage, ai-elements
│
├── packages/                   # Workspace packages
│   ├── @openmaic/dsl/          #   Versioned course/slide data contract and validators
│   ├── @openmaic/renderer/     #   React renderer for the slide DSL
│   ├── @openmaic/editor/       #   Composable slide editing core and React surface
│   ├── @openmaic/importer/     #   PPTX → OpenMAIC slide importer
│   ├── @openmaic/generation/   #   Generation contracts, pipeline, and prompt assets
│   ├── @openmaic/storage/      #   Browser, HTTP, PostgreSQL, and S3 persistence primitives
│   ├── pptxgenjs/              #   Customized PowerPoint generation
│   └── mathml2omml/            #   MathML → Office Math conversion
│
├── render-service/             # MP4 video export render service (Chromium + FFmpeg, standalone container)
│
├── skills/                     # OpenClaw / ClawHub skills
│   └── openmaic/               #   Guided OpenMAIC setup & generation SOP
│       ├── SKILL.md            #   Thin router with confirmation rules
│       └── references/         #   On-demand SOP sections (generation, deployment, extending, …)
│
├── configs/                    # Shared constants (shapes, fonts, hotkeys, themes …)
└── public/                     # Static assets (logos, avatars)

• Generation Pipeline (@openmaic/generation) — Two-stage: outline generation → scene content generation
• Agent Runtime (lib/server/agent-runtime/) — PostgreSQL-backed sessions with leased execution, resume/steer semantics, skills, materials, and validated course tools
• Persistence Layer (@openmaic/storage) — Swappable document, runtime, KV, asset, agent-session, material, and user-skill stores
• Multi-Agent Orchestration (lib/orchestration/) — LangGraph state machine managing agent turns and discussions
• Playback Engine (lib/playback/) — State machine driving classroom playback and live interaction
• Action Engine (lib/action/) — Executes 21 action types (speech, whiteboard draw/text/shape/chart, spotlight, laser …)
• Storage Layer (@openmaic/storage) — Runtime/Document/asset storage abstraction with a Postgres reference implementation; its HTTP contracts let you plug in any external storage service

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

This project is licensed under the MIT License, so commercial use is permitted free of charge. For partnership or collaboration inquiries, please contact: thu_maic@mail.tsinghua.edu.cn

If you find OpenMAIC useful in your research, please consider citing:

@Article{JCST-2509-16000,
  title = {From MOOC to MAIC: Reimagine Online Teaching and Learning through LLM-driven Agents},
  journal = {Journal of Computer Science and Technology},
  volume = {},
  number = {},
  pages = {},
  year = {2026},
  issn = {1000-9000(Print) /1860-4749(Online)},
  doi = {10.1007/s11390-025-6000-0},
  url = {https://jcst.ict.ac.cn/en/article/doi/10.1007/s11390-025-6000-0},
  author = {Ji-Fan Yu and Daniel Zhang-Li and Zhe-Yuan Zhang and Yu-Cheng Wang and Hao-Xuan Li and Joy Jia Yin Lim and Zhan-Xin Hao and Shang-Qing Tu and Lu Zhang and Xu-Sheng Dai and Jian-Xiao Jiang and Shen Yang and Fei Qin and Ze-Kun Li and Xin Cong and Bin Xu and Lei Hou and Man-Li Li and Juan-Zi Li and Hui-Qin Liu and Yu Zhang and Zhi-Yuan Liu and Mao-Song Sun}
}

This project is licensed under the MIT License.

The repository bundles workspace packages that are not covered by the root MIT license and keep their own terms:

• packages/mathml2omml — LGPL-3.0-or-later
• packages/pptxgenjs — MIT (third-party)

When redistributing the repository as a whole, the terms of each bundled package above apply to that package's files.