How to Build an Examen Module

1 · Module-level metadata

Every module must identify itself with a few required fields: producer, name, and version. You can also add an optional description and an accent color (hex, e.g. #7E57C2).

In Markdown this goes in the YAML frontmatter block at the top of the file (between --- delimiters).

{
  "producer": "Your Name",
  "name": "My Module",
  "version": "1.0.0",
  "description": "A brief description.",
  "color": "#7E57C2"
}

---
producer: Your Name
name: My Module
version: 1.0.0
description: A brief description.
color: "#7E57C2"
---

2 · Sections

A module is divided into one or more thematic sections (e.g. "First Commandment", "Capital Sins — Pride"). Each section needs:

• name — the section heading
• category — grouping key (e.g. TEN_COMMANDMENTS, SEVEN_CAPITAL_SINS, CUSTOM)
• framework — examination framework (e.g. TEN_COMMANDMENTS, CAPITAL_SINS, CUSTOM)
• scripture (optional) — scripture reference to display in the section header
• description (optional) — a short explanatory note for the section

{
  "sections": [
    {
      "name": "First Commandment",
      "category": "TEN_COMMANDMENTS",
      "framework": "TEN_COMMANDMENTS",
      "scripture": "I am the Lord your God… (Ex 20:2)",
      "description": "Questions about faith and worship.",
      "questions": []
    }
  ]
}

3 · Questions

Each section contains one or more questions. Every question requires:

• text — the examination question, phrased as a yes/no question (e.g. "Have you…?")
• confessionText — the matching "I" statement used when composing a confession (e.g. "I …")
• applicableTo (optional) — restrict the question to certain life states such as MARRIED, PARENT, SINGLE_ADULT, etc. Omit to show the question to everyone.

In Markdown, questions are numbered headings (### 1), the confession text is a blockquote (> I …) placed immediately after the question, and the optional - **Applicable To:** VALUE line comes after the blockquote.

"questions": [
  {
    "text": "Have you missed Sunday Mass?",
    "confessionText": "I missed Sunday Mass.",
    "applicableTo": ["MARRIED", "PARENT"]
  }
]

### 1
Have you missed Sunday Mass?
> I missed Sunday Mass.
- **Applicable To:** MARRIED, PARENT