mirror of
https://github.com/LightZirconite/Microsoft-Rewards-Bot.git
synced 2026-01-10 17:26:17 +00:00
LightZirconite
8ccfdd23c9
- Created FAQ.md with detailed answers to common questions regarding the project, installation, configuration, troubleshooting, safety, and features. - Established README.md to serve as a documentation hub, outlining the structure and providing quick navigation links to various guides and resources.
248 lines
8.4 KiB
Markdown
248 lines
8.4 KiB
Markdown
<div align="center">
|
||
|
||
<img src="assets/logo.png" alt="Microsoft Rewards Bot Logo" width="200"/>
|
||
|
||
# Microsoft Rewards Bot
|
||
|
||
**Automate your Microsoft Rewards points collection effortlessly**
|
||
|
||
[](https://discord.gg/h6Z69ZPPCz)
|
||
[](https://github.com/Light60-1/Microsoft-Rewards-Bot)
|
||
[](https://github.com/Light60-1/Microsoft-Rewards-Bot/releases)
|
||
[](LICENSE)
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
## About
|
||
|
||
This TypeScript-based automation bot helps you maximize your **Microsoft Rewards** points by automatically completing daily tasks, searches, quizzes, and promotional offers. Designed with sophisticated anti-detection measures and human-like behavior patterns to ensure safe, reliable operation.
|
||
|
||
### ✨ Key Features
|
||
|
||
- <20> **Automated Searches** — Desktop and mobile Bing searches with natural patterns
|
||
- 📅 **Daily Activities** — Quizzes, polls, daily sets, and punch cards
|
||
- 🤖 **Human-like Behavior** — Advanced humanization system to avoid detection
|
||
- 🛡️ **Risk Management** — Built-in ban detection and prediction with ML algorithms
|
||
- 📊 **Analytics Dashboard** — Track performance and points collection over time
|
||
- ⏰ **Smart Scheduling** — Built-in scheduler with timezone support
|
||
- 🔔 **Notifications** — Discord webhooks and NTFY push alerts
|
||
- 🐳 **Docker Support** — Easy containerized deployment
|
||
- 🔐 **Multi-Account** — Manage multiple accounts with parallel execution
|
||
- 🌐 **Proxy Support** — Optional proxy configuration for enhanced privacy
|
||
|
||
---
|
||
|
||
## 🚀 Quick Start
|
||
|
||
### Prerequisites
|
||
|
||
- **Node.js 20+** (version 22 recommended) — [Download here](https://nodejs.org/)
|
||
- **Git** for cloning the repository
|
||
- **Microsoft account(s)** with email and password
|
||
|
||
### Installation
|
||
|
||
**The automated setup script handles everything for you:**
|
||
|
||
1. **Clone the repository:**
|
||
```bash
|
||
git clone https://github.com/Light60-1/Microsoft-Rewards-Bot.git
|
||
cd Microsoft-Rewards-Bot
|
||
```
|
||
|
||
2. **Run the setup script:**
|
||
- **Windows:** Double-click `setup/setup.bat` or run in PowerShell:
|
||
```powershell
|
||
.\setup\setup.bat
|
||
```
|
||
- **Linux / macOS / WSL:**
|
||
```bash
|
||
bash setup/setup.sh
|
||
```
|
||
- **Or use npm:**
|
||
```bash
|
||
npm run setup
|
||
```
|
||
|
||
3. **The setup wizard will:**
|
||
- ✅ Create and configure `accounts.jsonc` with your credentials
|
||
- ✅ Install all dependencies automatically
|
||
- ✅ Build the TypeScript project
|
||
- ✅ Optionally start the script immediately
|
||
|
||
**That's it! You're ready to start earning points.** 🎉
|
||
|
||
---
|
||
|
||
## 📚 Documentation
|
||
|
||
For detailed configuration, advanced features, and troubleshooting, visit our comprehensive documentation:
|
||
|
||
**👉 [Complete Documentation](docs/index.md)**
|
||
|
||
### Quick Links
|
||
|
||
| Topic | Description |
|
||
|-------|-------------|
|
||
| **[Getting Started](docs/getting-started.md)** | Detailed installation and first-run guide |
|
||
| **[Configuration](docs/config.md)** | Complete configuration options reference |
|
||
| **[Accounts & 2FA](docs/accounts.md)** | Setting up accounts with TOTP authentication |
|
||
| **[Scheduling](docs/schedule.md)** | Automated daily execution setup |
|
||
| **[Docker Deployment](docs/docker.md)** | Running in containers |
|
||
| **[Humanization](docs/humanization.md)** | Anti-detection and natural behavior |
|
||
| **[Notifications](docs/conclusionwebhook.md)** | Discord webhooks and NTFY setup |
|
||
| **[Proxy Setup](docs/proxy.md)** | Configuring proxies for privacy |
|
||
| **[Diagnostics](docs/diagnostics.md)** | Troubleshooting and debugging |
|
||
|
||
---
|
||
|
||
## <20> Docker Quick Start
|
||
|
||
For containerized deployment with automatic scheduling:
|
||
|
||
```bash
|
||
# Ensure accounts.jsonc exists in src/
|
||
docker compose up -d
|
||
|
||
# View logs
|
||
docker logs -f microsoft-rewards-script
|
||
```
|
||
|
||
**📖 [Full Docker Guide](docs/docker.md)**
|
||
|
||
---
|
||
|
||
## ⚙️ Configuration Highlights
|
||
|
||
The script works great with default settings, but you can customize everything in `src/config.jsonc`:
|
||
|
||
```jsonc
|
||
{
|
||
"humanization": {
|
||
"enabled": true, // Enable natural behavior patterns
|
||
"stopOnBan": true // Stop on ban detection
|
||
},
|
||
"schedule": {
|
||
"enabled": true, // Built-in scheduler
|
||
"time24": "09:00", // Daily run time
|
||
"timeZone": "Europe/Paris" // Your timezone
|
||
},
|
||
"workers": {
|
||
"doDesktopSearch": true, // Desktop Bing searches
|
||
"doMobileSearch": true, // Mobile Bing searches
|
||
"doDailySet": true, // Daily tasks and quizzes
|
||
"doMorePromotions": true, // Promotional offers
|
||
"doPunchCards": true // Multi-day challenges
|
||
},
|
||
"execution": {
|
||
"clusters": 1, // Parallel account processing
|
||
"runOnZeroPoints": false // Skip when no points available
|
||
}
|
||
}
|
||
```
|
||
|
||
**📖 [Complete Configuration Guide](docs/config.md)**
|
||
|
||
---
|
||
|
||
## 🎯 What Gets Automated
|
||
|
||
The script automatically completes:
|
||
|
||
- ✅ **Desktop Searches** — 30+ searches on Bing (desktop user-agent)
|
||
- ✅ **Mobile Searches** — 20+ searches on Bing (mobile user-agent)
|
||
- ✅ **Daily Set** — Quizzes, polls, and daily activities
|
||
- ✅ **More Activities** — Promotional tasks and special offers
|
||
- ✅ **Punch Cards** — Multi-day challenges and bonus tasks
|
||
- ✅ **Daily Check-in** — Simple check-in for bonus points
|
||
- ✅ **Read to Earn** — Article reading tasks
|
||
|
||
All while maintaining **natural behavior patterns** to minimize detection risk.
|
||
|
||
---
|
||
|
||
## 💡 Usage Tips
|
||
|
||
- **Run regularly:** Set up the built-in scheduler for daily automation
|
||
- **Use humanization:** Always keep `humanization.enabled: true` for safety
|
||
- **Monitor logs:** Check for ban warnings and adjust settings if needed
|
||
- **Multiple accounts:** Use the `clusters` setting to run accounts in parallel
|
||
- **Start small:** Test with one account before scaling up
|
||
- **Review diagnostics:** Enable screenshot/HTML capture for troubleshooting
|
||
|
||
---
|
||
|
||
## 🆘 Getting Help
|
||
|
||
- 💬 **[Join our Discord](https://discord.gg/h6Z69ZPPCz)** — Community support and updates
|
||
- 📖 **[Documentation Hub](docs/index.md)** — Complete guides and references
|
||
- 🐛 **[Report Issues](https://github.com/Light60-1/Microsoft-Rewards-Bot/issues)** — Bug reports and feature requests
|
||
- 📧 **[Diagnostics Guide](docs/diagnostics.md)** — Troubleshooting steps
|
||
|
||
---
|
||
|
||
## ⚠️ Disclaimer
|
||
|
||
**Use at your own risk.** This script automates interactions with Microsoft Rewards, which may violate [Microsoft's Terms of Service](https://www.microsoft.com/en-us/servicesagreement/). Using automation tools can result in:
|
||
|
||
- ⚠️ Account suspension or permanent ban
|
||
- 🚫 Loss of accumulated points and rewards
|
||
- 🔒 Restriction from future participation
|
||
|
||
**This project is provided for educational and research purposes only.** The developers and contributors:
|
||
- Are **not responsible** for any actions taken by Microsoft against your account
|
||
- Do **not encourage** violating terms of service
|
||
- Provide **no guarantees** regarding account safety
|
||
|
||
**Use responsibly and at your own discretion.**
|
||
|
||
---
|
||
|
||
## 📄 License
|
||
|
||
This project is licensed under the **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License**.
|
||
|
||
**You may:**
|
||
- ✅ Use for personal, non-commercial purposes
|
||
- ✅ Modify the code for your own use
|
||
- ✅ Share with others (with same restrictions)
|
||
- ✅ Submit improvements via pull requests
|
||
|
||
**You may NOT:**
|
||
- ❌ Use for commercial purposes
|
||
- ❌ Sell or monetize this software
|
||
- ❌ Remove license/copyright notices
|
||
|
||
See [LICENSE](LICENSE) for complete terms.
|
||
|
||
---
|
||
|
||
## 🙏 Acknowledgments
|
||
|
||
- Built with [Playwright](https://playwright.dev/) and [ReBrowser](https://github.com/rebrowser/rebrowser-playwright)
|
||
- Thanks to all [contributors](https://github.com/Light60-1/Microsoft-Rewards-Bot/graphs/contributors)
|
||
- Community support via [Discord](https://discord.gg/h6Z69ZPPCz)
|
||
|
||
---
|
||
|
||
## 🌟 Support the Project
|
||
|
||
If you find this project helpful:
|
||
|
||
- ⭐ **Star the repository** on GitHub
|
||
- 💬 **Join our Discord** community
|
||
- 🐛 **Report bugs** and suggest features
|
||
- 📖 **Contribute** to documentation
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
**Made with ❤️ by the community**
|
||
|
||
[Documentation](docs/index.md) • [Discord](https://discord.gg/h6Z69ZPPCz) • [Issues](https://github.com/Light60-1/Microsoft-Rewards-Bot/issues)
|
||
|
||
</div>
|