mirror of
https://github.com/LightZirconite/Microsoft-Rewards-Bot.git
synced 2026-01-10 17:26:17 +00:00
38 lines
1.4 KiB
Markdown
38 lines
1.4 KiB
Markdown
# Microsoft Rewards Bot Docs
|
|
|
|
Welcome to the **v3.5 Remaster** documentation. These guides cover everything from first-time setup to advanced configuration.
|
|
|
|
## Getting Started
|
|
- **[Setup](setup.md)** — Install prerequisites and configure your accounts.
|
|
- **[Running](running.md)** — Commands to start the bot.
|
|
- **[Modes](modes.md)** — Understand the different running modes.
|
|
|
|
## Configuration
|
|
- **[Configuration](configuration.md)** — Adjust bot behavior via `config.jsonc`.
|
|
- **[Scheduling](scheduling.md)** — Automate daily runs with built-in scheduler.
|
|
- **[Notifications](notifications.md)** — Discord webhooks and NTFY push alerts.
|
|
|
|
## Features
|
|
- **[Dashboard](dashboard.md)** — Real-time web monitoring panel.
|
|
- **[Account Creation](account-creation.md)** — Create new Microsoft accounts (use with caution).
|
|
- **[Error Reporting](error-reporting.md)** — Automatic anonymized bug reports.
|
|
|
|
## Deployment
|
|
- **[Docker](docker.md)** — Run the bot in a container with scheduling.
|
|
- **[Update](update.md)** — Keep the project up to date.
|
|
|
|
## Help
|
|
- **[Troubleshooting](troubleshooting.md)** — Quick fixes for common issues.
|
|
|
|
---
|
|
|
|
## Quick Reference
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `npm start` | Build and run the bot |
|
|
| `npm run dashboard` | Start web monitoring panel |
|
|
| `npm run creator` | Account creation wizard |
|
|
| `npm run dev` | Development mode |
|
|
| `npm run docker:compose` | Run in Docker |
|