Files
Microsoft-Rewards-Script/docs/getting-started.md
Light abd6117db3 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
2025-10-16 17:59:53 +02:00

2.5 KiB
Raw Blame History

🚀 Getting Started

From zero to your first run in 10 minutes


Requirements

  • Node.js 20+Download here
  • Microsoft accounts with email + password
  • Optional: Docker for containers

Windows

setup\setup.bat

Linux / macOS

bash setup/setup.sh

What Does It Do?

  1. Asks for your Microsoft credentials
  2. Creates accounts.json automatically
  3. Installs dependencies
  4. Builds the project
  5. Runs your first automation (optional)

That's it! 🎉


🎯 After Installation

Run automatically once per day:

Edit src/config.jsonc:

{
  "schedule": {
    "enabled": true,
    "time": "09:00",
    "timeZone": "America/New_York"
  }
}

Start scheduler:

npm run start:schedule

Full Scheduler Guide


2 Add Notifications (Optional)

Get a summary after each run:

{
  "conclusionWebhook": {
    "enabled": true,
    "url": "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL"
  }
}

Discord Setup | NTFY Setup


3 Enable Humanization (Anti-Ban)

More natural behavior:

{
  "humanization": {
    "enabled": true
  }
}

Humanization Guide


🛠️ Common Issues

Problem Solution
"Node.js not found" Install Node.js 20+ and restart terminal
"accounts.json missing" Run setup/setup.bat or create manually
"Login failed" Check email/password in accounts.json
"2FA prompt" Add TOTP secret → 2FA Guide
Script crashes Check Diagnostics Guide

🔧 Manual Setup (Advanced)

Click to expand
# 1. Configure accounts
cp src/accounts.example.json src/accounts.json
# Edit accounts.json with your credentials

# 2. Install & build
npm install
npm run build

# 3. Run
npm start

📚 Next Steps

Everything works?
Setup Scheduler for daily automation

Need 2FA?
Accounts & TOTP Guide

Want Docker?
Docker Guide

Having issues?
Diagnostics


← Back to Hub | All Docs