- Comprehensive commercial product documentation for BuiltByBit marketplace - 5 detailed documents covering all aspects of commercial development - Complete implementation guide with all Gemini-provided code blocks - Full marketing strategy with BuiltByBit launch materials - Comprehensive testing guide with essential test cases - Support playbook for 2-5 hours/month sustainable operations COMMERCIAL VIABILITY: - Market validated: $9,600 proven revenue (competitor analysis) - Revenue projection: $1,000-6,750 year 1 (realistic: $3,000) - Development time: 8-10 hours (Gemini provided complete code) - Break-even: 40 sales (2-3 months at realistic pace) - ROI: Even worst case justifies build (saves 120 hours/year internal use) TECHNICAL ARCHITECTURE: - Backend: PHP/Laravel services (ModpackDetector, CacheService, 3 API providers) - Frontend: React/TypeScript status badge component - Database: Idempotent installation scripts (install.sh, remove.sh) - Platforms: CurseForge, Modrinth, FTB (Feed The Beast) - Caching: Egg Variable storage for performance - Auto-detection: File fingerprinting with graceful fallbacks PRODUCT FEATURES: - Standard tier ($14.99): CurseForge + Modrinth, manual checking - Professional tier ($24.99): + FTB + cron automation + Discord webhooks - Zero-click monitoring (status badges on dashboard) - Auto-detection (no manual configuration) - Manual override capability - Graceful API failure handling DOCUMENTATION COMPLETE: 1. README.md - Executive summary, architecture, strategy (11.6KB) 2. IMPLEMENTATION-PLAN.md - All code blocks organized by component (16.9KB) 3. MARKETING-STRATEGY.md - BuiltByBit launch materials, SEO copy (16.7KB) 4. TESTING-GUIDE.md - QA procedures, test cases, beta testing (13.7KB) 5. SUPPORT-PLAYBOOK.md - Operations guide, sustainable support (15.2KB) MARKET POSITIONING: - Unique value: MONITORING tool (competitors only install) - Solves Day 2-365 problem (maintenance, not setup) - Complementary to existing installers (not competitive) - Professional tier features unique to market (cron automation) RESEARCH SOURCE: - Complete Gemini Pro research session (4 hours, February 22, 2026) - Competitor analysis, technical architecture, commercial strategy - Operations planning, marketing materials, support strategy - Compressed months of traditional planning into single night This commercial product is READY TO BUILD when resources available. Expected execution: 8-10 hours assembly + testing + launch. Built by: The Chronicler #21 Research partner: Gemini Pro For: Firefrost Gaming (internal use) + BuiltByBit marketplace (passive income) Purpose: Generate $1,000-6,750/year passive revenue while solving internal need Fire + Frost + Foundation = Where Innovation Generates Income
649 lines
15 KiB
Markdown
649 lines
15 KiB
Markdown
# MODPACK VERSION CHECKER - SUPPORT PLAYBOOK
|
|
|
|
**Operational guide for maintaining 2-5 hours/month support capacity**
|
|
|
|
---
|
|
|
|
## 🎯 SUPPORT PHILOSOPHY
|
|
|
|
**Goal:** Minimize support burden through excellent documentation and proactive error handling
|
|
|
|
**Target:** 2-5 hours/month average support time
|
|
**Reality check:** Month 1 may require 8-10 hours (learning curve)
|
|
|
|
**Core principle:** Deflect tickets before they're created
|
|
|
|
---
|
|
|
|
## 📞 SUPPORT INFRASTRUCTURE
|
|
|
|
### Discord Server (Primary Channel)
|
|
|
|
**Setup requirements:**
|
|
- Dedicated Discord server for Firefrost products
|
|
- Ticket bot installed (Ticket Tool or similar)
|
|
- Clear channel structure
|
|
|
|
**Channel structure:**
|
|
```
|
|
#welcome - Rules, FAQ, getting started
|
|
#announcements - Updates, changelogs
|
|
#support-tickets - Ticket bot creates private threads
|
|
#general-chat - Community discussion
|
|
#showcase - Users share their setups
|
|
```
|
|
|
|
**Bot configuration:**
|
|
- Auto-create private thread per ticket
|
|
- Tag @Firefrost Support role
|
|
- Auto-close after 48 hours inactivity
|
|
- Save transcripts
|
|
|
|
---
|
|
|
|
### BuiltByBit Messages (Secondary Channel)
|
|
|
|
**Response strategy:**
|
|
- Check once daily (not real-time)
|
|
- Direct complex issues to Discord
|
|
- Simple questions answered directly
|
|
- Average response time: 24-48 hours
|
|
|
|
**Quick responses:**
|
|
- Installation questions → Link to documentation
|
|
- Feature requests → Thank them, add to v2.0 roadmap
|
|
- Bug reports → Request Discord ticket for details
|
|
|
|
---
|
|
|
|
### Documentation Site
|
|
|
|
**Platform:** GitBook (free) or GitHub Wiki
|
|
|
|
**Required pages:**
|
|
1. Installation Guide (step-by-step with screenshots)
|
|
2. Troubleshooting Guide (common errors + solutions)
|
|
3. FAQ (8-10 questions)
|
|
4. API Key Setup (for CurseForge)
|
|
5. Manual Override Guide
|
|
6. Changelog
|
|
|
|
**Update frequency:** After each version release
|
|
|
|
---
|
|
|
|
## 🛡️ SUPPORT DEFLECTION TACTICS
|
|
|
|
### Tactic 1: "Blueprint First" Rule
|
|
|
|
**Implementation:**
|
|
Prominently display on BuiltByBit page (top of description):
|
|
|
|
```
|
|
⚠️ CRITICAL REQUIREMENT ⚠️
|
|
Blueprint Framework MUST be installed BEFORE purchasing this extension.
|
|
This extension will NOT work on vanilla Pterodactyl panels.
|
|
|
|
If you do not have Blueprint installed, DO NOT BUY THIS EXTENSION.
|
|
Install Blueprint first: https://blueprint.zip
|
|
```
|
|
|
|
**Impact:** Eliminates 80% of "installation failed" tickets
|
|
|
|
---
|
|
|
|
### Tactic 2: Clear Error Messages
|
|
|
|
**Bad error message:**
|
|
```
|
|
Error 500: Internal Server Error
|
|
```
|
|
**Result:** Support ticket
|
|
|
|
**Good error message:**
|
|
```
|
|
JSON Parse Error: Your manifest.json file appears to be corrupted.
|
|
Please verify the file is valid JSON, or use Manual Override in the Startup tab.
|
|
```
|
|
**Result:** User self-diagnoses
|
|
|
|
**Implementation checklist:**
|
|
- [ ] All try/catch blocks have specific error messages
|
|
- [ ] Error messages include next steps
|
|
- [ ] Error messages avoid technical jargon
|
|
- [ ] Error messages link to documentation when applicable
|
|
|
|
---
|
|
|
|
### Tactic 3: Comprehensive FAQ
|
|
|
|
**Post in Discord #welcome AND BuiltByBit page**
|
|
|
|
**Essential FAQ questions:**
|
|
|
|
1. **"Blueprint requirement keeps showing"**
|
|
Answer: This extension requires Blueprint. Install from blueprint.zip first.
|
|
|
|
2. **"Installation failed"**
|
|
Answer: Ensure you have: (1) Pterodactyl 1.11+, (2) Blueprint latest, (3) Root SSH access. Run: `blueprint -install modpackmonitor.blueprint`
|
|
|
|
3. **"My servers show 'Unknown'"**
|
|
Answer: Auto-detection requires standard manifest files. Use Manual Override in Startup tab if you have a custom modpack.
|
|
|
|
4. **"CurseForge not working"**
|
|
Answer: CurseForge requires an API key. Add your key in Admin Panel → Extensions → Modpack Monitor. Modrinth and FTB work without keys.
|
|
|
|
5. **"How do I get a CurseForge API key?"**
|
|
Answer: Visit https://console.curseforge.com, create account, generate API key, paste into admin panel.
|
|
|
|
6. **"Can I use this with custom modpacks?"**
|
|
Answer: If your pack has manifest.json/modrinth.index.json, yes. Otherwise, use Manual Override to link to a public project ID.
|
|
|
|
7. **"Update checking slow/not working"**
|
|
Answer: Standard tier checks manually. Professional tier checks every 6 hours automatically. If APIs are down, you'll see a yellow "API Offline" badge.
|
|
|
|
8. **"How do I uninstall?"**
|
|
Answer: Run `blueprint -remove modpackmonitor`. This cleanly removes all database variables and UI modifications.
|
|
|
|
---
|
|
|
|
### Tactic 4: Video Tutorial
|
|
|
|
**Create 3-minute walkthrough:**
|
|
- Installation process
|
|
- First server setup
|
|
- Adding CurseForge API key
|
|
- Using manual override
|
|
|
|
**Host on:** YouTube, link from BuiltByBit and Discord
|
|
|
|
**Impact:** Visual learners self-serve instead of asking
|
|
|
|
---
|
|
|
|
## ⏱️ RESPONSE TIME STRATEGY
|
|
|
|
### Service Level Agreements (SLA)
|
|
|
|
**Standard Tier:** 48-hour response time
|
|
**Professional Tier:** 24-hour response time
|
|
|
|
**Clearly posted in Discord #welcome**
|
|
|
|
### Batching Strategy
|
|
|
|
**Don't:** Check Discord every hour, context-switching constantly
|
|
**Do:** Schedule 2 support sessions per week
|
|
|
|
**Support Schedule:**
|
|
- Tuesday evening: 60 minutes
|
|
- Saturday morning: 60 minutes
|
|
|
|
**Total:** 2 hours/week = 8 hours/month (within target)
|
|
|
|
### Triage Priority
|
|
|
|
**Immediate response (< 2 hours):**
|
|
- Critical bugs (panel crashes, data loss)
|
|
- Security vulnerabilities
|
|
- Payment/refund issues
|
|
|
|
**24-hour response:**
|
|
- Professional tier tickets
|
|
- Installation problems
|
|
- Feature not working as expected
|
|
|
|
**48-hour response:**
|
|
- Standard tier tickets
|
|
- Feature requests
|
|
- General questions
|
|
- Enhancement ideas
|
|
|
|
**No response needed:**
|
|
- Spam
|
|
- Already answered in FAQ
|
|
- "Thank you" messages (heart react instead)
|
|
|
|
---
|
|
|
|
## 🐛 COMMON SUPPORT SCENARIOS
|
|
|
|
### Scenario 1: "Installation Failed"
|
|
|
|
**Diagnostic questions:**
|
|
1. What Pterodactyl version? (Need 1.11+)
|
|
2. Is Blueprint installed? (Run `blueprint -v`)
|
|
3. What error message exactly?
|
|
4. Can you paste install.sh output?
|
|
|
|
**Common causes:**
|
|
- Blueprint not installed (80% of cases)
|
|
- Wrong Pterodactyl version
|
|
- MySQL permission issues
|
|
- Corrupted .blueprint file
|
|
|
|
**Solution template:**
|
|
```
|
|
Thank you for reporting this! Let's troubleshoot:
|
|
|
|
1. First, verify Blueprint is installed:
|
|
Run: `blueprint -v`
|
|
Should show: Blueprint v1.x.x
|
|
|
|
2. If Blueprint is missing, install it first:
|
|
https://blueprint.zip
|
|
|
|
3. If Blueprint is installed, try:
|
|
`blueprint -install modpackmonitor.blueprint`
|
|
|
|
4. If still failing, please paste the full error output and I'll help debug.
|
|
```
|
|
|
|
---
|
|
|
|
### Scenario 2: "My Servers Show Unknown"
|
|
|
|
**Diagnostic questions:**
|
|
1. What modpack are you using?
|
|
2. Is it from CurseForge, Modrinth, or FTB?
|
|
3. Does your server root have manifest.json or similar files?
|
|
|
|
**Common causes:**
|
|
- Custom/private modpack with no manifest
|
|
- Manifest in non-standard location
|
|
- Corrupted manifest file
|
|
|
|
**Solution template:**
|
|
```
|
|
The extension detects modpacks by scanning for:
|
|
- manifest.json (CurseForge)
|
|
- modrinth.index.json (Modrinth)
|
|
- instance.json (FTB)
|
|
|
|
If your modpack doesn't have these files (custom pack), you can use Manual Override:
|
|
|
|
1. Go to your server's Startup tab
|
|
2. Find MODPACK_PLATFORM variable
|
|
3. Set to: curseforge (or modrinth/ftb)
|
|
4. Find MODPACK_ID variable
|
|
5. Set to: your project ID
|
|
|
|
This tells the extension which pack you're running.
|
|
```
|
|
|
|
---
|
|
|
|
### Scenario 3: "CurseForge Not Working"
|
|
|
|
**Diagnostic questions:**
|
|
1. Have you added a CurseForge API key?
|
|
2. Is the key in the Admin Panel settings?
|
|
3. Are Modrinth/FTB working?
|
|
|
|
**Common causes:**
|
|
- No API key configured (90% of cases)
|
|
- Invalid/expired API key
|
|
- Rate limiting (if using shared key)
|
|
|
|
**Solution template:**
|
|
```
|
|
CurseForge requires an API key (Modrinth and FTB don't).
|
|
|
|
To add your key:
|
|
1. Get key from: https://console.curseforge.com
|
|
2. In Pterodactyl, go to: Admin Panel → Extensions → Modpack Monitor
|
|
3. Paste your API key
|
|
4. Save
|
|
|
|
Once configured, CurseForge detection will work for all servers.
|
|
|
|
Note: Modrinth and FTB should already be working without any key.
|
|
```
|
|
|
|
---
|
|
|
|
### Scenario 4: "Upgrade from Standard to Professional"
|
|
|
|
**Process:**
|
|
1. Verify original purchase on BuiltByBit
|
|
2. Calculate upgrade price ($10 difference)
|
|
3. Issue upgrade coupon code
|
|
4. Send Professional tier .blueprint file
|
|
|
|
**Response template:**
|
|
```
|
|
Thanks for upgrading to Professional!
|
|
|
|
Your upgrade cost is $10 (difference between tiers).
|
|
|
|
1. Purchase Professional tier on BuiltByBit
|
|
2. Use code: UPGRADE-XXXXX for $10 off
|
|
3. Download the Professional .blueprint file
|
|
4. Run: blueprint -install modpackmonitor-pro.blueprint
|
|
|
|
Your existing configuration will be preserved.
|
|
```
|
|
|
|
---
|
|
|
|
### Scenario 5: "Feature Request"
|
|
|
|
**Response strategy:**
|
|
- Thank them genuinely
|
|
- Add to v2.0 roadmap document
|
|
- Give realistic timeline
|
|
- Don't over-promise
|
|
|
|
**Response template:**
|
|
```
|
|
Great suggestion! I've added this to the v2.0 roadmap.
|
|
|
|
Current roadmap for future updates:
|
|
- Discord webhook notifications (top priority)
|
|
- One-click modpack updates
|
|
- Version history tracking
|
|
- [User's suggestion]
|
|
|
|
Updates are typically released quarterly. Follow #announcements for news.
|
|
|
|
Appreciate the feedback! 🔥❄️
|
|
```
|
|
|
|
---
|
|
|
|
## 📊 SUPPORT METRICS TO TRACK
|
|
|
|
### Weekly Metrics
|
|
|
|
**Track in spreadsheet:**
|
|
- Total tickets opened
|
|
- Average response time
|
|
- Tickets resolved vs. escalated
|
|
- Time spent on support (hours)
|
|
- Common issue categories
|
|
|
|
**Goal:** Identify patterns to improve documentation
|
|
|
|
---
|
|
|
|
### Monthly Review
|
|
|
|
**Questions to ask:**
|
|
1. What were the 3 most common issues?
|
|
2. Can we prevent these with better docs/error messages?
|
|
3. Are we hitting 2-5 hours/month target?
|
|
4. Any critical bugs that need immediate fixing?
|
|
5. What feature requests are most requested?
|
|
|
|
**Actions:**
|
|
- Update FAQ based on common questions
|
|
- Improve error messages for common issues
|
|
- Plan patches for critical bugs
|
|
- Prioritize popular feature requests for v2.0
|
|
|
|
---
|
|
|
|
## 🚫 WHEN TO SAY NO
|
|
|
|
### Scope Creep Requests
|
|
|
|
**Examples:**
|
|
- "Can you add support for Technic Platform?"
|
|
- "Can you make this work without Blueprint?"
|
|
- "Can you add auto-update functionality?"
|
|
|
|
**Response:**
|
|
```
|
|
That's outside the current scope of this extension, but it's a great idea for a future update!
|
|
|
|
I've added it to the feature request list for consideration in v2.0.
|
|
|
|
For now, the extension focuses on [core features] to ensure stability and reliability.
|
|
```
|
|
|
|
---
|
|
|
|
### Custom Development Requests
|
|
|
|
**Example:**
|
|
"Can you customize this for my hosting company's specific needs?"
|
|
|
|
**Response:**
|
|
```
|
|
The extension is designed to work out-of-the-box for most setups.
|
|
|
|
If you need custom development, I can refer you to freelance developers familiar with Pterodactyl.
|
|
|
|
Alternatively, the extension is open-source - you're welcome to modify it for your specific needs (license permitting).
|
|
```
|
|
|
|
---
|
|
|
|
### Emergency Support Requests
|
|
|
|
**Example:**
|
|
"My panel is down! Fix it NOW!"
|
|
|
|
**Response:**
|
|
```
|
|
I understand this is urgent. However, the extension itself cannot crash your panel.
|
|
|
|
First, try:
|
|
1. Uninstall the extension: `blueprint -remove modpackmonitor`
|
|
2. If panel still down, this is likely a Pterodactyl or Blueprint issue
|
|
3. Check Pterodactyl Discord for panel-wide issues
|
|
|
|
If the extension is confirmed as the cause, please create a detailed ticket with:
|
|
- Error messages
|
|
- Pterodactyl version
|
|
- Blueprint version
|
|
- Steps to reproduce
|
|
|
|
I'll investigate ASAP (within 24h for Professional tier, 48h for Standard).
|
|
```
|
|
|
|
**Don't:** Promise instant fixes or take responsibility for panel-wide issues
|
|
|
|
---
|
|
|
|
## 💬 COMMUNICATION TEMPLATES
|
|
|
|
### New Ticket Response
|
|
|
|
```
|
|
Hi [name]! Thanks for reaching out.
|
|
|
|
I've received your ticket about [issue]. I'll investigate and respond within [24h/48h based on tier].
|
|
|
|
In the meantime, check our FAQ - your issue might be covered there:
|
|
[Link to FAQ]
|
|
|
|
- Michael (Firefrost Gaming)
|
|
```
|
|
|
|
---
|
|
|
|
### Ticket Resolution
|
|
|
|
```
|
|
Great news - I've identified the issue!
|
|
|
|
[Explanation of problem]
|
|
|
|
To fix:
|
|
[Step-by-step solution]
|
|
|
|
Please let me know if this resolves your issue. If not, I'm happy to dig deeper.
|
|
|
|
Closing this ticket in 24 hours if no response, but feel free to reopen anytime.
|
|
|
|
- Michael
|
|
```
|
|
|
|
---
|
|
|
|
### Bug Confirmed
|
|
|
|
```
|
|
Thank you for reporting this! I've confirmed this is a bug.
|
|
|
|
I'm releasing a patch (v1.0.1) within [timeframe] that fixes:
|
|
- [Bug description]
|
|
- [Any other bugs fixed]
|
|
|
|
You'll be notified in #announcements when the update is live.
|
|
|
|
Appreciate your patience and detailed bug report! 🔥❄️
|
|
|
|
- Michael
|
|
```
|
|
|
|
---
|
|
|
|
### Feature Not Planned
|
|
|
|
```
|
|
I appreciate the suggestion!
|
|
|
|
Unfortunately, [feature] isn't planned for the near future because [reason - scope/complexity/maintenance burden].
|
|
|
|
However, I've documented your request. If enough users ask for it, I'll reconsider for v2.0.
|
|
|
|
Thanks for the feedback!
|
|
|
|
- Michael
|
|
```
|
|
|
|
---
|
|
|
|
## 🔄 UPDATE COMMUNICATION STRATEGY
|
|
|
|
### Version Release Announcement
|
|
|
|
**Post in Discord #announcements AND BuiltByBit update section:**
|
|
|
|
```
|
|
🎉 Modpack Version Monitor v1.0.1 Released!
|
|
|
|
**What's New:**
|
|
- Fixed: [Bug description]
|
|
- Improved: [Enhancement description]
|
|
- Added: [New feature if any]
|
|
|
|
**To Update:**
|
|
1. Download latest .blueprint from BuiltByBit
|
|
2. Run: `blueprint -install modpackmonitor.blueprint`
|
|
3. Done!
|
|
|
|
Full changelog: [Link]
|
|
|
|
Thanks to everyone who reported bugs and suggested improvements! 🔥❄️
|
|
```
|
|
|
|
---
|
|
|
|
### Scheduled Maintenance Notice
|
|
|
|
```
|
|
⚠️ Scheduled Maintenance Notice
|
|
|
|
We're releasing v1.1.0 this weekend with [major features].
|
|
|
|
**Timeline:**
|
|
- Saturday 10 AM CST: Release available
|
|
- No downtime required (just re-install)
|
|
|
|
**What's Coming:**
|
|
[Feature list]
|
|
|
|
Questions? Drop them in #general-chat!
|
|
```
|
|
|
|
---
|
|
|
|
## ✅ SUPPORT READINESS CHECKLIST
|
|
|
|
**Before BuiltByBit launch:**
|
|
|
|
- [ ] Discord server created and configured
|
|
- [ ] Ticket bot installed and tested
|
|
- [ ] FAQ posted in #welcome
|
|
- [ ] Documentation site published
|
|
- [ ] Video tutorial recorded and uploaded
|
|
- [ ] Support response templates prepared
|
|
- [ ] SLA clearly posted
|
|
- [ ] "Blueprint First" warning on BuiltByBit page
|
|
- [ ] Common troubleshooting scenarios documented
|
|
- [ ] Support metrics tracking spreadsheet ready
|
|
|
|
---
|
|
|
|
## 📈 SCALING SUPPORT (If Needed)
|
|
|
|
### If Support Exceeds 5 Hours/Month
|
|
|
|
**Options:**
|
|
|
|
**1. Improve Documentation (First choice)**
|
|
- Add more FAQ entries
|
|
- Create troubleshooting flowcharts
|
|
- Record more video tutorials
|
|
- Improve error messages in code
|
|
|
|
**2. Community Support (Second choice)**
|
|
- Identify power users
|
|
- Create "Community Helper" role
|
|
- Reward helpers with free upgrades
|
|
- You only handle escalations
|
|
|
|
**3. Raise Prices (Third choice)**
|
|
- If demand is high, increase price
|
|
- Higher price = fewer sales = less support
|
|
- But also higher revenue per sale
|
|
|
|
**4. Limit Sales (Last resort)**
|
|
- Temporarily "pause" sales
|
|
- Focus on fixing issues
|
|
- Reopen when stable
|
|
|
|
---
|
|
|
|
## 🎯 LONG-TERM SUPPORT SUSTAINABILITY
|
|
|
|
### Year 1 Goals
|
|
|
|
- Average <5 hours/month support time
|
|
- 90%+ issues resolved via documentation
|
|
- 4+ star rating maintained
|
|
- Active community helps each other
|
|
|
|
### Automation Opportunities
|
|
|
|
**Future considerations (v2.0+):**
|
|
- Self-diagnostic command (health check)
|
|
- Auto-update feature (less installation questions)
|
|
- In-panel documentation links
|
|
- Tooltips on error messages
|
|
|
|
---
|
|
|
|
## ✅ SUPPORT SUCCESS CRITERIA
|
|
|
|
**Support operations are SUSTAINABLE when:**
|
|
|
|
✅ Average 2-5 hours/month support time (after month 1)
|
|
✅ 80%+ tickets resolved via documentation
|
|
✅ <24 hour response time achieved
|
|
✅ 4+ star rating maintained
|
|
✅ No burnout or support exhaustion
|
|
✅ Positive community atmosphere
|
|
✅ Bug fix patches released within 1 week of discovery
|
|
|
|
---
|
|
|
|
**Fire + Frost + Foundation = Where Support Builds Community** 💙🔥❄️
|
|
|
|
**Support playbook created:** February 22, 2026
|
|
**Created by:** The Chronicler #21
|
|
**Purpose:** Sustainable support for solo developer
|