VaultQuiz

Turn your own Obsidian notes into a daily multiple-choice quiz and build a study streak — generated and played entirely inside Obsidian. Bring your own LLM key (MiniMax, OpenRouter, or any OpenAI-compatible API). No server, no account, no sync.

Features

• Daily quiz — generate up to N (default 5) multiple-choice questions from the folders you choose. Answer one at a time, see the correct answer and an explanation, and a final score.
• Participation streak — a day counts when you finish all of that day's questions on an active day (configurable, e.g. Mon–Fri). Miss a day and a streak freeze is spent automatically; earn one freeze every 21 completions, up to 3.
• One-screen dashboard — current streak and freezes, today's score, 30-day rolling accuracy, and a 12-week completion heatmap.
• Best-effort auto-generate — optionally generate at a set time each day. It runs when Obsidian is open, and otherwise catches up the next time you open Obsidian (a plugin can't run while Obsidian is closed).
• Optional Markdown log — off by default; when enabled, each completed day's result is written to a note in a folder you choose.
• Mobile-ready — works on Obsidian desktop and mobile.

Install

From Obsidian: Settings → Community plugins → Browse → search "VaultQuiz" → Install → Enable.

Beta / latest builds (optional): install BRAT, then Add beta plugin → FilhoRicardo/vaultquiz.

Manual (optional): download main.js, manifest.json, and styles.css from the latest release into <vault>/.obsidian/plugins/vaultquiz/, then enable it in Settings → Community plugins.

Setup

1. Install and enable VaultQuiz.
2. Open Settings → VaultQuiz:
   • Source folders — the vault folders to quiz from (one per line). Only these are read.
   • Provider / API key / model — pick MiniMax (pre-filled and ready), OpenRouter, or a custom OpenAI-compatible endpoint, and paste your key.
   • Active days, auto-generate, and the optional Markdown log.
3. Open VaultQuiz from the ribbon (brain icon) or the command palette, and press Generate quiz.

Commands

Privacy

• Your notes leave the vault only at generation time. When you generate a quiz, sampled text from your selected notes is sent to the LLM provider you configure — and to no one else. VaultQuiz makes no other network calls; playing a quiz is fully offline.
• Your API key is stored unencrypted in this vault (.obsidian/plugins/vaultquiz/data.json), the same as any Obsidian plugin secret. Use a key you're comfortable storing locally.
• No telemetry, no accounts, no third-party servers beyond your chosen LLM provider.

How it works

VaultQuiz does no work at Obsidian startup. When you generate, it samples note chunks from your folders, asks your LLM for multiple-choice questions, keeps the well-formed ones, and stores them (with your answers and streak state) in the plugin's data.json. The streak is tracked incrementally, so changing your active days or question count never rewrites a streak you already earned.

License

MIT