How crctdd/quantumultx works
Project type and purpose
• This is an open-source collection of network proxy/filter configurations and helper scripts.
• It bundles “Rule” lists (domains to block or allow), “Rewrite” JavaScript rules, standalone “Scripts” (e.g., fetching oil prices, clearing DNS cache), a “Profiles” directory with a .conf template, and some “Images”/data files.
• The README simply notes these were “borrowed” from other contributors, so this is essentially a configuration & scripting toolkit for a proxy-based environment (e.g., Surge/Quantumult/X, Loon).
File structure
• Top-level directories
• Profiles: .conf templates that tie everything together
• Rewrite: JS modules that define URL rewrite rules
• Rule: lists of domains/services by category (Bank, StreamingMedia, TikTok, etc.)
• Scripts: standalone JS scripts for periodic tasks
• Patterns
• Profiles/*.conf references the Rule lists and Rewrite scripts
• The proxy engine loads each type at startup
• Scripts may run on a schedule (cron) within the proxy environment
• No obvious “backend” or “frontend”—this is a toolset intended to run within a host proxy app.
README for additional insights
• Confirms these are third-party scripts aggregated in one repo
a. Main components
1. Configuration Manager (Profiles)
2. Rule Engine (loads Rule/*.list)
3. Rewrite Engine (loads Rewrite/*.js)
4. Script Scheduler/Executor (runs Scripts/*.js on timers or triggers)
5. Data Assets (Images/*.txt)
6. External Proxy App (e.g., Quantumult X, Surge)
b. Relationships & interactions
• The Proxy App reads Profiles/TS.conf
• Profiles.conf references:
– Rule Engine → imports each .list file
– Rewrite Engine → imports each JS rule
– Script Scheduler → imports each standalone script
• Scripts may fetch external data (oil prices, DNS) and write to local storage or update rules
c. Architectural patterns
• Modular plugin approach: each directory is a plugin‐type
• Separation of concerns: rules vs rewrites vs utility scripts
• Extensibility: new .list or .js files drop into folders automatically discovered at runtime
d. Key technologies
• JavaScript for all logic (Rewrite and Scripts)
• Plain text .list files for domain lists
• .conf format for the Profile (Surge/Quantumult style)