Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emmanuel-rods/snapbot

SnapBot is an automation tool designed to help maintain Snap Streaks effortlessly. It logs into Snapchat, captures snaps with custom captions, and sends them to your best friends or groups, all through an easy-to-use script.
https://github.com/emmanuel-rods/snapbot

automation bot puppeteer snapchat streaks

Last synced: about 16 hours ago
JSON representation

SnapBot is an automation tool designed to help maintain Snap Streaks effortlessly. It logs into Snapchat, captures snaps with custom captions, and sends them to your best friends or groups, all through an easy-to-use script.

Awesome Lists containing this project

README

        

> ⚠️ **Warning:** This project is no longer maintained , for further development and queries contact [email protected]

# SnapBot
SnapBot is a simple automation tool for interacting with Snapchat using Puppeteer. This bot logs into a Snapchat account, captures a snap with a caption, takes a screenshot, and sends the snap to specified contacts. It also includes a logout feature for switching accounts without closing the browser.

### Here’s what it can do:

- **Auto Login**: No more manually logging in! It handles the login process for you every time, saving you time and effort.
- **Multiple Accounts**: Got more than one account? No worries! The bot can handle multiple Snapchat accounts and keep streaks going for all of them simultaneously.
- **Snapstreak Maintenance**: The bot will make sure your streaks never break again! It sends snaps on time and ensures that your streak is always intact.
- **Custom Captions**: The bot lets you send snaps with captions of your choice. You can even integrate APIs to make your snaps more dynamic! For example, you could connect a quote API to send daily motivational quotes, or a sports API to automatically send live football match scores. The possibilities are endless! βš½πŸ“œ

## Installation
1. Clone the repository:
```bash
git clone https://github.com/Emmanuel-Rods/SnapBot
```
2. Navigate to the project folder:
```bash
cd SnapBot
```
3. Install the necessary dependencies:
```bash
npm install
```
4. Copy the `.env.example` file to create a `.env` file:
```bash
cp .env.example .env
```
5. Open the `.env` file and add your Snapchat credentials:
```bash
USER_NAME=
USER_PASSWORD=
```
## Usage

To run the bot, use the following command:
```bash
npm run bot
```
This command will start SnapBot, logging into Snapchat, capturing a snap, and sending it to your specified contacts.

## Methods

The following methods are available in `SnapBot`:

- `launchSnapchat({ headless })`: Opens Snapchat in a browser, set to visible with `{ headless: false }`.
- `login(credentials)`: Logs into Snapchat using the provided credentials.
- `captureSnap({ caption })`: Takes a snap and applies a caption.
- `screenshot({ path })`: Saves a screenshot of the current screen state.
- `send(recipients)`: Sends the snap to the specified recipients:
- `"BestFriends"` for best friends,
- `"friends"` for all active friends and best friends,
- `"groups"` for group chats.
- `wait(milliseconds)`: Pauses the script for a specified duration.
- `logout()`: Logs out of the current Snapchat account, allowing you to log in with another account without closing the browser.
- `closeBrowser()`: Closes the browser session.