# Tools

Scripts, utilities, and automation tools for the Chinese learning system.

## Purpose

This folder contains:
- Conversion scripts (MD → JSON)
- Game generators
- Exam generators
- Sit rep generators
- Audio processors
- Any automation tools

## Planned Tools

### Content Processing
- `md-to-json.js` - Convert Markdown chapters to JSON format
- `generate-games.js` - Auto-generate 3 games per chapter
- `validate-json.js` - Check JSON structure compliance

### Tracking & Reporting
- `generate-weekly-summary.js` - Create weekly summaries from daily logs
- `generate-sitrep.js` - Create monthly sit rep (MD + HTML)
- `calculate-metrics.js` - Compute streak, consistency, velocity, etc.

### Exam System
- `generate-exam.js` - Create exams based on month's content
- `grade-exam.js` - Helper for grading exams
- `exam-analysis.js` - Analyze exam results and trends

### Utilities
- `audio-organizer.js` - Organize and rename audio files
- `chapter-tracker.js` - Track SRS review schedule
- `backup.js` - Backup tracking data

## Usage

Each tool should have:
- Clear documentation
- Usage examples
- Error handling
- Command-line interface

## Development

Tools can be written in:
- JavaScript/Node.js (preferred for classGen integration)
- Python (for data processing)
- Bash (for simple automation)

## Notes

- Keep tools modular and focused
- Document dependencies clearly
- Include tests for critical tools
- Version control tool updates