Setup

Get the bot ready before your first run.

Prerequisites

Node.js 20 or newer - Download here
Git (optional) - For cloning the repository

Installation

# Clone the repository
git clone https://github.com/LightZirconite/Microsoft-Rewards-Bot.git
cd Microsoft-Rewards-Bot

# Install dependencies (happens automatically on first run)
npm install

Account Configuration

Copy the example file:

cp src/accounts.example.jsonc src/accounts.jsonc

Edit src/accounts.jsonc with your Microsoft account(s):

[
  {
    "email": "your-email@outlook.com",
    "password": "your-password"
  },
  {
    "email": "second-account@outlook.com",
    "password": "another-password",
    "totp": "YOUR_2FA_SECRET"  // Optional: for accounts with 2FA
  }
]

Optional: 2FA Support

If your account has two-factor authentication enabled, add the TOTP secret:

Extract the secret from your authenticator app setup QR code
Add it as the totp field in your account entry

Optional: Proxy Support

For accounts that need a proxy:

{
  "email": "account@outlook.com",
  "password": "password",
  "proxy": "http://user:pass@proxy.example.com:8080"
}

Optional: Discord Notifications

Set up Discord webhook alerts:

# Windows
set DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/...

# Linux/Mac
export DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/...

Or configure in src/config.jsonc:

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

Verify Setup

Run the bot once to verify everything works:

npm start

Back to Documentation

1.7 KiB Raw Blame History