Skip to content

A simple, open-source telegram bot to manage your bot in a friendlier way

License

Notifications You must be signed in to change notification settings

Code-Wizaard/KomakYaar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KomakYaar

ربات «کمک‌یـــار» یک دستیار مدیریت گروه تلگرام است که برای ساده‌سازی وظایف مدیریتی مانند خوش‌آمدگویی، فیلترینگ کلمات، مدیریت اعضا، و گزارش‌دهی طراحی شده است.

ویژگی‌ها

  • خوش‌آمدگویی سفارشی برای اعضای جدید
  • فیلتر کلمات و پاسخ‌های خودکار
  • مدیریت اخطارها و مجازات‌ها (میوت، کیک، بن)
  • ایجاد لینک دعوت با پرمیشن‌ها و محدودیت دلخواه
  • سیستم گزارش‌دهی به ادمین‌ها
  • تنظیمات گروهی ذخیره‌شده در SQLite

نصب

نیازمندی‌ها را از requirements.txt نصب کنید:

pip install -r requirements.txt

سپس متغیر محیطی TOKEN را در فایل .env یا متغیرهای محیطی سیستم قرار دهید (مثال در .env.example). و OWNER_ID در فایل .env را با آیدی عددی خودتان در تلگرام جایگزین کنید

راه‌اندازی

  1. ربات را به گروه اضافه کنید.
  2. در گروه دستور فعال شو را ارسال کنید تا ربات فعال شود.
  3. برای دیدن راهنما در پیوی ربات دستور راهنما یا /help را ارسال کنید.

برای اجرای محلی:

python src/main.py

دستورات مهم

  • فعال شو — فعال‌سازی ربات در گروه
  • راهنما — دریافت راهنمای کامل به صورت خصوصی
  • لینک — ساخت لینک دعوت اختصاصی
  • فیلترها — نمایش فیلترهای ثبت‌شده
  • ریپلای روی پیام + فیلتر <پاسخ> — اضافه کردن فیلتر جدید
  • ریپلای روی پیام + گزارش — گزارش پیام به ادمین‌ها
  • سقف اخطار <عدد> — تنظیم سقف اخطارها
  • قوانین — نمایش قوانین گروه

توضیحات بیشتر و لیست کامل دستورات در پنل راهنما داخل ربات موجود است.

پیکربندی و دیتابیس

تنظیمات گروه در یک فایل SQLite (groups.db) ذخیره می‌شود. توابع و جدول‌های پایه مانند groups, tags, punishments, group_settings, reports, aliases, و warnings جهت مدیریت داده‌ها تعبیه شده‌اند.

برای دسترسی دستی به دیتابیس می‌توانید از یک کلاینت SQLite استفاده کنید یا از طریق دستورهای داخلی نوشته شده در سورس بهره ببرید.

توسعه و مشارکت

  • سورس باز است؛ هرگونه PR یا issue در گیت‌هاب خوش‌آمد گفته می‌شود.
  • در صورت نیاز می‌توانم کمک کنم تا مستندات بیشتری اضافه کنیم، تست بنویسیم یا ترجمه انگلیسی تهیه کنیم.

مجوز

این پروژه با مجوز متن‌باز منتشر شده — جزئیات مجوز را در فایل LICENSE ببینید. همچنین، رعایت بند های ذکر شده در فایل NOTICE نیز مورد انتظار است

About

A simple, open-source telegram bot to manage your bot in a friendlier way

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages