Open-Source re-creation of telegram group manager Group Help in nodejs!

An official instance of bot is running on @LibreGroupHelpBot, you can use that if you can't run it locally

Installation:

$ npm install

Set your bot token on config.js Config documentation: https://github.com/Sp3rick/GroupHelp/blob/main/CONFIG_DOCUMENTATION.md

Run with: $ node index.js

|

Installation trubleshooting:

if you have problems with node-telegram-bot-api installation use this command url based: $ npm i https://github.com/yagop/node-telegram-bot-api

and if needed install other packages manually: $ npm i chrono-node

|

Useful links to contribute: https://github.com/Sp3rick/GroupHelp/blob/main/documentation.md

When you create a plugin you can document it on https://github.com/Sp3rick/GroupHelp/blob/main/plugins.md

|

Updating: to update the bot you need to backup ./database folder and ./config.js only, then repeat installation process and paste there the old database folder

|

TODO:

-short term:

allow /*settings
allow to edit single user perms
commands help panel
--below low priority--
allow on /perms to change user perms and roles +add it in a button for /info or when a role is set (/free /mod etc..)
allow to see perms calculation trough user perms, then roles by priority, then base group perms, going from left to right (or opposite)
add something to allow a group admin to identify all users with special perms
?add an automatic leveling system for admins? (maybe?)
ask double confirm to give an user the "settings" and "roles" (roles management) permission
add photo preview-mode in MessageMaker.js
allow to warn only usersIds who exhist on telegram, it can be checked if applyng a restriction returns true
add config to allow/disallow adding bot from non-admin users
?identify reply_parameters and add everytime allow_sending_without_reply?

-medium term:

support for anonymous admins
allow to customize /staff allowing to set roles to hide
create a privacy setting where users can ask to esclude themself from tagResolver and replace his's first name in database with "Anonymous"
allow to disable tagResolver log on group settings
allow to mute only media, or specific media type or extras
once bot will be declared ready to use, add code versioning system to update database when user update it
create a privacy option to allow a user deleting his data from the bot
custom roles
optimize database.get, .update and .save to store in temporal array most used users
implement time zone setting +implement it in /info

-long term:

add log channel
compress chats data stored on database
support all group help functions and more (+anti-sheduled messages[msg.is_from_offline], )
allow bot clone bot when user give a token
add optionally an userbot (when active implement in tagResolver.js)

|

known possible bugs: -sometimes db.chats.update in plugins may be not used at all because you can still edit the global object cause to reference, not using it may cause some issue. +if global reference get cleared too early code may try to access and inexistent variable

-if bot is expecting a message from an user it will take the reply from any chat the user write

-cleanHTML() may be not applyed in some text where it should, the function probably clean everything needed to clean for telegram api

-if get added a new permission and it's not added to every userPerms object in chat data this may cause incorrect result in sumUserPerms