SCP-5170

Pattern Screamer

Project Structure

╭─ scp
├──── core / clients - filters - functions
├─────── # core files
├──── database
├─────── # a cache memory database
├──── plugins / bot - private - user
├─────── # the plugins directory
├──── utils
╰─────── # few helper scripts laying around for plugins

Requirements

• a brain
• python>=3.10

Setup

• clone this repository with git clone with --recursive flag and change directory to the root of the project
• create a venv with python -m venv venv and activate the venv
• install all modules in requirements with python -m pip install -r requirements.txt and python -m pip install -r session/requirements.txt
• move config sample from config.ini.sample to config.ini and fill in the configs
• create session for user and bot
  • user: python -m session -s scp-user
  • bot : python -m session -s scp-bot -t {bot_token}
• all done. run the userbot with hy -m scp

Creating own modules

as you know SCP-5170 is using pyrogram and a custom client, therefore a plugin can be very simple to make and import into scp/plugins/private directory:

scp.bot - bot client
scp.user - user client
client.filters - pyrogram filters (for user client)
client.sudo - a filter with sudoers added
client.command - command filter with '(*prefix)command@username'

• an Example plugin the echo to a command with (*prefix)hello:

python

from scp import user

@user.on_message(
    user.sudo
    & user.command('hello')
)
async def _(_, message: types.Message):
    await message.reply('hello')

hy

(import [scp[user]])

(with-decorator (
    user.on_message (user.command "hello"))
    (defn/a _ [_ message]
        (await (message.reply "hello"))))

FAQ

• why given that name? the name speaks to itself, the Pattern Screamer

• sar please heroku...? first of all stop using heroku. use localhost, no need to pay. and you have the full control of it

• why does it look like kantek? i always loved it, therefore i did add KanteX to globally use in this userbot

Special thancc

• hylang - hy team <3
• Dan - pyrogram
• Fluffy Shark - QR Code session generator Script
• Kneesocks - 13 year old with multiple police records (also eval module is originally by him)
• Davide Goggles - spam check and automatic logging with extra pineapple toppings

and everyone who built awesome modules that are being used by this project