realm-guard

A Telegram group management bot made with Node and Telegraf.

Currently at a WIP stage and is not fit for production use.

Features

Generic

• Show bot start message
• Show bot help
  • Interactive bot help
• Show bot version
• Show user/bot information

Administration

• Greeting user
  • Setting and resetting welcome message
  • Setting and resetting farewell message
• Banning user
  • Banning user temporarily
  • Banning user silently
  • Banning user globally
• Unbanning user
  • Unbanning user globally
• Kicking user
  • Kicking user globally
• Muting user
  • Muting user temporarily
  • Muting user silently
  • Muting user globally
• Unmuting user
• Warning user
  • Adding user warns
  • Clearing user warns
  • Resetting user warns
  • Showing user warns
• Purging the group chat
• Managing group rules
  • Setting group rules
  • Showing group rules
• Reporting user
• Pinning message
• Unpinning message
• Spam management
  • Flood control
  • CAPTCHA challenge for new users
  • Spam detection
• Snipping messages with keys

Features are subject to change and will probably change depending on the needs

Running

1. Install the dependencies using pnpm install or npm install or whichever node package manager you prefer.
2. Copy the example .env.example environment table file and rename it to .env.
3. Copy your bot token into the environment variable BOT_TOKEN as its value.
4. Change the remaining environment variables accordingly. (BOT_NAME and STORAGE_DIR if you use it)
5. Run npm run dev or pnpm run dev or yarn run dev or whichever node package manager you prefer as long as it runs.
6. Voila!

License

MIT