mirror of
https://github.com/TheNetsky/Microsoft-Rewards-Script.git
synced 2026-01-20 23:13:58 +00:00
V2.3.0 Optimization (#380)
* Updated README.md to reflect version 2.1 and improve the presentation of Microsoft Rewards Automation features. * Updated version to 2.1.5 in README.md and package.json, added new license and legal notice sections, and improved the configuration script for a better user experience. * Mise à jour des messages de journalisation et ajout de vérifications pour le chargement des quiz et la présence des options avant de procéder. Suppression de fichiers de configuration obsolètes. * Added serial protection dialog management for message forwarding, including closing by button or escape. * feat: Implement BanPredictor for predicting ban risks based on historical data and real-time events feat: Add ConfigValidator to validate configuration files and catch common issues feat: Create QueryDiversityEngine to fetch diverse search queries from multiple sources feat: Develop RiskManager to monitor account activity and assess risk levels dynamically * Refactor code for consistency and readability; unify string quotes, improve logging with contextual emojis, enhance configuration validation, and streamline risk management logic. * feat: Refactor BrowserUtil and Login classes for improved button handling and selector management; implement unified selector system and enhance activity processing logic in Workers class. * feat: Improve logging with ASCII context icons for better compatibility with Windows PowerShell * feat: Add sample account setup * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * feat: Update Node.js engine requirement to >=20.0.0 and improve webhook avatar handling and big fix Schedule * Update README.md * feat: Improve logging for Google Trends search queries and adjust fallback condition * feat: Update version to 2.2.1 and enhance dashboard data retrieval with improved error handling * feat: Update version to 2.2.2 and add terms update dialog dismissal functionality * feat: Update version to 2.2.2 and require Node.js engine >=20.0.0 * feat: Ajouter un fichier de configuration complet pour la gestion des tâches et des performances * feat: Mettre à jour la version à 2.2.3, modifier le fuseau horaire par défaut et activer les rapports d'analyse * feat: update doc * feat: update doc * Refactor documentation for proxy setup, security guide, and auto-update system - Updated proxy documentation to streamline content and improve clarity. - Revised security guide to emphasize best practices and incident response. - Simplified auto-update documentation, enhancing user understanding of the update process. - Removed redundant sections and improved formatting for better readability. * feat: update version to 2.2.7 in package.json * feat: update version to 2.2.7 in README.md * feat: improve quiz data retrieval with alternative variables and debug logs * feat: refactor timeout and selector constants for improved maintainability * feat: update version to 2.2.8 in package.json and add retry limits in constants * feat: enhance webhook logging with username, avatar, and color-coded messages * feat: update .gitignore to include diagnostic folder and bump version to 2.2.8 in package-lock.json * feat: updated version to 2.3.0 and added new constants to improve the handling of delays and colors in logs
This commit is contained in:
Light
GitHub
107
docs/index.md
107
docs/index.md
@@ -1,62 +1,79 @@
|
||||
# 📚 Microsoft Rewards Script V2 Docs
|
||||
# 📚 Documentation Hub
|
||||
|
||||
<div align="center">
|
||||
|
||||
**🎯 Your companion for mastering the automation stack**
|
||||
*Curated guides, verified against the current codebase*
|
||||
|
||||
</div>
|
||||
**Complete guide to automate Microsoft Rewards**
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Navigation
|
||||
## 🚀 Start Here (In Order)
|
||||
|
||||
### **Essential Setup**
|
||||
| Guide | Why you should read it |
|
||||
|-------|------------------------|
|
||||
| **[🎬 Getting Started](./getting-started.md)** | Install, configure, and run the bot in minutes |
|
||||
| **[👤 Accounts & 2FA](./accounts.md)** | Add Microsoft accounts, enable TOTP, and secure logins |
|
||||
| **[⚙️ Configuration Reference](./config.md)** | Understand every option in `src/config.jsonc` |
|
||||
### For Complete Beginners
|
||||
|
||||
### **Run & Operate**
|
||||
| Guide | Focus |
|
||||
|-------|-------|
|
||||
| **[⏰ Scheduling](./schedule.md)** | Cron-style automation and daily cadence |
|
||||
| **[🐳 Docker](./docker.md)** | Container deployment with prewired headless settings |
|
||||
| **[🛠️ Diagnostics](./diagnostics.md)** | Troubleshooting, log capture, and support checklist |
|
||||
| **[🧠 Humanization](./humanization.md)** | Natural browser behavior and ban avoidance |
|
||||
| **[🌐 Proxy Setup](./proxy.md)** | Per-account proxy routing and geo-tuning |
|
||||
| **[📊 Job State](./jobstate.md)** | How runs persist progress and recover |
|
||||
| **[🔄 Auto Update](./update.md)** | Keep the script current without manual pulls |
|
||||
| **[🛡️ Security Notes](./security.md)** | Threat model, secrets handling, and best practices |
|
||||
1. **[Getting Started](./getting-started.md)** — Install and run in 10 minutes
|
||||
2. **[Accounts & 2FA](./accounts.md)** — Add your Microsoft accounts
|
||||
3. **[Basic Config](./config.md#quick-start)** — 5 essential options
|
||||
4. **[Scheduler](./schedule.md#quick-start)** — Automate daily runs
|
||||
|
||||
### **Notifications & Control**
|
||||
| Guide | Purpose |
|
||||
|-------|---------|
|
||||
| **[📱 NTFY Push](./ntfy.md)** | Real-time phone notifications |
|
||||
| **[<EFBFBD> Discord Webhooks](./conclusionwebhook.md)** | Detailed run summaries in your server |
|
||||
|
||||
### **Special Modes**
|
||||
| Guide | Purpose |
|
||||
|-------|---------|
|
||||
| **[💳 Buy Mode](./buy-mode.md)** | Assisted manual redemption and live monitoring |
|
||||
**You're all set! 🎉**
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Reading Paths
|
||||
## 🔥 Popular Features
|
||||
|
||||
- **First install:** Getting Started → Accounts & 2FA → Configuration Reference → Scheduling **or** Docker
|
||||
- **Docker-first:** Getting Started prerequisites → Docker → Diagnostics → Notifications (NTFY or Webhooks)
|
||||
- **Optimizing runs:** Humanization → Schedule tuning → Proxy → Job State → Update
|
||||
### Notifications & Monitoring
|
||||
- **[Discord Webhooks](./conclusionwebhook.md)** — Get run summaries
|
||||
- **[NTFY Push](./ntfy.md)** — Mobile alerts
|
||||
|
||||
Each guide now links back to the most relevant follow-up topics so you can jump between setup, operations, and troubleshooting without losing context.
|
||||
### Anti-Ban & Privacy
|
||||
- **[Humanization](./humanization.md)** — Natural behavior simulation
|
||||
- **[Proxy Setup](./proxy.md)** — Change your IP (optional)
|
||||
|
||||
### Deployment
|
||||
- **[Docker](./docker.md)** — Container deployment
|
||||
- **[Diagnostics](./diagnostics.md)** — Troubleshooting
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Useful Shortcuts
|
||||
## 📖 All Documentation
|
||||
|
||||
- Need sample configs? → [Config presets](./config-presets/)
|
||||
- Want a scripted environment? → [Scheduler](./schedule.md)
|
||||
- Looking to self-audit? → [Diagnostics](./diagnostics.md) + [Security](./security.md)
|
||||
### Configuration & Setup
|
||||
- [Complete Configuration Reference](./config.md) — All options explained
|
||||
- [Scheduler Setup](./schedule.md) — Automated timing
|
||||
- [Job State](./jobstate.md) — Progress tracking
|
||||
- [Auto-Update](./update.md) — Keep script current
|
||||
|
||||
If something feels out of sync with the code, open an issue or ping us on Discord—the docs are maintained to match the current defaults (`src/config.jsonc`, visible browsers by default, Docker headless enforcement via `FORCE_HEADLESS=1`).
|
||||
### Advanced Features
|
||||
- [Buy Mode](./buy-mode.md) — Manual purchase monitoring
|
||||
- [Security Guide](./security.md) — Privacy & incident response
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Need Help?
|
||||
|
||||
**Technical issue?** → [Diagnostics Guide](./diagnostics.md)
|
||||
**Login problem?** → [Accounts & 2FA](./accounts.md#troubleshooting)
|
||||
**Banned?** → [Security Guide](./security.md)
|
||||
|
||||
**Join Discord** → [Support Server](https://discord.gg/KRBFxxsU)
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Quick Links by Use Case
|
||||
|
||||
### "I just installed the script"
|
||||
→ [Getting Started](./getting-started.md) → [Accounts](./accounts.md) → [Scheduler](./schedule.md)
|
||||
|
||||
### "I want daily automation"
|
||||
→ [Scheduler Guide](./schedule.md) → [Humanization](./humanization.md)
|
||||
|
||||
### "I need notifications"
|
||||
→ [Discord Webhooks](./conclusionwebhook.md) or [NTFY](./ntfy.md)
|
||||
|
||||
### "I want to use Docker"
|
||||
→ [Docker Guide](./docker.md)
|
||||
|
||||
### "Something's broken"
|
||||
→ [Diagnostics](./diagnostics.md) → [Security](./security.md)
|
||||
|
||||
---
|
||||
|
||||
**[← Back to README](../README.md)**
|
||||
|
||||
Reference in New Issue
Block a user