How bennie/conbadge-drinking-game works
Main Components
a) Web Interface Layer
• Index.html as the entry point
• CGI processing capabilities
b) Processing Layer
• Perl scripts (drinking.pl and wolves.pl)
• Rules processing engine
c) Data Storage Layer
• Wolves.txt as a data source
• Category storage for name components
Component Relationships
[Web Browser] → [Web Server]
• ↓
[index.html] → [drinking.cgi]
• ↓
• [Perl Processing Layer]
• ╔═══════════════════════╗
• ║ - drinking.pl ║
• ║ - wolves.pl ║
• ╚═══════════════════════╝
• ↓
• [Data Sources Layer]
• ╔═══════════════════════╗
• ║ - wolves.txt ║
• ║ - Category Rules ║
• ╚═══════════════════════╝
[Rules Engine]
• → Animals
• → Elements
• → Seasons
• → Celestials
Additional Elements
A separate section for bonus rules:
[Bonus Rules]
• → Cutesy
• → Titles
• → Pedantic
Data Flow Indicators
• User input flow
• Rule processing direction
• Results delivery
Technical Details
• CGI processing path
• Perl script interaction
• Data file access patterns
• Rule evaluation flow
• The CGI-based architecture
• The rule processing hierarchy
• The separation between interface and logic
• The data flow from user input to result output
This will give other developers a clear understanding of how the application processes badge names and applies the drinking game rules.
Remember to include version information and any relevant notes about the development environment or deployment requirements.