mirror of
https://github.com/TheNetsky/Microsoft-Rewards-Script.git
synced 2026-01-10 02:16:18 +00:00
b630c3dddaee4810777a9cb99060afe68d27c1bd
Microsoft-Rewards-Script
Automated Microsoft Rewards script, however this time using TypeScript, Cheerio and Playwright.
Under development, however mainly for personal use!
How to setup
- Download or clone source code
- Run
npm ito install the packages - Change
accounts.example.jsontoaccounts.jsonand add your account details - Change
config.jsonto your liking - Run
npm run buildto build the script - Run
npm run startto start the built script
Notes
- If you end the script without closing the browser window first (only with headless as false), you'll be left with hanging chrome instances using resources. Use taskmanager to kill these or use the included
npm run kill-chrome-winscript. (Windows) - If you automate this script, set it to run at least 2 times a day to make sure it picked up all tasks, set
"runOnZeroPoints": falseso it doesn't run when no points are found.
Docker (Experimental)
Before Starting
- If you had previously built and run the script locally, remove the
/node_modulesand/distfolders from yourMicrosoft-Rewards-Scriptdirectory. - If you had used Docker with an older version of the script (e.g., 1.4), remove any persistently saved
config.jsonand session folders. Oldaccounts.jsonfiles can be reused.
Setup the Source Files
-
Download the Source Code
-
Update
accounts.json -
Edit
config.json, ensuring the following values are set (other settings are up to your preference):"headless": true, "clusters": 1,
Customize the compose.yaml File
A basic docker compose.yaml is provided. Follow these steps to configure and run the container:
- Set Your Timezone: Adjust the
TZvariable to ensure correct scheduling. - Configure Persistent Storage:
- Map
config.jsonandaccounts.jsonto retain settings and accounts. - (Optional) Use a persistent
sessionsfolder to save login sessions.
- Map
- Customize the Schedule:
- Modify
CRON_SCHEDULEto set run times. Use crontab.guru for help. - Note: The container adds 5–50 minutes of random variability to each scheduled start time.
- Modify
- (Optional) Run on Startup:
- Set
RUN_ON_START=trueto execute the script immediately when the container starts.
- Set
- Start the Container: Run
docker compose up -dto build and launch. - Monitor Logs: Use
docker logs microsoft-rewards-scriptto view script execution and to retrieve 'passwordless' login codes.
Config
| Setting | Description | Default |
|---|---|---|
| baseURL | MS Rewards page | https://rewards.bing.com |
| sessionPath | Path to where you want sessions/fingerprints to be stored | sessions (In ./browser/sessions) |
| headless | If the browser window should be visible be ran in the background | false (Browser is visible) |
| parallel | If you want mobile and desktop taks to run parallel or sequential | true |
| runOnZeroPoints | Run the rest of the script if 0 points can be earned | false (Will not run on 0 points) |
| clusters | Amount of instances ran on launch, 1 per account | 1 (Will run 1 account at the time) |
| saveFingerprint.mobile | Re-use the same fingerprint each time | false (Will generate a new fingerprint each time) |
| saveFingerprint.desktop | Re-use the same fingerprint each time | false (Will generate a new fingerprint each time) |
| workers.doDailySet | Complete daily set items | true |
| workers.doMorePromotions | Complete promotional items | true |
| workers.doPunchCards | Complete punchcards | true |
| workers.doDesktopSearch | Complete daily desktop searches | true |
| workers.doMobileSearch | Complete daily mobile searches | true |
| workers.doDailyCheckIn | Complete daily check-in activity | true |
| workers.doReadToEarn | Complete read to earn activity | true |
| searchOnBingLocalQueries | Complete the activity "search on Bing" using the queries.json or fetched from this repo |
false (Will fetch from this repo) |
| globalTimeout | The length before the action gets timeout | 30s |
| searchSettings.useGeoLocaleQueries | Generate search queries based on your geo-location | false (Uses EN-US generated queries) |
| searchSettings.scrollRandomResults | Scroll randomly in search results | true |
| searchSettings.clickRandomResults | Visit random website from search result | true |
| searchSettings.searchDelay | Minimum and maximum time in miliseconds between search queries | min: 1min max: 2min |
| searchSettings.retryMobileSearchAmount | Keep retrying mobile searches for specified amount | 3 |
| logExcludeFunc | Functions to exclude out of the logs and webhooks | SEARCH-CLOSE-TABS |
| webhookLogExcludeFunc | Functions to exclude out of the webhooks log | SEARCH-CLOSE-TABS |
| proxy.proxyGoogleTrends | Enable or disable proxying the request via set proxy | true (will be proxied) |
| proxy.proxyBingTerms | Enable or disable proxying the request via set proxy | true (will be proxied) |
| webhook.enabled | Enable or disable your set webhook | false |
| webhook.url | Your Discord webhook URL | null |
Features
- Multi-Account Support
- Session Storing
- 2FA Support
- Passwordless Support
- Headless Support
- Discord Webhook Support
- Desktop Searches
- Configurable Tasks
- Microsoft Edge Searches
- Mobile Searches
- Emulated Scrolling Support
- Emulated Link Clicking Support
- Geo Locale Search Queries
- Completing Daily Set
- Completing More Promotions
- Solving Quiz (10 point variant)
- Solving Quiz (30-40 point variant)
- Completing Click Rewards
- Completing Polls
- Completing Punchcards
- Solving This Or That Quiz (Random)
- Solving ABC Quiz
- Completing Daily Check In
- Completing Read To Earn
- Clustering Support
- Proxy Support
- Docker Support (experimental)
- Automatic scheduling (via Docker)
Disclaimer
Your account may be at risk of getting banned or suspended using this script, you've been warned!
Use this script at your own risk!
Languages
TypeScript
94%
Shell
4%
Dockerfile
1.5%
Nix
0.5%