{"id":16526688,"url":"https://github.com/rtippin/messenger-bots","last_synced_at":"2026-03-09T04:31:50.714Z","repository":{"id":44591918,"uuid":"371539005","full_name":"RTippin/messenger-bots","owner":"RTippin","description":"Addon for rtippin/messenger that adds ready-made bot action handlers. This integrates with the core bots feature.","archived":false,"fork":false,"pushed_at":"2025-03-06T19:50:50.000Z","size":710,"stargazers_count":6,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T23:41:30.977Z","etag":null,"topics":["automation","bots","chat-bot","messenger","messenger-bots","realtime"],"latest_commit_sha":null,"homepage":"https://tippindev.com","language":"PHP","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/RTippin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"RTippin"}},"created_at":"2021-05-28T00:42:01.000Z","updated_at":"2025-03-06T19:46:27.000Z","dependencies_parsed_at":"2024-10-28T17:15:13.920Z","dependency_job_id":null,"html_url":"https://github.com/RTippin/messenger-bots","commit_stats":{"total_commits":181,"total_committers":3,"mean_commits":"60.333333333333336","dds":0.06629834254143652,"last_synced_commit":"b7a8cea1cd4ada4bbf9b6266998cbdb9a01ae80f"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RTippin%2Fmessenger-bots","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RTippin%2Fmessenger-bots/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RTippin%2Fmessenger-bots/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RTippin%2Fmessenger-bots/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RTippin","download_url":"https://codeload.github.com/RTippin/messenger-bots/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244771584,"owners_count":20507832,"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","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":["automation","bots","chat-bot","messenger","messenger-bots","realtime"],"created_at":"2024-10-11T17:29:32.704Z","updated_at":"2026-03-09T04:31:50.663Z","avatar_url":"https://github.com/RTippin.png","language":"PHP","funding_links":["https://github.com/sponsors/RTippin"],"categories":[],"sub_categories":[],"readme":"# Messenger Bots\n\n[![Latest Version on Packagist][ico-version]][link-packagist]\n[![Total Downloads][ico-downloads]][link-downloads]\n[![Tests][ico-test]][link-test]\n[![StyleCI][ico-styleci]][link-styleci]\n[![License][ico-license]][link-license]\n\n---\n\n![Preview](https://raw.githubusercontent.com/RTippin/messenger-demo/master/public/examples/image2.png)\n\n## This package is an addon for [rtippin/messenger][link-messenger]\n\n## Notice\n- This package is not required to use the bots feature built into `Messenger`.\n- For more documentation on creating custom bot handlers and packages, visit the official [Chat Bots][link-bots-docs] documentation.\n\n### Features:\n- Ready-made bot action handlers and packages that will plug into the core messenger package.\n- Register only the selected bots you wish to use, or let us auto-register all bots we provide.\n- Included Bot Handlers:\n  - Chuck Norris Bot\n  - Coin Toss Bot\n  - Commands Bot\n  - Dad Joke Bot\n  - Document Finder Bot\n  - Giphy Bot\n  - Insult Bot\n  - Invite Bot\n  - Joke Bot\n  - Kanye West Bot\n  - Knock Bot\n  - Location Bot\n  - Nuke Bot\n  - Random Image Bot\n  - Reaction Bomb Bot\n  - Reaction Bot\n  - Reply Bot\n  - Rock Paper Scissors Bot\n  - Roll Bot\n  - Weather Bot\n  - Wikipedia Bot\n  - YoMomma Bot\n  - YouTube Bot\n- Included Packaged Bots:\n  - Games Package\n  - Jokester Package\n  - Neo package\n\n---\n\n# Prerequisites\n- To use this package, you must already have the core [Messenger][link-messenger] package installed.\n- You must have bots enabled from within the [messenger.php][link-messenger-config] config, or your `.env`.\n- The built-in bot subscriber should also be enabled, unless you wish to register your own event subscriber.\n- If the subscriber is queued, be sure to have your queue worker process the defined channel, `messenger-bots` is the default.\n\n```dotenv\nMESSENGER_BOTS_ENABLED=true\n```\n```php\n'bots' =\u003e [\n    'enabled' =\u003e env('MESSENGER_BOTS_ENABLED', false),\n    'subscriber' =\u003e [\n        'enabled' =\u003e true,\n        'queued' =\u003e true,\n        'channel' =\u003e 'messenger-bots',\n    ],\n],\n```\n\n# Installation\n\n### Via Composer\n\n```bash\ncomposer require rtippin/messenger-bots\n```\n\n---\n\n# Config\n\n```php\n'weather_api_key' =\u003e env('BOT_WEATHER_API_KEY'),\n'ip_api_key' =\u003e env('BOT_LOCATION_API_KEY'),\n'youtube_api_key' =\u003e env('BOT_YOUTUBE_API_KEY'),\n'giphy_api_key' =\u003e env('BOT_GIPHY_API_KEY'),\n'random_image_url' =\u003e env('BOT_RANDOM_IMAGE_URL', 'https://source.unsplash.com/random'),\n'auto_register_all' =\u003e env('BOT_AUTO_REGISTER_ALL', false),\n```\n\n### Publish the config file\n\n```bash\nphp artisan vendor:publish --tag=messenger-bots\n```\n\n- To use weather bot, you must get an API key from [Weather API][link-weather-api]\n- To use YouTube bot, you must get an API key from [Google Developers Console][link-google-api]\n- To use Giphy bot, you must get an API key from [Giphy][link-giphy-api]\n- You may use the location bot without an API key, but for commercial use, you must get an API key from [IP API][link-ip-api]\n- Random image bot will use unsplash as the default endpoint to grab a random image from. You may overwrite this endpoint.\n\n---\n\n# Auto Registering Handlers and Packages\n- If you plan to use all the bot handlers and packaged bots provided, you can skip registering them manually by enabling the `BOT_AUTO_REGISTER_ALL` flag.\n\n***Update your `.env`***\n\n```dotenv\nBOT_AUTO_REGISTER_ALL=true\n```\n\n---\n\n# Manually Registering Handlers and Bot Packages\n- Inside your `MessengerServiceProvider` (or any of your providers), you must register all bot handlers and bot packages you want enabled in your application.\n- You can use the `MessengerBots` facade to register the handlers and packages. Be sure you do it inside the `boot` method.\n\n***Example:***\n\n```php\n\u003c?php\n\nnamespace App\\Providers;\n\nuse Illuminate\\Support\\ServiceProvider;\nuse RTippin\\Messenger\\Facades\\MessengerBots;\nuse RTippin\\MessengerBots\\Bots\\ChuckNorrisBot;\nuse RTippin\\MessengerBots\\Bots\\CoinTossBot;\nuse RTippin\\MessengerBots\\Bots\\CommandsBot;\nuse RTippin\\MessengerBots\\Bots\\DadJokeBot;\nuse RTippin\\MessengerBots\\Bots\\DocumentFinderBot;\nuse RTippin\\MessengerBots\\Bots\\GiphyBot;\nuse RTippin\\MessengerBots\\Bots\\InsultBot;\nuse RTippin\\MessengerBots\\Bots\\InviteBot;\nuse RTippin\\MessengerBots\\Bots\\JokeBot;\nuse RTippin\\MessengerBots\\Bots\\KanyeBot;\nuse RTippin\\MessengerBots\\Bots\\KnockBot;\nuse RTippin\\MessengerBots\\Bots\\LocationBot;\nuse RTippin\\MessengerBots\\Bots\\NukeBot;\nuse RTippin\\MessengerBots\\Bots\\RandomImageBot;\nuse RTippin\\MessengerBots\\Bots\\ReactionBombBot;\nuse RTippin\\MessengerBots\\Bots\\ReactionBot;\nuse RTippin\\MessengerBots\\Bots\\ReplyBot;\nuse RTippin\\MessengerBots\\Bots\\RockPaperScissorsBot;\nuse RTippin\\MessengerBots\\Bots\\RollBot;\nuse RTippin\\MessengerBots\\Bots\\WeatherBot;\nuse RTippin\\MessengerBots\\Bots\\WikiBot;\nuse RTippin\\MessengerBots\\Bots\\YoMommaBot;\nuse RTippin\\MessengerBots\\Bots\\YoutubeBot;\nuse RTippin\\MessengerBots\\Packages\\GamesPackage;\nuse RTippin\\MessengerBots\\Packages\\JokesterPackage;\nuse RTippin\\MessengerBots\\Packages\\NeoPackage;\n\nclass MessengerServiceProvider extends ServiceProvider\n{\n    /**\n     * Bootstrap any application services.\n     *\n     * @return void\n     */\n    public function boot(): void\n    {\n        MessengerBots::registerHandlers([\n            ChuckNorrisBot::class,\n            CoinTossBot::class,\n            CommandsBot::class,\n            DadJokeBot::class,\n            DocumentFinderBot::class,\n            GiphyBot::class,\n            InsultBot::class,\n            InviteBot::class,\n            JokeBot::class,\n            KanyeBot::class,\n            KnockBot::class,\n            LocationBot::class,\n            NukeBot::class,\n            RandomImageBot::class,\n            ReactionBombBot::class,\n            ReactionBot::class,\n            ReplyBot::class,            \n            RockPaperScissorsBot::class,\n            RollBot::class,\n            WeatherBot::class,\n            WikiBot::class,\n            YoMommaBot::class,\n            YoutubeBot::class,\n        ]);\n\n        MessengerBots::registerPackagedBots([\n            GamesPackage::class,\n            JokesterPackage::class,\n            NeoPackage::class,\n        ]);\n    }\n}\n```\n\n### Registered handlers and packages will now be available to choose when adding an action to a bot or installing a packaged bot.\n\n---\n\n## Credits - [Richard Tippin][link-author]\n\n## License - MIT\n\n### Please see the [license file](LICENSE.md) for more information.\n\n\n[link-author]: https://github.com/rtippin\n[ico-version]: https://img.shields.io/packagist/v/rtippin/messenger-bots.svg?style=plastic\u0026cacheSeconds=3600\n[ico-downloads]: https://img.shields.io/packagist/dt/rtippin/messenger-bots.svg?style=plastic\u0026cacheSeconds=3600\n[link-test]: https://github.com/RTippin/messenger-bots/actions\n[ico-test]: https://img.shields.io/github/actions/workflow/status/rtippin/messenger-bots/test.yml?branch=master\u0026style=plastic\n[ico-styleci]: https://styleci.io/repos/371539005/shield?style=plastic\u0026cacheSeconds=3600\n[ico-license]: https://img.shields.io/github/license/RTippin/messenger-bots?style=plastic\n[link-packagist]: https://packagist.org/packages/rtippin/messenger-bots\n[link-downloads]: https://packagist.org/packages/rtippin/messenger-bots\n[link-license]: https://packagist.org/packages/rtippin/messenger-bots\n[link-styleci]: https://styleci.io/repos/371539005\n[link-messenger]: https://github.com/RTippin/messenger\n[link-messenger-config]: https://github.com/RTippin/messenger/blob/1.x/config/messenger.php\n[link-bots-docs]: https://github.com/RTippin/messenger/blob/1.x/docs/ChatBots.md\n[link-weather-api]: https://www.weatherapi.com\n[link-google-api]: https://console.developers.google.com\n[link-ip-api]: https://ip-api.com\n[link-giphy-api]: https://developers.giphy.com","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtippin%2Fmessenger-bots","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frtippin%2Fmessenger-bots","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtippin%2Fmessenger-bots/lists"}