PHPackages                             soatok/headless-lounge-bot - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. soatok/headless-lounge-bot

ActiveLibrary

soatok/headless-lounge-bot
==========================

Telegram bot for ensuring group access is limited to e.g. Twitch subscribers and/or Patreon supporters.

v0.1.3(6y ago)521[3 issues](https://github.com/soatok/headless-lounge-bot/issues)ISCPHPPHP ^7.3

Since Aug 29Pushed 6y ago2 watchersCompare

[ Source](https://github.com/soatok/headless-lounge-bot)[ Packagist](https://packagist.org/packages/soatok/headless-lounge-bot)[ Docs](http://github.com/soatok/headless-lounge-bot)[ RSS](/packages/soatok-headless-lounge-bot/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (4)Dependencies (7)Versions (5)Used By (0)

Headless Lounge Bot
===================

[](#headless-lounge-bot)

[![Support on Patreon](https://camo.githubusercontent.com/1d8b40362fa2ac72ed481a78f89a027f4cd233ff449dc0be29db4d5a6c8950e6/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e742e7376673f75726c3d6874747073253341253246253246736869656c6473696f2d70617472656f6e2e6865726f6b756170702e636f6d253246736f61746f6b267374796c653d666c6174)](https://patreon.com/soatok)[![Linux Build Status](https://camo.githubusercontent.com/abaadb93e8fff9f80fe919eb317ea79f38efb4fa4a62eaa9af9c828d7da6d4f5/68747470733a2f2f7472617669732d63692e6f72672f736f61746f6b2f686561646c6573732d6c6f756e67652d626f742e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/soatok/headless-lounge-bot)[![Latest Stable Version](https://camo.githubusercontent.com/9cf747c298d9e7112241df26182cbb6bdcab57b43b252f29f01d1ae9eae6ecc3/68747470733a2f2f706f7365722e707567782e6f72672f736f61746f6b2f686561646c6573732d6c6f756e67652d626f742f762f737461626c65)](https://packagist.org/packages/soatok/headless-lounge-bot)[![Latest Unstable Version](https://camo.githubusercontent.com/f9a10545b1e0a8595d7d8ccc7cc40cb0a306295bbb98dafae94540d7eb246dae/68747470733a2f2f706f7365722e707567782e6f72672f736f61746f6b2f686561646c6573732d6c6f756e67652d626f742f762f756e737461626c65)](https://packagist.org/packages/soatok/headless-lounge-bot)[![License](https://camo.githubusercontent.com/b5c56a98149b89c91787d3e4b6dbbf9af231f3062116f066d3cd7d243ec8eeec/68747470733a2f2f706f7365722e707567782e6f72672f736f61746f6b2f686561646c6573732d6c6f756e67652d626f742f6c6963656e7365)](https://packagist.org/packages/soatok/headless-lounge-bot)

Telegram bot for ensuring group access is limited to e.g. Twitch subscribers and/or Patreon supporters.

Using the Bot to Protect Your Groups
------------------------------------

[](#using-the-bot-to-protect-your-groups)

> The bot operated by Soatok (`@HeadlessLounge_Bot`) is only available if you're [one of Soatok's patrons](https://www.patreon.com/soatok)at the **Dhole's Delight ($3/month)** tier or higher.

Setup is straightforward:

1. Talk to [`@HeadlessLounge_Bot`](https://t.me/headlesslounge_bot). Make sure to link your own third-party accounts. (Twitch, Patreon, etc.)
2. Invite `@HeadlessLounge_Bot` to your group. (Make sure you're an admin.)
3. Type `/enforce [service] [minimum]`
    - `/enforce Twitch` for Tier 1+ Twitch subs.
    - `/enforce Twitch 2` for Tier 2+ Twitch subs.
    - `/enforce Patreon 5` for $5/mo. or more pledge.
    - `/enforce Patreon 10` for $10/mo. or more pledge.

Anyone who joins the group will be auto-kicked unless...

1. They have linked their own third-party accounts by talking to the bot directly.
2. They have met your enforcement requirements.

Administrators can allow exceptions to this rule on a case-by-case basis by typing `/permit @Telegram_Username`.

Note: If you choose to add multiple enforcements (i.e. Twitch and Patreon), satisfying **any** of the requirements will avoid being auto-kicked. (Logically: It's an `OR` not an `AND` operation.)

Setting up and Deploying Your own Bot
-------------------------------------

[](#setting-up-and-deploying-your-own-bot)

After cloning this repository and setting up your webserver with HTTPS, get an API key from BotFather. Stick that in `local/telegram-token.php` like so:

```