Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 3.94 KB

README.md

File metadata and controls

49 lines (34 loc) · 3.94 KB

Paperplane userbot project

logo

#include <std/disclaimer.h>
/**
    Your Telegram account may get banned.
    We are not responsible for any improper use of Paperplane.
    Paperplane is intended for the purpose of effective group management,
    PM control as well as having fun with memes.
    You ended up spamming groups, getting reported left and right,
    and you ended up in a Finale Battle with Telegram and at the end
    Telegram Team deleted your account?
    And after that, then you pointed your fingers at us
    for getting your acoount deleted?
    We will be rolling on the floor laughing at you.
/**

What is it?

Paperplane is a modular Telegram userbot running on Python3, which can be coupled up with MongoDB and a Redis backend to bring you features such as PMPermit (auto blocking strangers on PM), AFK messages, group management features (ban/mute/kick/etc, notes, filters, welcomes and so on), different scrapers making every daily and rare task easier, integration with different services and more! You can check the list of features with the .help command after installing Paperplane, or you can check the source code!

Originally created by baalajimaestro, Paperplane started as a simple userbot, with group management features inspired from Marie, memes from SkittBot and a ton of other modules. Paperplane has evolved to become a project with dozens of contributors. Paperplane is currently owned and maintained by @zakaryan2004 as a side project, with the help of all contributors.

How do I use it?

For configuring Paperplane, you can check out our Wiki. Please, before asking us in our groups, make sure you have followed the Wiki and all the steps required. Before clicking the Deploy to Heroku button without thinking, please go ahead and read the wiki, which has a lot of important stuff you need to know about and things you should prepare for Paperplane.

Deploy Paperplane to Heroku:

Deploy to Heroku

Groups and support

If you'd just like to know about new features, or announcements, you can join our news channel.

For discussion, bug reporting, and help, you can join our discussion group.

If you find a bug, don't hesitate to report it in our Telegram group or open an issue on this repository. As for unofficial forks of Paperplane, we will only assist with issues affecting our central repository, found on this repo. So, before asking help for setting up the bot or reporting a bug you found, MAKE SURE you are using this repo, and not a fork you found somewhere else. You may get ignored if you ask for help with a fork.

Credits

Over the years, Paperplane evolved thanks to the dozens of contributors who have contributed, large or small, to the project. Listing all of them here would be impossible, as even the person in the group who reported a small bug has made their share of contribution to the project. We thank all of our contributors who have done and are doing even the slightest for the project.

The code contributors can be found at the Contributors page. This page will obviously not list all code contributions correctly, as some contributors attributed their commits with emails not associated with a GitHub account or maybe a guy just made a small snippet of code, posted it on the Internet and it got used by us, in Paperplane. Paperplane could of course not become what it is now without the dependencies, which you can find in the requirements.txt file in the root of the repo. We are thankful to everyone who made Paperplane better.