{"id":17482277,"url":"https://github.com/totigm/whatsapp-stickers-bot","last_synced_at":"2025-10-23T23:18:10.432Z","repository":{"id":116950412,"uuid":"530595174","full_name":"totigm/whatsapp-stickers-bot","owner":"totigm","description":"This is a WhatsApp bot to convert images and videos to stickers","archived":false,"fork":false,"pushed_at":"2024-03-11T09:48:08.000Z","size":151,"stargazers_count":6,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-22T14:09:51.273Z","etag":null,"topics":["bot","stickers","typescript","whatsapp","whatsapp-bot","whatsapp-web"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/totigm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-30T09:56:04.000Z","updated_at":"2025-03-23T11:48:52.000Z","dependencies_parsed_at":"2025-03-03T18:38:16.100Z","dependency_job_id":"0e8d5a61-32e1-4005-9f77-5d2e0f8bf4e1","html_url":"https://github.com/totigm/whatsapp-stickers-bot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"totigm/whatsapp-bot-template","purl":"pkg:github/totigm/whatsapp-stickers-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-stickers-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-stickers-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-stickers-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-stickers-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/totigm","download_url":"https://codeload.github.com/totigm/whatsapp-stickers-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totigm%2Fwhatsapp-stickers-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280707232,"owners_count":26377082,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-23T02:00:06.710Z","response_time":142,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","stickers","typescript","whatsapp","whatsapp-bot","whatsapp-web"],"created_at":"2024-10-18T23:05:16.527Z","updated_at":"2025-10-23T23:18:10.415Z","avatar_url":"https://github.com/totigm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🤖 WhatsApp stickers bot\n\nThis is a WhatsApp bot to convert images and videos to stickers.\n\n[Live demo](http://wa.me/5492644107813)\n\n## 💬 Commands\n\nThe bot supports two primary commands in addition to the `!help` command, which can be used by sending an image or video along with the command or by quoting a previously sent image or video in your message:\n\n- `!sticker`: Converts an image or video into a sticker. For images, it generates a standard sticker, while for videos, it creates an animated sticker (gif-like).\n- `!image`: Processes an image and returns it with applied edits. By default, it returns the original image unless combined with one or more of the following arguments.\n\n### ✨ List of Arguments\n\nBoth `!sticker` and `!image` commands can be enhanced with these optional arguments:\n\n\u003e [!WARNING]\n\u003e For the `!sticker` command, arguments are applicable only to images, not videos.\n\n- **`resize=width/height`**: Resizes the sticker/image to the specified width and height. Use `x`, `.`, or `/` as separators.\n- **`negate`**: Inverts the colors of the sticker/image. No additional value required.\n- **`grayscale`/`greyscale`**: Converts the sticker/image to black and white. No additional value required.\n- **`blur=level`**: Applies a blur effect to the sticker/image. Accepts values from 0.3 (no blur) to 1000 (fully blurred).\n- **`lightness=level`**: Adjusts the lightness of the sticker/image. Accepts numeric values. Lightness is additive, impacting the overall brightness without altering the relative luminance of colors.\n- **`brightness=level`**: Modifies the brightness of the sticker/image. Accepts positive numeric values. Brightness operates multiplicatively, affecting the luminance of each color in the image.\n- **`saturation=level`**: Alters the saturation level. Accepts positive numeric values, enhancing or reducing the color intensity.\n- **`hue=level`**: Changes the hue. Accepts values from 0 to 360 degrees.\n- **`removeBg`**: Removes the background. Requires a [remove.bg API key](https://www.remove.bg/es/dashboard#api-key) in the [.env file](./.env.example). No additional value required.\n- **`bgColor=color`**: Replaces the background with a specified color. Accepts color names (e.g., `red`) or hex codes (e.g., `#ff0000`).\n- **`bgImageUrl=URL`**: Replaces the background with an image from the provided URL.\n- **`text='Your text'`**: Adds custom text to the image. Expects a string.\n- **`textSize=size`**: Sets the size of the text. Effective only if text is added. Default is `128`.\n- **`textColor=color`**: Sets the text color. Effective only if text is added. Accepts color names or hex codes, defaulting to `black`.\n- **`textPosition=position`**: Adjusts text position. Effective only if text is added. Options include `top`, `topRight`, `right`, `bottomRight`, `bottom`, `bottomLeft`, `left`, `topLeft`, and `center`. Default is `top`.\n\n\n\u003e [!TIP]\n\u003e Multiple arguments can be combined and used at the same time for more customized effects.\n\nHere is an example of the base command:\\\n![Base command](https://github.com/totigm/whatsapp-stickers-bot/assets/64804554/446259b2-2cc6-459d-a546-442316df23ac)\n\u003e [!NOTE]\n\u003e For more detailed examples, please see the [examples](./docs/EXAMPLES.md) documentation.\n\n## 📋 Prerequisites\n\n-   [**Node.js**](https://nodejs.org): You need to have Node.js installed on your computer to run this bot. You can download it [here](https://nodejs.org/en/download).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `yarn` or `npm i`\n\nInstalls every dependency needed for the project.\n\n### `yarn start` or `npm start`\n\nRuns the app in the development mode.\\\nThe app will reload every time you save a file.\n\nYou will also see any lint errors/warnings in the console.\n\n\u003e _`yarn dev` and `npm run dev` do the same._\n\n### `yarn prod` or `npm run prod`\n\nRuns the app in the production mode.\n\nBefore running the app, it will run the linter, format code with Prettier, and build the project.\n\n### `yarn build` or `npm run build`\n\nBuilds the app for production to the `build` folder.\n\nYour app is ready to be deployed!\n\n\u003e _`yarn prod` and `npm run prod` do the same, and also run the app after building it._\n\n### `yarn lint` or `npm run lint`\n\nRuns the linter and logs every error and warning to the console.\n\n\u003e _`yarn lint:fix` and `npm run lint:fix` fix every autofixable error/warning._\n\n### `yarn prettier` or `npm run prettier`\n\nRuns Prettier and logs every error and warning to the console.\n\n\u003e _`yarn prettier:fix` and `npm run prettier:fix` fix every autofixable error/warning._\n\n### `yarn check` or `npm run check`\n\nRuns both the linter and Prettier and logs every error and warning to the console.\n\n\u003e _`yarn check:fix` and `npm run check:fix` fix every autofixable error/warning._\n\n## 🚀 Deploying\n\nA normal Dockerfile for a Node.js app won't work for this bot, as the [whatsapp-web.js](https://wwebjs.dev) library uses Puppeteer, and needs Chromium to run.\\\nThis project's [Dockerfile](./Dockerfile) handles every installation, and sets the whole environment needed for the bot to run and be authenticated.\n\nIf the Docker image is built in a directory that has a `.wwebjs_auth` folder, it will use that file to authenticate and the container will start the bot without further authentication. If not, a QR code will be logged to the console and the user will have to scan it to authenticate.\n\n## 🐳 Docker\n\nYou can use [Docker](https://www.docker.com) to run your app. This project has a multi-stage build process so your final image doesn't have any TypeScript files nor dev dependencies, resulting in a smaller image size.\n\nTo [build your image](https://docs.docker.com/engine/reference/commandline/build) run: `docker build -t \u003cimage-name\u003e .`\n\nTo [run your image](https://docs.docker.com/engine/reference/run) run: `docker run -p 80:80 \u003cimage-name\u003e`\n\n\u003e If you haven't used Docker before, you can get started with it [here](https://www.docker.com/get-started).\n\n## 👤 Author\n\n\u003ca href=\"https://github.com/totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"GitHub: totigm\" src=\"https://img.shields.io/github/followers/totigm?label=Follow @totigm\u0026style=social\"\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://twitter.com/totigm8\" target=\"_blank\"\u003e\n  \u003cimg alt=\"Twitter: totigm8\" src=\"https://img.shields.io/twitter/follow/totigm8?style=social\" /\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://linkedin.com/in/totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"LinkedIn: totigm\" src=\"https://img.shields.io/badge/LinkedIn-@totigm-green?style=social\u0026logo=linkedin\" /\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://www.npmjs.com/~totigm\" target=\"_blank\"\u003e\n  \u003cimg alt=\"NPM: totigm\" src=\"https://img.shields.io/badge/NPM-@totigm-green?style=social\u0026logo=npm\" /\u003e\n\u003c/a\u003e\n\n## 🤝 Contributing\n\nContributions are more than welcome!\n\nWe think that you might have great ideas to make this project even better. If you do, please create a pull request and/or issue following the [contribution guidelines](./docs/CONTRIBUTING.md).\n\n## ⭐️ Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nCopyright © 2022 [Toti Muñoz](https://github.com/totigm).\u003cbr /\u003e\nThis project is [MIT](https://github.com/totigm/ts-package-template/blob/master/LICENSE) licensed.\n\n---\n\nThis project was made with ❤ and TypeScript\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotigm%2Fwhatsapp-stickers-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftotigm%2Fwhatsapp-stickers-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotigm%2Fwhatsapp-stickers-bot/lists"}