/pyUltroid

[Ultroid] Base Library - Telethon

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

py-Ultroid Library

Core library of The Ultroid, a python based telegram userbot.

CodeFactor PyPI - Version
PyPI - Downloads
Maintenance Open Source Love svg2 PRs Welcome

Installation

pip3 install -U py-Ultroid

Documentation

Documentation

Usage

  • Create folders named plugins, addons, assistant and resources.
  • Add your plugins in the plugins folder and others accordingly.
  • Create a .env file with following mandatory Environment Variables 
    API_ID
API_HASH
SESSION
REDIS_URI
REDIS_PASSWORD
  • Check .env.sample for more details.
  • Run python3 -m pyUltroid to start the bot.

Creating plugins

  • To work everywhere

@ultroid_cmd(
    pattern="start"
)   
async def _(e):   
    await e.eor("Ultroid Started!")

  • To work only in groups

@ultroid_cmd(
    pattern="start",
    groups_only=True,
)   
async def _(e):   
    await eor(e, "Ultroid Started.")

  • Assistant Plugins 👇

@asst_cmd("start")   
async def _(e):   
    await e.reply("Ultroid Started.")

See more working plugins on the offical repository!

Made with 💕 by @TeamUltroid.

License

License
Ultroid is licensed under GNU Affero General Public License v3 or later.

Credits