Skip to content

1package/admitix-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 Admitix — simplify your group management!

Content

Short description

To the content

⠀Admitix created to simplify group management!

⠀Main functions:

  • Anti-spam protection:
    • Several types of captchas for new members;
    • Anti-spam system for crypto groups (BETA).
  • Deleting system messages;
  • Commands for user management;
  • Commands for working with crypto.

⠀Supported languages:

  • English;
  • Russian.

Useful links

To the content

News channel

Русскоязычная документация

Quick start

To the content

⠀To add the bot to your group, you need:

  • Start Admitix to get report notifications;
  • Add him to your group;
  • Give him admin rights through the group settings;
  • In the sent message, select the language of your group;
  • If your group time zone is different from UTC, change hour offset using the /time_zone command, e.g.:
/time_zone -4
/time_zone 3

⠀That's it, he's completely ready to go!

⠀The following settings will be applied by default:

  • Time zone: UTC;
  • Captcha type: arithmetic;
  • Time to solve a captcha: 60 seconds;
  • Maximum failed captcha attempts: 3;
  • Warning threshold: 3;
  • Mute duration after passing warning threshold: 1 day.

⠀You can set them up separately by using the commands below.

Commands

To the content

⠀Useful info:

  • User can use either / or ! as the beginning of a command.
  • Add to a command the «help» or «h» argument to view the verbose info, e.g.:
/warning help
/warning h
  • Underlined arguments are mandatory.
  • Press /, start typing a command and press Tab on your PC or press and hold the tip on your smartphone to finish it.
  • All bot messages and commands are deleted after 1 minute.

👮 Admins

ban / b

🧰 Functionality:

⠀Ban a user.

🗣 Aliases:

/ban, !ban
/b, !b

⚙️ Usage:

/b USERNAME

  • USERNAME — the username in any format

🕹 Examples:

/b — as a reply to a message
/b @username

captcha / c

🧰 Functionality:

⠀Customize the captcha:

  • Type (current: ___);
  • Time for solution (current: ___ seconds);
  • Maximum failed attempts (current: ___).

🗣 Aliases:

/captcha, !captcha
/c, !c

⚙️ Usage:

/c

delete_commands

🧰 Functionality:

⠀Delete the bot command tips.

🗣 Aliases:

/delete_commands, !delete_commands

⚙️ Usage:

/delete_commands

language / l

🧰 Functionality:

⠀Change the bot language and set up command tips.

🗣 Aliases:

/language, !language
/l, !l

⚙️ Usage:

/l

mute / m

🧰 Functionality:

⠀Mute a user (default for 1 hour).

🗣 Aliases:

/mute, !mute
/m, !m

⚙️ Usage:

/m USERNAME DURATION

  • USERNAME — the username in any format
  • DURATION — mute duration
    • DAYSd HOURSh MINUTESm
    • DD.MM.YYYY HH:MM — date and time
    • DD/MM/YYYY HH:MM

🕹 Examples:

/m — as a reply to a message
/m 15m
/m 1d 2H 10m
/m 25.07.2022 19:30
/m @username 3H
/m @username 2h 30M
/m @username 15/09/2022 11:23

time_zone / tz

🧰 Functionality:

⠀Change the group time zone. Current one is ___.

🗣 Aliases:

/time_zone, !time_zone
/tz, !tz

⚙️ Usage (underlined is mandatory):

/tz OFFSET

  • OFFSET — hour offset from UTC

🕹 Examples:

/tz 3 — UTC+3
/tz 0 — UTC
/tz -5 — UTC-5

unban / ub

🧰 Functionality:

⠀Unban a user.

🗣 Aliases:

/unban, !unban
/ub, !ub

⚙️ Usage (underlined is mandatory):

/ub USERNAME

  • USERNAME — the username in any format

🕹 Examples:

/ub @username

unmute / um

🧰 Functionality:

⠀Unmute a user.

🗣 Aliases:

/unmute, !unmute
/um, !um

⚙️ Usage (underlined is mandatory):

/um USERNAME

  • USERNAME — the username in any format

🕹 Examples:

/um @username

token_info / ti

🧰 Functionality:

⠀Show a token info:

  • Price;
  • Circulating supply;
  • Market cap;
  • Total supply;
  • Fully Diluted Value (FVD).

⠀In addition, it allows to calculate the product of the price.

🗣 Aliases:

/token_info, !token_info
/ti, !ti

⚙️ Usage (underlined is mandatory):

/ti SYMBOL NUMBER

  • SYMBOL — token symbol
  • NUMBER — number to calculate a product

🕹 Examples:

/ti eth
📢 Project name: Ethereum
⚛️ Token symbol: ETH

💵 Price: 1 072.61$

🔄 Circulating supply: 119 514 467 ETH 
📊 Market cap: 128 192 413 224$

📈 Total supply: -
💰 Fully Diluted Value (FVD): -
/ti btc 0.00042
📢 Project name: Bitcoin
⚛️ Token symbol: BTC

💵 Price: 19 432.41$
🧮 Product: 8.16161$

🔄 Circulating supply: 19 082 512 BTC (90.87%)
📊 Market cap: 370 819 197 013$

📈 Total supply: 21 000 000 BTC
💰 Fully Diluted Value (FVD): 408 080 610 000$
/ti bnb 0,292
/ti sol 1'200
/ti trx 119 272 123.59

warning / w

🧰 Functionality:

⠀Warn a user, on ___ warnings a mute will be issued for ___.

🗣 Aliases:

/warning, !warning
/w, !w

⚙️ Usage (underlined is mandatory):

/w COMMAND

  • COMMAND
    • info — view current warnings
    • reset — reset warnings
    • setup NUMBER DAYSd HOURSh MINUTESm — setup warning threshold and/or mute duration

/w USERNAME COMMAND

  • USERNAME — the username in any format
  • COMMAND — the command to apply to the user

/w USERNAME REASON

  • USERNAME — the username in any format
  • REASON — reason of the warning

🕹 Examples:

/w info — as a reply to a message
/w insult of chat member — as a reply to a message
/w setup 5
/w setup 5 12H 30m
/w setup 5 7d 3H 2m
/w @username reset
/w @username racism

/w @username
Don't
do it
again.

👨‍💼 Users

report / r

🧰 Functionality:

⠀Report a user violation. The report notification will be sent to the group administrators who started the bot.

🗣 Aliases:

/report, !report
/r, !r

⚙️ Usage:

/r — as a reply to a message

token_info / ti

🧰 Functionality:

⠀Show a token info:

  • Price;
  • Circulating supply;
  • Market cap;
  • Total supply;
  • Fully Diluted Value (FVD).

⠀In addition, it allows to calculate the product of the price.

🗣 Aliases:

/token_info, !token_info
/ti, !ti

⚙️ Usage (underlined is mandatory):

/ti SYMBOL NUMBER

  • SYMBOL — token symbol
  • NUMBER — number to calculate a product

🕹 Examples:

/ti eth
📢 Project name: Ethereum
⚛️ Token symbol: ETH

💵 Price: 1 072.61$

🔄 Circulating supply: 119 514 467 ETH 
📊 Market cap: 128 192 413 224$

📈 Total supply: -
💰 Fully Diluted Value (FVD): -
/ti btc 0.00042
📢 Project name: Bitcoin
⚛️ Token symbol: BTC

💵 Price: 19 432.41$
🧮 Product: 8.16161$

🔄 Circulating supply: 19 082 512 BTC (90.87%)
📊 Market cap: 370 819 197 013$

📈 Total supply: 21 000 000 BTC
💰 Fully Diluted Value (FVD): 408 080 610 000$
/ti bnb 0,292
/ti sol 1'200
/ti trx 119 272 123.59

warning / w

🧰 Functionality:

⠀View issued warnings.

🗣 Aliases:

/warning, !warning
/w, !w

⚙️ Usage:

/w

Captcha

To the content

⠀Types are in descending order of difficulty.

Random

⠀The bot sends random type captcha to a new user (see types below).

Numbers and buttons

⠀A new user must read the message and based on it find a number with a certain ordinal place from the left or right side of the image and press the appropriate button.

⠀Examples:

  • Select the third digit from the left side.
  • Select the fourth digit from the right side.
  • Select the second digit from the left side.
  • Select the first digit from the right side.

Letters

⠀A new user must enter 5 letters from the image (i always with a dot).

Arithmetic

⠀A new user must solve an arithmetic task from image and send the answer (there may be a negative answer).

None

⠀Users are free to join without having to solve any captcha. This type is recommended during mass joins to the group.

Anti-spam system (BETA)

To the content

⠀Admitix has anti-spam system which protect crypto groups from spamming. In addition, he immediately bans fake bots (Rose, Group Help, etc.) which join to spam.

⠀To help developers improve anti-spam system, please, send the /report command as a reply to spam message which bypassed the system (general users can send it too)! This action will send a message to the developers for further analysis.

Report a bug or suggest an idea

To the content

⠀If you found a bug or have an idea, go to the link, select the template, fill it out and submit it.

Express your gratitude

To the content

⠀You can express your gratitude to the bot developers by sending fund to crypto wallets!

  • Ethereum-like address (Ethereum, BSC, Moonbeam, etc.): 0x55AD64372bf4452759D577453521eb502001529A
  • USDT TRC-20: TQvc5ruZPUSrs7riWeeekka5FjCGAiQ2wE
  • SOL: 8zpWbtTxmubgqcBXHQ129YbZszVp3WUcYc6a34peam3h
  • BTC: bc1qnuwkg5ph0r8s332kle6jz2qmxe9ls36z9yt9ws

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published