diff --git a/README.md b/README.md index 138b8d1..d61a375 100644 --- a/README.md +++ b/README.md @@ -4,90 +4,95 @@ # Microsoft Rewards Bot -**Automate your Microsoft Rewards points collection effortlessly** +**Automate your Microsoft Rewards points collection** -[![Discord](https://img.shields.io/badge/💬_Join_Discord-7289DA?style=for-the-badge&logo=discord)](https://discord.gg/k5uHkx9mne) -[![GitHub](https://img.shields.io/badge/⭐_Star_Project-yellow?style=for-the-badge&logo=github)](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot) -[![Version](https://img.shields.io/badge/version-2.56.0-blue?style=for-the-badge)](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/releases) -[![License](https://img.shields.io/badge/license-CC_BY--NC--SA_4.0-green?style=for-the-badge)](LICENSE) +[![Discord](https://img.shields.io/badge/💬_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/k5uHkx9mne) +[![GitHub](https://img.shields.io/badge/⭐_Star-yellow?style=for-the-badge&logo=github&logoColor=black)](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot) +[![Version](https://img.shields.io/badge/v2.56.0-blue?style=for-the-badge)](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/releases) --- -## About +## 💡 What is this? -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. +A **TypeScript bot** that automatically earns Microsoft Rewards points by completing: -### ✨ Key Features +- 🔍 Desktop & mobile Bing searches +- 📋 Daily quizzes, polls, and activities +- 🎁 Promotional offers and punch cards +- 📚 Read-to-earn tasks -- 🔍 **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 -- ⏰ **Automatic Scheduling** — Easy configuration for cron (Linux/Raspberry Pi) and Windows Task Scheduler -- 🔔 **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 +**Built with anti-detection** to work safely and reliably. + +--- + +## ✨ Features + +- 🤖 **Human-like behavior** — Natural search patterns +- ⏰ **Auto-scheduling** — Set it and forget it +- � **Multi-account support** — Manage multiple accounts +- 🔔 **Notifications** — Discord webhooks & mobile alerts +- 🐳 **Docker ready** — Easy containerized deployment +- 🌐 **Proxy support** — Enhanced privacy (optional) --- ## 🚀 Quick Start -### ⚡ Prerequisites +### Prerequisites -- **Node.js 20+** (v22 recommended) — [Download here](https://nodejs.org/) -- **Git** (optional) — [Download here](https://git-scm.com/) or download project as ZIP +- **Node.js 20+** (v22 recommended) — [Download](https://nodejs.org/) +- **Microsoft account(s)** with email + password -### 🎯 3-Step Setup +### Installation -1. **Get the project:** - ```bash - git clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git - cd Microsoft-Rewards-Bot - ``` - Or download ZIP: [Code → Download ZIP](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/archive/refs/heads/main.zip) +```bash +# 1. Download the project +git clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git +cd Microsoft-Rewards-Bot -2. **Install dependencies:** - ```bash - npm i - ``` +# 2. Install dependencies +npm install -3. **Create accounts & configure:** - ```bash - # Use our account creator (recommended - earn +7,500 points/month!) - npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com - - # Or use setup wizard - npm run setup - ``` +# 3. Setup and run +npm run setup +``` -**📖 Need detailed instructions? See [Getting Started Guide](docs/getting-started.md)** +**That's it!** The wizard will guide you through account setup and start earning points. + +### 📖 Need Help? + +**First time using the bot?** → [📘 Getting Started Guide](docs/getting-started.md) + +The complete guide covers: +- ✅ Detailed installation steps +- ✅ Creating Microsoft accounts with referrals (+7,500 points/month!) +- ✅ Setting up 2FA authentication +- ✅ Configuration options +- ✅ Troubleshooting common issues --- ## 📚 Documentation -For detailed configuration, advanced features, and troubleshooting, visit our comprehensive documentation: +**New to the bot?** Start here: **[📘 Getting Started Guide](docs/getting-started.md)** -**👉 [Complete Documentation](docs/index.md)** +**Need specific info?** Check the **[📖 Documentation Hub](docs/index.md)** -### Quick Links +
+📑 Quick Links -| Topic | Description | +| Guide | 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 | -| **[Dashboard](src/dashboard/README.md)** | 🆕 Local web dashboard for monitoring and control | -| **[External Scheduling](docs/schedule.md)** | Use OS schedulers for automation | -| **[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 | -| **[Error Reporting](docs/ERROR_REPORTING.md)** | 🆕 Automatic error reporting to help improve the project | -| **[Proxy Setup](docs/proxy.md)** | Configuring proxies for privacy | -| **[Troubleshooting](docs/diagnostics.md)** | Debug common issues and capture logs | +| **[Getting Started](docs/getting-started.md)** | Complete installation tutorial | +| **[Accounts & 2FA](docs/accounts.md)** | Setup accounts with authentication | +| **[Configuration](docs/config.md)** | Customize bot behavior | +| **[Scheduling](docs/schedule.md)** | Automate with cron/Task Scheduler | +| **[Notifications](docs/notifications.md)** | Discord & mobile alerts | +| **[Troubleshooting](docs/troubleshooting.md)** | Fix common issues | + +
--- @@ -127,17 +132,9 @@ Automatically create new Microsoft accounts with advanced security features: # Interactive mode (asks everything) npm run creator -# With referral link (earn rewards credit) -npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE - -# Auto-accept mode (enables recovery + 2FA automatically) -npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y - # With specific recovery email (auto-detected, no flag needed!) npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com -# Just recovery email, no referral -npm run creator -y myrecovery@gmail.com ``` **✨ Features:** @@ -210,7 +207,7 @@ Configure automatic task scheduling directly from `config.jsonc` - **perfect for **Then simply run:** ```bash -npm run start +npm start ``` The bot will automatically configure cron (Linux/Raspberry Pi) or Task Scheduler (Windows) for you! @@ -315,74 +312,39 @@ All while maintaining **natural behavior patterns** to minimize detection risk. --- -## 🆘 Getting Help +## 🆘 Need Help? -- 💬 **[Join our Discord](https://discord.gg/k5uHkx9mne)** — Community support and updates -- 📖 **[Documentation Hub](docs/index.md)** — Complete guides and references -- 🐛 **[Report Issues](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Bug reports and feature requests -- 📧 **[Troubleshooting Guide](docs/diagnostics.md)** — Debug common issues +- 💬 **[Discord Community](https://discord.gg/k5uHkx9mne)** — Get support & updates +- 📖 **[Documentation](docs/index.md)** — Complete guides +- 🐛 **[Report Bug](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Found an issue? +- � **[Troubleshooting](docs/troubleshooting.md)** — Fix common problems --- ## ⚠️ 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: +This bot automates Microsoft Rewards interactions, which **may violate their Terms of Service**. -- ⚠️ Account suspension or permanent ban -- 🚫 Loss of accumulated points and rewards -- 🔒 Restriction from future participation +**Risks:** +- ⚠️ Account suspension or ban +- 🚫 Loss of points and rewards -**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.** +**Educational purposes only.** Use at your own risk. --- ## 📄 License -This project is licensed under the **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License**. +**CC BY-NC-SA 4.0** — Personal use only, no commercial use. -**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/Obsidian-wtf/Microsoft-Rewards-Bot/graphs/contributors) -- Community support via [Discord](https://discord.gg/k5uHkx9mne) - ---- - -## 🌟 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 +See [LICENSE](LICENSE) for details. ---
-**Made with ❤️ by the community** +**⭐ Star the repo** • **💬 [Join Discord](https://discord.gg/k5uHkx9mne)** • **� [Documentation](docs/index.md)** -[Documentation](docs/index.md) • [Discord](https://discord.gg/k5uHkx9mne) • [Issues](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues) +Made with ❤️ by the community
diff --git a/docs/getting-started.md b/docs/getting-started.md index d77b6fc..2eb9a1e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,396 +1,204 @@ -# 🚀 Getting Started# 🚀 Getting Started Guide
+# 🚀 Getting Started# 🚀 Getting Started# 🚀 Getting Started Guide
-**Complete step-by-step guide to set up and run Microsoft Rewards Bot** +
-[← Back to Documentation](index.md)Complete step-by-step tutorial to set up and run Microsoft Rewards Bot.Microsoft Rewards Script Logo +**Complete guide to set up and run Microsoft Rewards Bot****Complete step-by-step guide to set up and run Microsoft Rewards Bot** ---- +*From zero to earning points in 10 minutes* -## 📋 Table of Contents---# 🚀 Getting Started +[← Back to Documentation](index.md)[← Back to Documentation](index.md)Complete step-by-step tutorial to set up and run Microsoft Rewards Bot.Microsoft Rewards Script Logo -1. [Prerequisites](#-prerequisites) +
-2. [Get the Project](#-get-the-project) -3. [Create Accounts](#-create-accounts)## 📋 Table of Contents**🎯 From zero to earning Microsoft Rewards points in minutes** + +------ + + + +## 📋 Table of Contents + + + +1. [Requirements](#-requirements)## 📋 Table of Contents---# 🚀 Getting Started + +2. [Installation](#-installation) + +3. [Account Setup](#-account-setup) 4. [Configuration](#-configuration) -5. [First Run](#-first-run)*Complete setup guide for beginners* +5. [First Run](#-first-run)1. [Prerequisites](#-prerequisites) -6. [What's Next](#-whats-next) +6. [Next Steps](#-next-steps) -1. [Prerequisites](#-prerequisites) +7. [Troubleshooting](#-troubleshooting)2. [Get the Project](#-get-the-project) ---- -2. [Get the Project](#-get-the-project)
-## ✅ Prerequisites +---3. [Create Accounts](#-create-accounts)## 📋 Table of Contents**🎯 From zero to earning Microsoft Rewards points in minutes** -3. [Create Microsoft Accounts](#-create-microsoft-accounts) -Before starting, you need: -4. [Configuration](#-configuration)--- +## ✅ Requirements4. [Configuration](#-configuration) -### 1. Node.js 20 or Higher -5. [First Run](#-first-run) -- **Download:** https://nodejs.org/ +Before starting, you need:5. [First Run](#-first-run)*Complete setup guide for beginners* -- **Recommended:** Version 226. [Troubleshooting](#-troubleshooting)## ✅ Requirements + + +### 1. Node.js 20 or Higher6. [What's Next](#-whats-next) + + + +- **Download:** https://nodejs.org/ (get the LTS version)1. [Prerequisites](#-prerequisites) - **Verify installation:** - ```bash + ```bash--- node --version - ```---- **Node.js 18+** (22 recommended) — [Download here](https://nodejs.org/) + ```2. [Get the Project](#-get-the-project)
- Should show `v20.x.x` or higher + Should show `v20.x.x` or `v22.x.x` -- **Microsoft accounts** with email + password +## ✅ Prerequisites -### 2. Git (Optional but Recommended) +### 2. Microsoft Accounts -## ✅ Prerequisites- **Optional:** Docker for containerized deployment +3. [Create Microsoft Accounts](#-create-microsoft-accounts) -- **Download:** https://git-scm.com/ +- At least **one Microsoft account** (Outlook/Hotmail email) + +- If you don't have one, see [Creating New Accounts](#creating-new-accounts-bonus)Before starting, you need: + + + +### 3. Git (Optional)4. [Configuration](#-configuration)--- + + + +- **Download:** https://git-scm.com/### 1. Node.js 20 or Higher - **Alternative:** Download project as ZIP from GitHub - - -### 3. Your Referral LinkBefore starting, you need:--- - - - -**💰 Important: You earn 7,500 points per month for each account you refer!** - - - -1. Log into your **main Microsoft account**1. **Node.js 20+** (version 22 recommended)## ⚡ Quick Setup (Recommended) - -2. Go to: https://rewards.bing.com/referandearn/ - -3. Copy your referral link (format: `https://rewards.bing.com/welcome?rh=XXXXX`) - Download: https://nodejs.org/ - - - ---- - Verify: `node --version` should show v20 or higher
- - - -## 📦 Get the Project - - - -### Option 1: Git Clone (Recommended)2. **Git** (optional, but recommended)### **🎬 One Command, Total Automation** - - - -```bash - Download: https://git-scm.com/ - -git clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git - -cd Microsoft-Rewards-Bot - Or download project as ZIP
- -``` - - - -### Option 2: Download ZIP - -3. **A main Microsoft account** (your personal account)```bash - -1. Visit: https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot - -2. Click **Code** → **Download ZIP** - Go to https://rewards.bing.com/referandearn/# 🪟 Windows - -3. Extract the ZIP file - -4. Open a terminal in the extracted folder - Copy your referral link (looks like: `https://rewards.bing.com/welcome?rh=XXXX`)setup/setup.bat - - - -### Install Dependencies - **Why?** You earn **7,500 points per month** for each referral! - - - -```bash# 🐧 Linux/macOS/WSL - -npm i - -```---bash setup/setup.sh - - - -This installs all required packages (~2-3 minutes). - - - ----## 📦 Get the Project# 🌍 Any platform - - - -## 🎯 Create Accountsnpm run setup - - - -### Why Use the Account Creator?### Option 1: Git Clone (Recommended)``` - - - -- ✅ **Earn 7,500 bonus points** per month per referral - -- ✅ Creates realistic accounts (avoids detection) - -- ✅ Automatic enrollment in Microsoft Rewards```bash**That's it!** The wizard will: - -- ✅ Built-in 2FA security with TOTP - -- ✅ Saves all account details for yougit clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git- ✅ Help you create `src/accounts.json` with your Microsoft credentials - - - -### Step 1: Get Your Referral Linkcd Microsoft-Rewards-Bot- ✅ Install all dependencies automatically - - - -If you haven't already:```- ✅ Build the TypeScript project - -1. Log into your main Microsoft account - -2. Visit: https://rewards.bing.com/referandearn/- ✅ Start earning points immediately - -3. Copy the referral URL - -### Option 2: Download ZIP - -### Step 2: Create Account +5. [First Run](#-first-run) --- -**Recommended command (full automation):** +- **Download:** https://nodejs.org/ + +## 📦 Installation + +- **Recommended:** Version 226. [Troubleshooting](#-troubleshooting)## ✅ Requirements + +### Option 1: Git Clone (Recommended) + +- **Verify installation:** + +```bash + +git clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git ```bash + +cd Microsoft-Rewards-Bot + +npm install node --version + +``` + + ```---- **Node.js 18+** (22 recommended) — [Download here](https://nodejs.org/) + +### Option 2: Download ZIP + + Should show `v20.x.x` or higher 1. Go to: https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot -```bash - -npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com2. Click **Code** → **Download ZIP**## 🛠️ Manual Setup - -``` +2. Click **Code** → **Download ZIP**- **Microsoft accounts** with email + password 3. Extract the ZIP file -**Replace:** +4. Open a terminal in the extracted folder### 2. Git (Optional but Recommended) -- `YOUR_CODE` → Your actual referral code4. Open terminal in the extracted folder
+5. Run: `npm install` -- `backup@gmail.com` → Your real recovery email +## ✅ Prerequisites- **Optional:** Docker for containerized deployment -📖 Prefer step-by-step? Click here +**Installation takes 2-3 minutes** to download dependencies. -**What this does:** - -1. Creates realistic Microsoft account (email, password, name, birthdate)### Install Dependencies - -2. Enrolls in Microsoft Rewards using YOUR referral - -3. Adds recovery email for account security### 1️⃣ **Configure Your Accounts** - -4. Enables 2FA with TOTP (Google Authenticator) - -5. Saves everything to `accounts-created/` folder```bash```bash - - - -### Step 3: Complete CAPTCHA & Verificationnpm icp src/accounts.example.json src/accounts.json - - - -During creation:```# Edit accounts.json with your Microsoft credentials - - - -1. **CAPTCHA**: Browser will pause - solve it manually (required by Microsoft)``` - -2. **Recovery Email**: Check your email, enter the 6-digit code - -3. **2FA Setup**: This will install all required packages. - - - Open Google Authenticator app on your phone - - - Scan the QR code shown in browser### 2️⃣ **Install Dependencies & Build** - - - Enter the 6-digit code from the app - -4. **Done**: Account saved automatically!---```bash - - - -### Step 4: Find Your Account Infonpm install - - - -After creation, a file is created in:## 🎯 Create Microsoft Accountsnpm run build - -``` - -accounts-created/account_USERNAME_TIMESTAMP.jsonc``` - -``` - -**⚠️ IMPORTANT: Use the account creator with YOUR referral link to earn 7,500 points per account per month!** - -Example content: - -```jsonc### 3️⃣ **Choose Your Mode** - -{ - - "email": "john.smith1995@outlook.com",### Step 1: Get Your Referral Link```bash - - "password": "Xyz789!@#AbcDef", - - "birthdate": {# Single run (test it works) - - "day": 15, - - "month": 6,1. Log into your **main Microsoft account**npm start - - "year": 1995 - - },2. Go to: https://rewards.bing.com/referandearn/ - - "firstName": "John", - - "lastName": "Smith",3. Copy your referral link (format: `https://rewards.bing.com/welcome?rh=YOUR_CODE`)# Schedule it (Task Scheduler, cron, etc.) - - "createdAt": "2025-11-09T10:30:00.000Z", - - "referralUrl": "https://rewards.bing.com/welcome?rh=YOUR_CODE",# See docs/schedule.md for examples - - "recoveryEmail": "backup@gmail.com", - - "totpSecret": "JBSWY3DPEHPK3PXP",### Step 2: Create Accounts``` - - "recoveryCode": "MWGR3-9MJC9-STK76-SZCE5-X77PR" - -} - -``` - -**Recommended command** (enables everything):
- -**⚠️ KEEP THIS FILE SAFE!** - -- `totpSecret` → Required for bot login (2FA) - -- `recoveryCode` → Emergency account recovery - -- `birthdate` → Needed if account gets suspended```bash--- - -- All info → Needed to restore account if banned - -npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com - -### Alternative: Without 2FA (Not Recommended) - -```## 🎯 What Happens Next? - -If you don't want 2FA: - - - -```bash - -npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE**Replace:**The script will automatically: - -``` - -- `YOUR_CODE` with your actual referral code- 🔍 **Search Bing** for points (desktop + mobile) - -Then answer "n" when asked about 2FA setup. - -- `backup@gmail.com` with your real recovery email- 📅 **Complete daily sets** (quizzes, polls, activities) +- **Download:** https://git-scm.com/ --- -- 🎁 **Grab promotions** and bonus opportunities +- **Alternative:** Download project as ZIP from GitHub -## ⚙️ Configuration +## 🎯 Account Setup -**What this does:**- 🃏 **Work on punch cards** (multi-day challenges) -### Step 1: Setup Accounts File -1. ✅ Creates a realistic Microsoft account (email, password, name, birthdate)- ✅ **Daily check-ins** for easy points +You have **two options** for setting up accounts: -You have 2 options: +### 3. Your Referral LinkBefore starting, you need:--- -2. ✅ Enrolls in Microsoft Rewards using YOUR referral link- 📚 **Read articles** for additional rewards +### Option A: Setup Wizard (Easiest) -#### Option A: Setup Wizard (Easiest) -3. ✅ Adds recovery email for account security + +Run the interactive setup wizard: + +**💰 Important: You earn 7,500 points per month for each account you refer!** ```bash -npm run setup4. ✅ Enables 2FA with TOTP (Google Authenticator)**All while looking completely natural to Microsoft!** 🤖 +# Windows + +setup\setup.bat + +1. Log into your **main Microsoft account**1. **Node.js 20+** (version 22 recommended)## ⚡ Quick Setup (Recommended) + +# Linux/Mac/WSL + +bash setup/setup.sh2. Go to: https://rewards.bing.com/referandearn/ + + + +# Or via npm3. Copy your referral link (format: `https://rewards.bing.com/welcome?rh=XXXXX`) - Download: https://nodejs.org/ + +npm run setup ``` -5. ✅ Saves everything to `accounts-created/` folder -The wizard will: -- Create `src/accounts.jsonc` from template--- +The wizard will:--- - Verify: `node --version` should show v20 or higher
-- Guide you through configuration +- ✅ Create `src/accounts.jsonc` from template -- Build the project automatically### Step 3: CAPTCHA & Verification +- ✅ Guide you through adding your Microsoft account(s) + +- ✅ Build the TypeScript project + +- ✅ Verify everything works## 📦 Get the Project -**On Windows:**## 🐳 Docker Alternative - -```powershell - -setup\setup.batDuring account creation: - -``` - -If you prefer containers: - -**On Linux/Mac:** - -```bash1. **CAPTCHA**: The browser will pause - solve it manually - -bash setup/setup.sh - -```2. **Recovery Email**: Check your email, enter the verification code```bash +### Option B: Manual Setup -#### Option B: Manual Setup3. **2FA Setup**: Scan the QR code with Google Authenticator app# Ensure accounts.json and config.json exist - - - -1. **Copy the template:**4. **Complete**: Account details saved automaticallydocker compose up -d +1. **Copy the template:**### Option 1: Git Clone (Recommended)2. **Git** (optional, but recommended)### **🎬 One Command, Total Automation** ```bash @@ -398,8 +206,602 @@ bash setup/setup.sh copy src\accounts.example.jsonc src\accounts.jsonc + ```bash - Download: https://git-scm.com/ + + # Linux/Mac + + cp src/accounts.example.jsonc src/accounts.jsoncgit clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git + + ``` + +cd Microsoft-Rewards-Bot - Or download project as ZIP
+ +2. **Edit `src/accounts.jsonc`:** + + ```jsonc``` + + { + + "accounts": [ + + { + + "email": "your@email.com",### Option 2: Download ZIP + + "password": "your_password", + + "recoveryEmail": "backup@gmail.com", // Optional but recommended3. **A main Microsoft account** (your personal account)```bash + + "totp": "", // Leave empty for now + + "enabled": true1. Visit: https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot + + } + + ]2. Click **Code** → **Download ZIP** - Go to https://rewards.bing.com/referandearn/# 🪟 Windows + + } + + ```3. Extract the ZIP file + + + +3. **Build the project:**4. Open a terminal in the extracted folder - Copy your referral link (looks like: `https://rewards.bing.com/welcome?rh=XXXX`)setup/setup.bat + + ```bash + + npm run build + + ``` + +### Install Dependencies - **Why?** You earn **7,500 points per month** for each referral! + +**📖 Need 2FA/TOTP?** See [Accounts & 2FA Guide](accounts.md) for detailed setup. + + + +--- + +```bash# 🐧 Linux/macOS/WSL + +## 🆕 Creating New Accounts (Bonus) + +npm i + +**💰 Important:** You earn **7,500 bonus points per month** for each account created with your referral link! + +```---bash setup/setup.sh + +### Step 1: Get Your Referral Link + + + +1. Log into your **main Microsoft account** + +2. Go to: https://rewards.bing.com/referandearn/This installs all required packages (~2-3 minutes). + +3. Copy your referral URL (format: `https://rewards.bing.com/welcome?rh=XXXXX`) + + + +### Step 2: Create Account with Bot + +---## 📦 Get the Project# 🌍 Any platform + +**Recommended command** (full automation with 2FA): + + + +```bash + +npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com## 🎯 Create Accountsnpm run setup + +``` + + + +**Replace:** + +- `YOUR_CODE` → Your actual referral code### Why Use the Account Creator?### Option 1: Git Clone (Recommended)``` + +- `backup@gmail.com` → Your real recovery email + + + +**What this does:** + +1. ✅ Creates realistic Microsoft account (email, password, name, birthdate)- ✅ **Earn 7,500 bonus points** per month per referral + +2. ✅ Enrolls in Microsoft Rewards using YOUR referral + +3. ✅ Adds recovery email for account security- ✅ Creates realistic accounts (avoids detection) + +4. ✅ Enables 2FA with TOTP (Google Authenticator) + +5. ✅ Saves everything to `accounts-created/` folder- ✅ Automatic enrollment in Microsoft Rewards```bash**That's it!** The wizard will: + + + +### Step 3: Complete CAPTCHA- ✅ Built-in 2FA security with TOTP + + + +During creation:- ✅ Saves all account details for yougit clone https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot.git- ✅ Help you create `src/accounts.json` with your Microsoft credentials + +1. **CAPTCHA**: Browser will pause - solve it manually + +2. **Recovery Email**: Check your email, enter the 6-digit code + +3. **2FA Setup**: Scan QR code with Google Authenticator app + +4. **Done**: Account details saved automatically!### Step 1: Get Your Referral Linkcd Microsoft-Rewards-Bot- ✅ Install all dependencies automatically + + + +### Step 4: Find Your Account Info + + + +After creation, find the file in:If you haven't already:```- ✅ Build the TypeScript project + +``` + +accounts-created/account_USERNAME_TIMESTAMP.jsonc1. Log into your main Microsoft account + +``` + +2. Visit: https://rewards.bing.com/referandearn/- ✅ Start earning points immediately + +Example content: + +```jsonc3. Copy the referral URL + +{ + + "email": "john.smith1995@outlook.com",### Option 2: Download ZIP + + "password": "Xyz789!@#AbcDef", + + "firstName": "John",### Step 2: Create Account + + "lastName": "Smith", + + "birthdate": {--- + + "day": 15, + + "month": 6,**Recommended command (full automation):** + + "year": 1995 + + },1. Go to: https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot + + "referralUrl": "https://rewards.bing.com/welcome?rh=YOUR_CODE", + + "recoveryEmail": "backup@gmail.com",```bash + + "totpSecret": "JBSWY3DPEHPK3PXP", + + "recoveryCode": "MWGR3-9MJC9-STK76-SZCE5-X77PR"npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com2. Click **Code** → **Download ZIP**## 🛠️ Manual Setup + +} + +`````` + + + +**⚠️ KEEP THIS FILE SAFE!**3. Extract the ZIP file + +- `totpSecret` → Required for bot login (2FA) + +- `recoveryCode` → Emergency account recovery**Replace:** + +- `birthdate` → Needed if account gets suspended + +- `YOUR_CODE` → Your actual referral code4. Open terminal in the extracted folder
+ +**📖 More details:** [Account Creator Full Guide](../src/account-creation/README.md) + +- `backup@gmail.com` → Your real recovery email + +--- + +📖 Prefer step-by-step? Click here + +## ⚙️ Configuration + +**What this does:** + +The bot works **great with default settings**, but you can customize it: + +1. Creates realistic Microsoft account (email, password, name, birthdate)### Install Dependencies + +### Essential Settings + +2. Enrolls in Microsoft Rewards using YOUR referral + +Open `src/config.jsonc` and review these: + +3. Adds recovery email for account security### 1️⃣ **Configure Your Accounts** + +```jsonc + +{4. Enables 2FA with TOTP (Google Authenticator) + + "humanization": { + + "enabled": true, // ⚠️ ALWAYS keep this true!5. Saves everything to `accounts-created/` folder```bash```bash + + "stopOnBan": true // Stop if ban detected + + }, + + "workers": { + + "doDesktopSearch": true, // Desktop Bing searches### Step 3: Complete CAPTCHA & Verificationnpm icp src/accounts.example.json src/accounts.json + + "doMobileSearch": true, // Mobile Bing searches + + "doDailySet": true, // Daily activities + + "doMorePromotions": true, // Promotional offers + + "doPunchCards": true // Multi-day challengesDuring creation:```# Edit accounts.json with your Microsoft credentials + + } + +} + +``` + +1. **CAPTCHA**: Browser will pause - solve it manually (required by Microsoft)``` + +### Optional: Enable Scheduling + +2. **Recovery Email**: Check your email, enter the 6-digit code + +For **automatic daily runs**: + +3. **2FA Setup**: This will install all required packages. + +```jsonc + +{ - Open Google Authenticator app on your phone + + "scheduling": { + + "enabled": true, - Scan the QR code shown in browser### 2️⃣ **Install Dependencies & Build** + + "type": "auto", + + "cron": { - Enter the 6-digit code from the app + + "schedule": "0 9 * * *" // Daily at 9 AM (Linux/Mac/Raspberry Pi) + + },4. **Done**: Account saved automatically!---```bash + + "taskScheduler": { + + "schedule": "09:00" // Daily at 9:00 (Windows) + + } + + }### Step 4: Find Your Account Infonpm install + +} + +``` + + + +**How it works:**After creation, a file is created in:## 🎯 Create Microsoft Accountsnpm run build + +- Run `npm start` once + +- Bot automatically schedules itself``` + +- Runs every day at your chosen time + +- Perfect for Raspberry Pi!accounts-created/account_USERNAME_TIMESTAMP.jsonc``` + + + +**📖 More options:** [Configuration Guide](config.md) | [Scheduling Guide](schedule.md)``` + + + +---**⚠️ IMPORTANT: Use the account creator with YOUR referral link to earn 7,500 points per account per month!** + + + +## 🎮 First RunExample content: + + + +### Manual Run```jsonc### 3️⃣ **Choose Your Mode** + + + +```bash{ + +npm start + +``` "email": "john.smith1995@outlook.com",### Step 1: Get Your Referral Link```bash + + + +**What happens:** "password": "Xyz789!@#AbcDef", + +1. Bot logs into each enabled account + +2. Completes desktop searches (~30 searches) "birthdate": {# Single run (test it works) + +3. Completes mobile searches (~20 searches) + +4. Does daily activities (quizzes, polls) "day": 15, + +5. Completes promotional offers + +6. Shows summary of points earned "month": 6,1. Log into your **main Microsoft account**npm start + + + +### With Scheduling "year": 1995 + + + +If you enabled scheduling: },2. Go to: https://rewards.bing.com/referandearn/ + +```bash + +npm start "firstName": "John", + +``` + + "lastName": "Smith",3. Copy your referral link (format: `https://rewards.bing.com/welcome?rh=YOUR_CODE`)# Schedule it (Task Scheduler, cron, etc.) + +The bot will: + +- Run immediately once "createdAt": "2025-11-09T10:30:00.000Z", + +- **Automatically schedule future runs** (daily) + +- No need to run manually again! "referralUrl": "https://rewards.bing.com/welcome?rh=YOUR_CODE",# See docs/schedule.md for examples + + + +--- "recoveryEmail": "backup@gmail.com", + + + +## 🔧 Next Steps "totpSecret": "JBSWY3DPEHPK3PXP",### Step 2: Create Accounts``` + + + +Now that you're set up, explore these features: "recoveryCode": "MWGR3-9MJC9-STK76-SZCE5-X77PR" + + + +### High Priority} + + + +| Guide | Why Important |``` + +|-------|---------------| + +| **[Accounts & 2FA](accounts.md)** | Set up TOTP for secure automation |**Recommended command** (enables everything):
+ +| **[Scheduling](schedule.md)** | Automate with Task Scheduler or cron | + +**⚠️ KEEP THIS FILE SAFE!** + +### Medium Priority + +- `totpSecret` → Required for bot login (2FA) + +| Guide | Why Useful | + +|-------|------------|- `recoveryCode` → Emergency account recovery + +| **[Notifications](notifications.md)** | Get alerts on your phone | + +| **[Dashboard](../src/dashboard/README.md)** | Monitor accounts in real-time |- `birthdate` → Needed if account gets suspended```bash--- + + + +### Optional- All info → Needed to restore account if banned + + + +| Guide | When Needed |npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com + +|-------|-------------| + +| **[Proxy Setup](proxy.md)** | Enhanced privacy |### Alternative: Without 2FA (Not Recommended) + +| **[Docker](docker.md)** | Containerized deployment | + +```## 🎯 What Happens Next? + +--- + +If you don't want 2FA: + +## ❓ Troubleshooting + + + +### "Account credentials are invalid" + +```bash + +**Problem**: Wrong email/password or missing TOTP + +npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE**Replace:**The script will automatically: + +**Solution**: + +1. Check `src/accounts.jsonc` has correct credentials``` + +2. If 2FA enabled, make sure `totp` field has the secret + +3. Test login manually: https://login.live.com/- `YOUR_CODE` with your actual referral code- 🔍 **Search Bing** for points (desktop + mobile) + + + +### "Ban detected" or "Account suspended"Then answer "n" when asked about 2FA setup. + + + +**Problem**: Microsoft detected automation- `backup@gmail.com` with your real recovery email- 📅 **Complete daily sets** (quizzes, polls, activities) + + + +**Solutions**:--- + +- ✅ Always keep `humanization.enabled: true` + +- ✅ Don't run bot multiple times per day- 🎁 **Grab promotions** and bonus opportunities + +- ✅ Use proxies (see [Proxy Guide](proxy.md)) + +- ✅ Start with 1-2 accounts to test## ⚙️ Configuration + + + +**Account Recovery**:**What this does:**- 🃏 **Work on punch cards** (multi-day challenges) + +- Use `birthdate` from `accounts-created/` file + +- Use `recoveryCode` if you can't login### Step 1: Setup Accounts File + + + +### "Browser launch failed"1. ✅ Creates a realistic Microsoft account (email, password, name, birthdate)- ✅ **Daily check-ins** for easy points + + + +**Solution:**You have 2 options: + +```bash + +npx playwright install chromium2. ✅ Enrolls in Microsoft Rewards using YOUR referral link- 📚 **Read articles** for additional rewards + +``` + +#### Option A: Setup Wizard (Easiest) + +### "Module not found" errors + +3. ✅ Adds recovery email for account security + +**Solution:** + +```bash```bash + +npm install + +npm run buildnpm run setup4. ✅ Enables 2FA with TOTP (Google Authenticator)**All while looking completely natural to Microsoft!** 🤖 + +``` + +``` + +### Setup Script Issues + +5. ✅ Saves everything to `accounts-created/` folder + +**Windows (if PowerShell blocks scripts):** + +```powershellThe wizard will: + +# Run as Administrator + +Set-ExecutionPolicy RemoteSigned -Scope CurrentUser- Create `src/accounts.jsonc` from template--- + +.\setup\setup.bat + +```- Guide you through configuration + + + +**Linux/Mac (if permission denied):**- Build the project automatically### Step 3: CAPTCHA & Verification + +```bash + +chmod +x setup/setup.sh + +bash setup/setup.sh + +```**On Windows:**## 🐳 Docker Alternative + + + +**📖 More help:** [Troubleshooting Guide](troubleshooting.md)```powershell + + + +---setup\setup.batDuring account creation: + + + +## 🎯 Best Practices``` + + + +1. ✅ **Use referral links** — Earn 7,500 extra points per account per monthIf you prefer containers: + +2. ✅ **Enable 2FA** — Protects accounts from theft + +3. ✅ **Keep humanization ON** — Reduces ban risk significantly**On Linux/Mac:** + +4. ✅ **Run once per day** — Don't over-automate + +5. ✅ **Save account files** — Keep `accounts-created/` folder safe```bash1. **CAPTCHA**: The browser will pause - solve it manually + +6. ✅ **Use recovery email** — Helps recover suspended accounts + +7. ✅ **Monitor logs** — Watch for ban warningsbash setup/setup.sh + +8. ✅ **Start small** — Test with 1-2 accounts first + +```2. **Recovery Email**: Check your email, enter the verification code```bash + +--- + + + +## 🆘 Still Need Help? + +#### Option B: Manual Setup3. **2FA Setup**: Scan the QR code with Google Authenticator app# Ensure accounts.json and config.json exist + +- 💬 **[Join Discord](https://discord.gg/k5uHkx9mne)** — Community support + +- 📖 **[Documentation Hub](index.md)** — All guides + +- 🐛 **[Report Issue](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Found a bug? + +1. **Copy the template:**4. **Complete**: Account details saved automaticallydocker compose up -d + +--- + + ```bash + +
+ + # Windows + +**Happy farming! 🎉** + + copy src\accounts.example.jsonc src\accounts.jsonc + +[← Back to Documentation](index.md) + ### Step 4: Find Your Account Info# Follow logs +
+ # Linux/Mac cp src/accounts.example.jsonc src/accounts.jsoncdocker logs -f microsoft-rewards-bot diff --git a/docs/index.md b/docs/index.md index eedc6fa..5ebcfe6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,52 +1,228 @@ +
+ + + +Microsoft Rewards Bot Logo# 📚 Documentation + + + +# 📚 Documentation Hub**Complete guide for Microsoft Rewards Bot** + + + +**Complete guides for Microsoft Rewards Bot**[← Back to Main](../README.md) + + + +[← Back to Main](../README.md)
+ + + +
--- + + + +---## 🚀 Quick Start (3 Steps) + + + +## 🚀 Getting Started1. **[Setup Accounts](accounts.md)** — Add credentials + 2FA + +2. **[Configure Bot](config.md)** — Essential settings + +**New to the bot?** Start with these guides in order:3. **[Schedule Runs](schedule.md)** — Use OS-level automation + + + +| Step | Guide | What You'll Learn |**Done!** The bot will run automatically. + +|------|-------|-------------------| + +| **1** | **[📘 Getting Started](getting-started.md)** | Installation, account setup, first run |--- + +| **2** | **[👤 Accounts & 2FA](accounts.md)** | Add accounts, enable TOTP authentication | + +| **3** | **[⚙️ Configuration](config.md)** | Customize bot behavior and features |## ✨ Feature Guides + +| **4** | **[⏰ Scheduling](schedule.md)** | Automate daily runs with cron/Task Scheduler | + +| Feature | Description | + +**That's all you need to get started!** The guides above cover everything for basic usage.|---------|-------------| + +| **[Configuration](config.md)** | All settings explained | + +---| **[External Scheduling](schedule.md)** | Automate with cron or Task Scheduler | + +| **[Humanization](humanization.md)** | Anti-detection system | + +## 📖 Feature Guides| **[Webhooks](conclusionwebhook.md)** | Discord notifications | + +| **[Error Reporting](ERROR_REPORTING.md)** | 🆕 Automatic error reporting | + +Explore advanced features and customization options:| **[NTFY Alerts](ntfy.md)** | Mobile push notifications | + +| **[Proxy Setup](proxy.md)** | IP rotation (optional) | + +### Core Features| **[Docker](docker.md)** | Container deployment | + + + +| Guide | Description |--- + +|-------|-------------| + +| **[🔔 Notifications](notifications.md)** | Discord webhooks and mobile push alerts |## 🆘 Troubleshooting + +| **[📊 Dashboard](../src/dashboard/README.md)** | Web interface for monitoring and control | + +| **[🌐 Proxy Setup](proxy.md)** | Configure proxies for privacy || Issue | Solution | + +| **[🤖 Humanization](humanization.md)** | Anti-detection and natural behavior patterns ||-------|----------| + +| **Bot not working?** | [Troubleshooting Guide](diagnostics.md) | + +### Deployment| **Login failed?** | [Accounts & 2FA](accounts.md#troubleshooting) | + +| **Account banned?** | [Security Guide](security.md) | + +| Guide | Description || **Git conflicts?** | [Conflict Resolution](git-conflict-resolution.md) | + +|-------|-------------|| **General questions?** | [FAQ](FAQ.md) | + +| **[🐳 Docker](docker.md)** | Containerized deployment with Docker Compose | + +| **[☁️ Cloud Deployment](cloud-deployment.md)** | Deploy to VPS, Raspberry Pi, or cloud services |**Need help?** → [Discord Community](https://discord.gg/k5uHkx9mne) + + + +### Advanced--- + + + +| Guide | Description |[← Back to Main](../README.md) + +|-------|-------------| +| **[🔧 Advanced Configuration](advanced-config.md)** | Power user settings and optimization | +| **[🛡️ Security Best Practices](security.md)** | Account protection and risk management | + +--- + +## 🆕 Account Creator + +**Create new Microsoft accounts with the built-in account creator:** + +| Guide | Description | +|-------|-------------| +| **[🎯 Account Creator Guide](../src/account-creation/README.md)** | Create accounts with 2FA and referral links | +| **[💰 Referral System](referrals.md)** | Earn 7,500 points/month per referral | + +**Quick command:** +```bash +npm run creator https://rewards.bing.com/welcome?rh=YOUR_CODE -y backup@gmail.com +``` + +--- + +## 🆘 Help & Troubleshooting + +Having issues? Check these resources: + +### Common Issues + +| Problem | Solution | +|---------|----------| +| **Bot not starting** | [Troubleshooting Guide](troubleshooting.md) | +| **Login failures** | [Accounts & 2FA Setup](accounts.md#troubleshooting) | +| **Account banned** | [Security Guide](security.md) | +| **Configuration errors** | [Config Reference](config.md) | + +### Support Resources + +- 💬 **[Discord Community](https://discord.gg/k5uHkx9mne)** — Get help from the community +- 🐛 **[GitHub Issues](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Report bugs +- 📖 **[FAQ](FAQ.md)** — Frequently asked questions +- 🔍 **[Diagnostics Guide](diagnostics.md)** — Debug and capture logs + +--- + +## 📚 Reference Documentation + +Technical references and detailed information: + +### Configuration + +| Document | Description | +|----------|-------------| +| **[Config Reference](config.md)** | Complete `config.jsonc` options | +| **[Accounts Reference](accounts.md)** | Complete `accounts.jsonc` schema | +| **[Environment Variables](environment-variables.md)** | Available env vars for CI/Docker | + +### Technical + +| Document | Description | +|----------|-------------| +| **[API Documentation](../src/dashboard/README.md)** | Dashboard REST API endpoints | +| **[Error Reporting](ERROR_REPORTING.md)** | Automatic error reporting system | +| **[Changelog](../CHANGELOG.md)** | Version history and changes | + +--- + +## 🎓 Guides by Topic + +### For Beginners + +1. [Getting Started](getting-started.md) — Start here! +2. [Accounts & 2FA](accounts.md) — Setup your accounts +3. [First Run](getting-started.md#-first-run) — Test the bot +4. [Scheduling](schedule.md) — Automate daily runs + +### For Raspberry Pi Users + +1. [Getting Started](getting-started.md) — Installation steps +2. [Scheduling](schedule.md) — Setup cron for daily runs +3. [Notifications](notifications.md) — Get mobile alerts +4. [Cloud Deployment](cloud-deployment.md) — Run 24/7 + +### For Docker Users + +1. [Docker Guide](docker.md) — Setup Docker Compose +2. [Environment Variables](environment-variables.md) — Configure via env vars +3. [Notifications](notifications.md) — Monitor container runs + +### For Multiple Accounts + +1. [Accounts & 2FA](accounts.md) — Manage multiple accounts +2. [Proxy Setup](proxy.md) — Use different IPs per account +3. [Advanced Config](advanced-config.md) — Parallel execution +4. [Referrals](referrals.md) — Earn bonus points + +--- + +## 🔗 External Resources + +- **[Microsoft Rewards](https://rewards.bing.com/)** — Official Microsoft Rewards site +- **[Playwright Docs](https://playwright.dev/)** — Browser automation framework +- **[Node.js](https://nodejs.org/)** — JavaScript runtime +- **[TypeScript](https://www.typescriptlang.org/)** — Programming language + +--- + +## 🤝 Contributing + +Want to help improve the bot? + +- 📖 **[Contributing Guide](../CONTRIBUTING.md)** — How to contribute +- 🐛 **[Report Bugs](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Found an issue? +- 💡 **[Feature Requests](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Suggest new features +- 📝 **[Improve Docs](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/tree/main/docs)** — Help with documentation + +--- +
-# 📚 Documentation - -**Complete guide for Microsoft Rewards Bot** +**Need help?** [Join our Discord](https://discord.gg/k5uHkx9mne) [← Back to Main](../README.md)
- ---- - -## 🚀 Quick Start (3 Steps) - -1. **[Setup Accounts](accounts.md)** — Add credentials + 2FA -2. **[Configure Bot](config.md)** — Essential settings -3. **[Schedule Runs](schedule.md)** — Use OS-level automation - -**Done!** The bot will run automatically. - ---- - -## ✨ Feature Guides - -| Feature | Description | -|---------|-------------| -| **[Configuration](config.md)** | All settings explained | -| **[External Scheduling](schedule.md)** | Automate with cron or Task Scheduler | -| **[Humanization](humanization.md)** | Anti-detection system | -| **[Webhooks](conclusionwebhook.md)** | Discord notifications | -| **[Error Reporting](ERROR_REPORTING.md)** | 🆕 Automatic error reporting | -| **[NTFY Alerts](ntfy.md)** | Mobile push notifications | -| **[Proxy Setup](proxy.md)** | IP rotation (optional) | -| **[Docker](docker.md)** | Container deployment | - ---- - -## 🆘 Troubleshooting - -| Issue | Solution | -|-------|----------| -| **Bot not working?** | [Troubleshooting Guide](diagnostics.md) | -| **Login failed?** | [Accounts & 2FA](accounts.md#troubleshooting) | -| **Account banned?** | [Security Guide](security.md) | -| **Git conflicts?** | [Conflict Resolution](git-conflict-resolution.md) | -| **General questions?** | [FAQ](FAQ.md) | - -**Need help?** → [Discord Community](https://discord.gg/k5uHkx9mne) - ---- - -[← Back to Main](../README.md) diff --git a/docs/notifications.md b/docs/notifications.md new file mode 100644 index 0000000..5e695e3 --- /dev/null +++ b/docs/notifications.md @@ -0,0 +1,358 @@ +# 🔔 Notifications + +**Get alerts when the bot completes its run** + +[← Back to Documentation](index.md) + +--- + +## 📋 Table of Contents + +- [Discord Webhooks](#-discord-webhooks) +- [NTFY Mobile Alerts](#-ntfy-mobile-alerts) +- [Comparison](#-comparison) +- [Examples](#-examples) + +--- + +## 💬 Discord Webhooks + +Get detailed run summaries sent to your Discord server. + +### Setup + +#### 1. Create Webhook in Discord + +1. Open your Discord server +2. Go to **Server Settings** → **Integrations** → **Webhooks** +3. Click **New Webhook** +4. Name it (e.g., "Microsoft Rewards Bot") +5. Choose a channel +6. Click **Copy Webhook URL** + +#### 2. Add to Configuration + +Edit `src/config.jsonc`: + +```jsonc +{ + "conclusionWebhook": { + "enabled": true, + "webhookUrl": "https://discord.com/api/webhooks/123456789/AbCdEfGhIjKlMnOpQrStUvWxYz" + } +} +``` + +### What You'll Receive + +**Rich embeds with**: +- ✅ Total points earned +- 📊 Per-account breakdown +- ⏱️ Run duration +- 🎯 Completion status +- ⚠️ Errors and warnings + +**Example message**: +``` +🎉 Microsoft Rewards Summary + +Total Points: 450 +Duration: 12 minutes +Accounts Processed: 3/3 + +✅ account1@outlook.com: 150 points (45s) +✅ account2@outlook.com: 150 points (48s) +✅ account3@outlook.com: 150 points (42s) +``` + +### Advanced Options + +```jsonc +{ + "conclusionWebhook": { + "enabled": true, + "webhookUrl": "YOUR_WEBHOOK_URL", + "username": "Rewards Bot", // Custom bot name + "avatar": "https://example.com/avatar.png", // Custom avatar + "color": 3447003, // Embed color (decimal) + "onlyOnError": false, // Send only when errors occur + "pingOnError": true // @mention on errors + } +} +``` + +### Multiple Webhooks + +Send to different channels: + +```jsonc +{ + "conclusionWebhook": { + "enabled": true, + "webhookUrl": "WEBHOOK_FOR_SUCCESS", + "errorWebhookUrl": "WEBHOOK_FOR_ERRORS" // Separate channel for errors + } +} +``` + +--- + +## 📱 NTFY Mobile Alerts + +Get **instant push notifications** on your phone with [ntfy.sh](https://ntfy.sh/). + +### Setup + +#### 1. Install NTFY App + +- **Android**: [Google Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy) +- **iOS**: [App Store](https://apps.apple.com/us/app/ntfy/id1625396347) +- **Web**: https://ntfy.sh/app + +#### 2. Choose a Topic + +Pick a **unique topic name** (acts as your channel): +- Examples: `rewards-bot-john`, `msrewards-12345` +- Keep it secret to avoid spam! + +#### 3. Subscribe in App + +1. Open NTFY app +2. Tap **+** or **Subscribe** +3. Enter your topic name +4. Save + +#### 4. Add to Configuration + +Edit `src/config.jsonc`: + +```jsonc +{ + "ntfy": { + "enabled": true, + "topic": "your-unique-topic-name", // From step 2 + "priority": 3, // 1-5 (3 = default, 5 = urgent) + "tags": ["robot", "money"] // Optional emojis + } +} +``` + +### What You'll Receive + +**Simple push notifications**: +- ✅ Bot completion status +- 📊 Total points earned +- ⚠️ Error alerts +- ⏱️ Run duration + +**Example notification**: +``` +🤖 Rewards Bot Complete + +✅ 3 accounts processed +💰 450 points earned +⏱️ 12 minutes +``` + +### Priority Levels + +| Priority | Behavior | When to Use | +|----------|----------|-------------| +| 1 | Min | Background only, no sound | +| 2 | Low | Vibrate only | +| 3 | **Default** | Normal notification | +| 4 | High | Makes sound | +| 5 | Max | Critical alert, repeats | + +**Recommended**: Priority 3 or 4 for most use cases. + +### Custom NTFY Server + +Using your own NTFY server: + +```jsonc +{ + "ntfy": { + "enabled": true, + "server": "https://ntfy.yourdomain.com", // Your server + "topic": "your-topic", + "priority": 3 + } +} +``` + +### Advanced Options + +```jsonc +{ + "ntfy": { + "enabled": true, + "topic": "your-topic", + "priority": 4, + "tags": ["robot", "chart_increasing"], // Emojis in notification + "title": "Rewards Bot", // Custom title + "clickUrl": "https://rewards.bing.com", // URL to open on click + "attachUrl": "https://example.com/image.png", // Attach image + "onlyOnError": false, // Send only on errors + "email": "you@example.com" // Also send email + } +} +``` + +### Available Tags (Emojis) + +Common ones: +- `robot`, `money`, `chart`, `check`, `warning`, `fire` +- Full list: https://ntfy.sh/docs/emojis/ + +--- + +## ⚖️ Comparison + +| Feature | Discord Webhooks | NTFY | +|---------|------------------|------| +| **Setup** | Medium (need server) | Easy (just install app) | +| **Detail** | Rich embeds with full stats | Simple text notifications | +| **Speed** | Fast | Instant | +| **Mobile** | Requires Discord app | Dedicated notifications app | +| **Free** | ✅ Yes | ✅ Yes | +| **Privacy** | Data goes to Discord | Self-hostable | +| **Best For** | Detailed reports | Quick alerts | + +**Recommendation**: Use **both**! +- Discord for detailed daily reports +- NTFY for instant mobile alerts + +--- + +## 📝 Examples + +### Both Enabled (Recommended) + +```jsonc +{ + "conclusionWebhook": { + "enabled": true, + "webhookUrl": "YOUR_DISCORD_WEBHOOK" + }, + "ntfy": { + "enabled": true, + "topic": "your-unique-topic", + "priority": 3, + "tags": ["robot", "money"] + } +} +``` + +### Errors Only + +```jsonc +{ + "conclusionWebhook": { + "enabled": true, + "webhookUrl": "YOUR_DISCORD_WEBHOOK", + "onlyOnError": true // Only send when something goes wrong + }, + "ntfy": { + "enabled": true, + "topic": "your-topic", + "priority": 5, // Max priority for errors + "onlyOnError": true + } +} +``` + +### Different Priorities for Success/Error + +```jsonc +{ + "ntfy": { + "enabled": true, + "topic": "your-topic", + "priority": 3, // Normal for success + "priorityOnError": 5, // Urgent for errors + "tags": ["robot"], + "tagsOnError": ["warning", "fire"] // Different emoji on error + } +} +``` + +### Custom Formatting + +```jsonc +{ + "conclusionWebhook": { + "enabled": true, + "webhookUrl": "YOUR_WEBHOOK", + "username": "🤖 Rewards Bot", + "color": 3066993, // Green color (decimal) + "footer": "Powered by Microsoft Rewards Bot", + "timestamp": true // Show timestamp + } +} +``` + +--- + +## 🔧 Troubleshooting + +### Discord webhook not working + +**Check**: +1. Webhook URL is correct (starts with `https://discord.com/api/webhooks/`) +2. Webhook still exists in Discord server settings +3. Bot has permissions to send webhooks +4. Check console for error messages + +**Test manually**: +```bash +curl -X POST "YOUR_WEBHOOK_URL" \ + -H "Content-Type: application/json" \ + -d '{"content": "Test message"}' +``` + +### NTFY notifications not arriving + +**Check**: +1. Topic name is correct (case-sensitive!) +2. Subscribed in app with same topic +3. App has notification permissions +4. Internet connection is stable +5. Not using a banned/common topic name + +**Test manually**: +```bash +curl -d "Test notification" "https://ntfy.sh/your-topic" +``` + +Or visit in browser: https://ntfy.sh/your-topic + +### Rate limiting + +If sending too many notifications: + +```jsonc +{ + "conclusionWebhook": { + "enabled": true, + "webhookUrl": "YOUR_WEBHOOK", + "debounceMs": 5000 // Wait 5s between messages + } +} +``` + +--- + +## 🆘 Need Help? + +- 💬 **[Discord Community](https://discord.gg/k5uHkx9mne)** — Get support +- 📖 **[Configuration Guide](config.md)** — All config options +- 🐛 **[Report Issue](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Found a bug? + +--- + +
+ +[← Back to Documentation](index.md) + +
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 0000000..7047c74 --- /dev/null +++ b/docs/troubleshooting.md @@ -0,0 +1,402 @@ +# 🔧 Troubleshooting + +**Common issues and how to fix them** + +[← Back to Documentation](index.md) + +--- + +## 📋 Table of Contents + +- [Installation Issues](#-installation-issues) +- [Login Problems](#-login-problems) +- [Account Issues](#-account-issues) +- [Browser Issues](#-browser-issues) +- [Configuration Problems](#-configuration-problems) +- [Performance Issues](#-performance-issues) +- [Getting Diagnostic Logs](#-getting-diagnostic-logs) + +--- + +## 📦 Installation Issues + +### "npm install" fails + +**Problem**: Dependencies won't install + +**Solutions**: +```bash +# Clear npm cache +npm cache clean --force + +# Delete node_modules and try again +rm -rf node_modules package-lock.json +npm install + +# Try with legacy peer deps +npm install --legacy-peer-deps +``` + +### "npm run build" fails + +**Problem**: TypeScript compilation errors + +**Solution**: +```bash +# Make sure you have the latest dependencies +npm install + +# Check Node.js version (needs 20+) +node --version + +# Try cleaning build cache +npm run build --clean +``` + +### Permission denied (Linux/Mac) + +**Problem**: Can't run setup scripts + +**Solution**: +```bash +chmod +x setup/setup.sh +bash setup/setup.sh +``` + +### Execution policy error (Windows) + +**Problem**: PowerShell blocks scripts + +**Solution**: +```powershell +# Run as Administrator +Set-ExecutionPolicy RemoteSigned -Scope CurrentUser + +# Then run setup +.\setup\setup.bat +``` + +--- + +## 🔐 Login Problems + +### "Account credentials are invalid" + +**Cause**: Wrong email/password or missing TOTP + +**Solutions**: +1. **Verify credentials** in `src/accounts.jsonc` +2. **Test manually** at https://login.live.com/ +3. **Check TOTP** if 2FA enabled (see [Accounts Guide](accounts.md)) +4. **Check for typos** in email/password (copy-paste recommended) + +### "TOTP challenge still present after multiple attempts" + +**Cause**: Invalid TOTP secret or time sync issue + +**Solutions**: +1. **Verify TOTP secret** format (Base32, no spaces) +2. **Check system time** is accurate (use NTP) +3. **Re-setup 2FA** and get new secret +4. **Test with authenticator app** first + +Example of valid TOTP: +```jsonc +{ + "email": "test@outlook.com", + "password": "password123", + "totp": "JBSWY3DPEHPK3PXP" // ✅ Valid Base32 +} +``` + +### "Login timeout" or "Page did not load" + +**Cause**: Network issues or slow connection + +**Solutions**: +1. **Check internet connection** +2. **Increase timeout** in `config.jsonc`: + ```jsonc + { + "browserConfig": { + "timeout": 60000 // Increase to 60 seconds + } + } + ``` +3. **Use proxy** if connection is unreliable +4. **Disable VPN** temporarily to test + +### "Recovery email mismatch detected" + +**Cause**: Recovery email in config doesn't match Microsoft's records + +**Solutions**: +1. **Check recovery email** on https://account.microsoft.com/ +2. **Update `accounts.jsonc`** with correct recovery email +3. **Leave empty** if no recovery email set: + ```jsonc + { + "recoveryEmail": "" + } + ``` + +--- + +## 🚫 Account Issues + +### "Account suspended" or "Ban detected" + +**Cause**: Microsoft detected automation + +**Prevention**: +- ✅ **Always enable humanization** in config +- ✅ **Run once per day maximum** +- ✅ **Use different proxies** per account +- ✅ **Don't run multiple accounts** from same IP + +**Recovery Steps**: +1. **Wait 24-48 hours** before trying again +2. **Use account recovery** with birthdate/recovery code from `accounts-created/` +3. **Contact Microsoft support** if permanently banned +4. **Check [Security Guide](security.md)** for best practices + +### "Account locked" message + +**Cause**: Too many failed login attempts + +**Solution**: +1. Go to https://account.live.com/acsr +2. Follow the account recovery process +3. Use birthdate from `accounts-created/` file +4. Wait 24 hours before running bot again + +### "Verify it's you" security challenge + +**Cause**: Microsoft wants additional verification + +**Solutions**: +1. **Complete manually** at https://account.microsoft.com/ +2. **Add recovery email** if not set +3. **Enable 2FA** for better trust +4. **Use proxy** to avoid location inconsistencies + +--- + +## 🌐 Browser Issues + +### "Browser launch failed" or "Executable doesn't exist" + +**Cause**: Playwright browser not installed + +**Solution**: +```bash +npx playwright install chromium + +# Or install all browsers +npx playwright install +``` + +### Browser crashes or freezes + +**Cause**: Memory issues or system resources + +**Solutions**: +1. **Close other applications** +2. **Reduce clusters** in config: + ```jsonc + { + "execution": { + "clusters": 1 // Run one at a time + } + } + ``` +3. **Increase system RAM** if possible +4. **Check disk space** (needs ~500MB free) + +### "Chrome error://chromewebdata/" errors + +**Cause**: Browser navigation interrupted + +**Solution**: The bot automatically handles this with retry logic. If it persists: +1. **Check internet stability** +2. **Clear browser cache**: + ```bash + rm -rf sessions/ + ``` +3. **Reinstall Playwright**: + ```bash + npx playwright install --force chromium + ``` + +--- + +## ⚙️ Configuration Problems + +### "config.jsonc not found" + +**Solution**: +```bash +# Copy from example +cp src/config.example.jsonc src/config.jsonc + +# Or use setup wizard +npm run setup +``` + +### "accounts.jsonc not found" + +**Solution**: +```bash +# Copy from example +cp src/accounts.example.jsonc src/accounts.jsonc + +# Edit with your credentials +``` + +### "Invalid JSON" error + +**Cause**: Syntax error in JSON file + +**Solutions**: +1. **Use a JSON validator**: https://jsonlint.com/ +2. **Check for**: + - Missing commas + - Trailing commas before `}` + - Unescaped quotes in strings + - Missing closing brackets + +### Settings not applying + +**Solution**: +1. **Rebuild after config changes**: + ```bash + npm run build + ``` +2. **Restart bot** completely +3. **Check file is saved** before running + +--- + +## ⚡ Performance Issues + +### Bot runs very slowly + +**Causes & Solutions**: + +1. **Too many accounts running in parallel**: + ```jsonc + { + "execution": { + "clusters": 1 // Reduce from higher number + } + } + ``` + +2. **Slow internet connection**: + - Use wired connection instead of WiFi + - Increase timeouts in config + - Run during off-peak hours + +3. **System resources low**: + - Close other applications + - Check CPU/RAM usage + - Consider running on better hardware + +### Searches taking too long + +**Solution**: Adjust search delays: +```jsonc +{ + "search": { + "settings": { + "searchDelay": { + "min": 2000, // Reduce if too slow + "max": 3000 + } + } + } +} +``` + +### High memory usage + +**Solutions**: +1. **Run fewer accounts in parallel** +2. **Close browser between accounts**: + ```jsonc + { + "execution": { + "closeBrowserOnError": true + } + } + ``` +3. **Clear sessions regularly**: + ```bash + rm -rf sessions/ + ``` + +--- + +## 📊 Getting Diagnostic Logs + +### Capture full logs + +**Linux/Mac**: +```bash +npm start > logs.txt 2>&1 +``` + +**Windows**: +```powershell +npm start > logs.txt 2>&1 +``` + +### Enable debug mode + +Add to `config.jsonc`: +```jsonc +{ + "debug": true, + "headless": false // See browser in action +} +``` + +### Check dashboard logs + +If dashboard is enabled: +1. Go to http://localhost:3000 +2. Click "Logs" tab +3. View real-time logs +4. Download log file if needed + +### Useful log locations + +- **Main logs**: Console output +- **Error logs**: `reports/` folder (if error reporting enabled) +- **Screenshots**: `reports/screenshots/` (on errors) +- **Session data**: `sessions/` folder + +--- + +## 🆘 Still Need Help? + +If none of these solutions work: + +1. **💬 [Join Discord](https://discord.gg/k5uHkx9mne)** — Get community support +2. **🐛 [Open GitHub Issue](https://github.com/Obsidian-wtf/Microsoft-Rewards-Bot/issues)** — Report the bug +3. **📖 [Check FAQ](FAQ.md)** — Common questions answered + +**When asking for help, include**: +- Operating system (Windows/Linux/Mac) +- Node.js version (`node --version`) +- Error message (full text or screenshot) +- Relevant config (remove sensitive data!) +- Steps to reproduce the issue + +--- + +
+ +[← Back to Documentation](index.md) + +