# letseries/letmeask architecture

> Architecture diagram of the GitHub repository letseries/letmeask, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/letseries/letmeask
- Repository: https://github.com/letseries/letmeask

## Overview

LetMeAsk is a Paper/Spigot plugin for timed Minecraft chat quizzes. Its main workflow is to publish a configured question, accept player answers, match them with configurable fuzzy tolerance, apply anti-bot verification when triggered, and award correct responders through an economy provider. The README also documents admin commands, statistics and leaderboards, timeout handling, and celebration effects. QuizPlugin.java is the central runtime coordinator; the excerpts show its delegation to matching, economy, and message helpers. Other wiring is represented only where documented in the README.

Main entry points: [`src/main/java/com/cubex/quiz/QuizPlugin.java`](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java) (Quiz Coordinator), [`src/main/resources/base.yml`](https://github.com/letseries/letmeask/blob/main/src/main/resources/base.yml) (Plugin Settings), [`src/main/java/com/cubex/quiz/EconomyBridge.java`](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/EconomyBridge.java) (Economy Bridge), [`src/main/java/com/cubex/quiz/Messages.java`](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/Messages.java) (Message Center)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_quiz["Quiz Runtime"]
  node_quiz_runtime["Quiz Coordinator<br/>[QuizPlugin.java]"]
  node_question_bank["Question Bank<br/>[QuizPlugin.java]"]
end

subgraph group_answer["Answer Handling"]
  node_answer_matcher["Fuzzy Matcher"]
  node_anti_bot["Anti-bot Checks<br/>[QuizPlugin.java]"]
end

subgraph group_services["Rewards And Output"]
  node_economy_bridge["Economy Bridge<br/>[EconomyBridge.java]"]
  node_messages["Message Center<br/>[Messages.java]"]
  node_celebration["Answer Celebration<br/>[QuizPlugin.java]"]
end

subgraph group_state["Configuration And Stats"]
  node_base_config["Plugin Settings<br/>[base.yml]"]
  node_question_config["Question Settings<br/>[questions.yml]"]
  node_stats[("Quiz Statistics<br/>[QuizPlugin.java]")]
end

node_player(("Player"))
node_admin(("Admin / Commands"))
node_paper["Paper / Spigot"]
node_human_verify["HumanVerify"]
node_vault["Vault Economy"]

node_admin -->|"controls"| node_quiz_runtime
node_player -->|"answers in chat"| node_quiz_runtime
node_quiz_runtime -->|"schedules and broadcasts"| node_paper
node_question_config -->|"defines questions"| node_question_bank
node_base_config -->|"configures timing"| node_quiz_runtime
node_quiz_runtime -->|"selects questions"| node_question_bank
node_quiz_runtime -->|"delegates matching"| node_answer_matcher
node_quiz_runtime -->|"checks answer behavior"| node_anti_bot
node_anti_bot -.->|"requests verification"| node_human_verify
node_quiz_runtime -->|"delegates payments"| node_economy_bridge
node_economy_bridge -->|"uses economy service"| node_vault
node_quiz_runtime -->|"formats messages"| node_messages
node_quiz_runtime -->|"triggers on correct answer"| node_celebration
node_quiz_runtime -->|"records and reports"| node_stats
node_base_config -->|"supplies message settings"| node_messages

click node_quiz_runtime "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java"
click node_question_bank "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java"
click node_answer_matcher "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuestionMatcher.java"
click node_anti_bot "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java"
click node_economy_bridge "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/EconomyBridge.java"
click node_messages "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/Messages.java"
click node_celebration "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java"
click node_base_config "https://github.com/letseries/letmeask/blob/main/src/main/resources/base.yml"
click node_question_config "https://github.com/letseries/letmeask/blob/main/src/main/resources/questions.yml"
click node_stats "https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_quiz_runtime,node_question_bank toneBlue
class node_answer_matcher,node_anti_bot toneAmber
class node_economy_bridge,node_messages,node_celebration toneMint
class node_base_config,node_question_config,node_stats toneRose
class node_player,node_admin,node_paper,node_human_verify,node_vault toneIndigo
```

## Components

### Quiz Runtime

- [Quiz Coordinator](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java): `src/main/java/com/cubex/quiz/QuizPlugin.java`
- [Question Bank](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java): `src/main/java/com/cubex/quiz/QuizPlugin.java`

### Answer Handling

- [Fuzzy Matcher](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuestionMatcher.java): `src/main/java/com/cubex/quiz/QuestionMatcher.java`
- [Anti-bot Checks](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java): `src/main/java/com/cubex/quiz/QuizPlugin.java`

### Rewards And Output

- [Economy Bridge](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/EconomyBridge.java): `src/main/java/com/cubex/quiz/EconomyBridge.java`
- [Message Center](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/Messages.java): `src/main/java/com/cubex/quiz/Messages.java`
- [Answer Celebration](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java): `src/main/java/com/cubex/quiz/QuizPlugin.java`

### Configuration And Stats

- [Plugin Settings](https://github.com/letseries/letmeask/blob/main/src/main/resources/base.yml): `src/main/resources/base.yml`
- [Question Settings](https://github.com/letseries/letmeask/blob/main/src/main/resources/questions.yml): `src/main/resources/questions.yml`
- [Quiz Statistics](https://github.com/letseries/letmeask/blob/main/src/main/java/com/cubex/quiz/QuizPlugin.java): `src/main/java/com/cubex/quiz/QuizPlugin.java`

### Other components

- **Player**
- **Admin / Commands**
- **Paper / Spigot**
- **HumanVerify**
- **Vault Economy**

## Connections

- Admin / Commands → Quiz Coordinator: controls (evidence: `README.md`)
- Player → Quiz Coordinator: answers in chat (evidence: `README.md`)
- Quiz Coordinator → Paper / Spigot: schedules and broadcasts (evidence: `README.md`)
- Question Settings → Question Bank: defines questions (evidence: `README.md`)
- Plugin Settings → Quiz Coordinator: configures timing (evidence: `README.md`)
- Quiz Coordinator → Question Bank: selects questions (evidence: `src/main/java/com/cubex/quiz/QuizPlugin.java`)
- Quiz Coordinator → Fuzzy Matcher: delegates matching (evidence: `src/main/java/com/cubex/quiz/QuizPlugin.java`)
- Quiz Coordinator → Anti-bot Checks: checks answer behavior (evidence: `src/main/java/com/cubex/quiz/QuizPlugin.java`)
- Anti-bot Checks → HumanVerify: requests verification (evidence: `README.md`)
- Quiz Coordinator → Economy Bridge: delegates payments (evidence: `src/main/java/com/cubex/quiz/QuizPlugin.java`)
- Economy Bridge → Vault Economy: uses economy service (evidence: `src/main/java/com/cubex/quiz/EconomyBridge.java`)
- Quiz Coordinator → Message Center: formats messages (evidence: `src/main/java/com/cubex/quiz/QuizPlugin.java`)
- Quiz Coordinator → Answer Celebration: triggers on correct answer (evidence: `README.md`)
- Quiz Coordinator → Quiz Statistics: records and reports (evidence: `src/main/java/com/cubex/quiz/QuizPlugin.java`)
- Plugin Settings → Message Center: supplies message settings (evidence: `src/main/java/com/cubex/quiz/Messages.java`)
