-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the VaGABfS wiki!
To execute a command in the private chat with VaGABfS you just need to send the command. To execute a command in a group with VaGABfS you need to mention VaGABfS followed by the command.
There are three levels of permissions: users, moderators and admins.
- Every group member is a user per default, users can execute simple commands like
whoAreYou,voteorvoteInfo. - Moderators can execute most commands (including for example
voting) - Admins can execute every command (including for example
stopBot)
Note: if you are not in at least one group with VaGABfS, you are not allowed to execute any commands.
Caution
All commands marked as a Warning are not implemented yet due to the codebase getting rewritten
User commands are commands that everyone can execute.
Sends this message: https://github.com/The-Bug-Bashers/VaGABfS/issues/2#issuecomment-1944608547
-m / --mention
-m or --mention is used to specify to which user VaGABfS should reply. The -m or --mention attribute can only be used by moderators or admins.
-p / --private
-p or --private is used to send the whoAreYou message via a private chat.
Shows the role of the specified user
-u / --user
-u or --user is used to specify the user. If the command is executed without the attribute, the role of the author will be returnend.
Displays a message to provide help with using VaGABfS.
Moderator commands are commands that normal users can not execute because there is a potential for exploitation
Removes all signal group admins exept the bot itself, sets the send messages permition to everyone, the change group details permition to ownly admins, the add members permition to ownly admins, disables the join link and disables dissapearing messages.
Admin commands are commands that only admins can execute. admins have full control over the group and bot behavior.
Adds a user to a group. The target user should be specified using the -u or --user attribute followed by the telephone number starting with the country-code. (example: addMember -u +491234567890)
Removes a user from a group. The target user should be specified using the -u or --user attribute followed by the telephone number starting with the country-code. (example: removeMember -u +491234567890)
Grants a user from a group administrator rights. The target user should be specified using the -u or --user attribute followed by the telephone number starting with the country-code. (example: makeAdmin -u +491234567890)
Revokes the administrator rights from a user of a group. The target user should be specified using the -u or --user attribute followed by the telephone number starting with the country-code. (example: revokeAdmin -u +491234567890)
Changes the name of a group. (example: changeGroupName <new group name>)
Changes the description of a group. (example: changeGroupDescription <new group description>)
Logs the new messages from the last ~10 seconds to the selected signal chat.
Stops VaGABfS (To reactivate it, you have to restart the file in the command line). Once you execute stopBot you will get prompted to enshure you realy want to stop VaGABvS, you have to respond within two minutes with stopBot yes to stop VaGABfS.
Logs the UpcomingActions arrays to the signal chat.
Deletes one upcoming action. The command should be executed like this: deleteUpcomingAction <number of upcomingAction that should be deleted>
Adds an upcoming action. The command should be executed like this: addUpcomingAction "<argument 1> <argument 2> <argument 3> <argument 4> <argument 5> <argument 6> <argument 7> <argument 8>"
Changes the role of an User.
-u / --user
-u or --user is used to specify the user.
--member / --moderator / --admin
--member, --moderator or --admin are used to specify the role to wich the user should get set.
executes the command specifyed in the CLI of the server FaGABfS is running on. Exemple: execute "whoami"
upcoming actions are 8 arrays in wich the bot stores actions it should perform in the future.
upcomingActions1 storres the associated command.
upcomingActions2 storres the timestamp of the initiating message.
upcomingActions3 storres the Author of the initiating message.
upcomingActions4 storres the reply address for further actions. The reply adress is the telephonenumber of the initiating message author in a private chat or -g followed by the group code in a group.
upcomingActions5 storres the time then the action should be performed in UNIX in ms.
upcomingActions6 (optional) storres the first spetial parameter (if existing).
upcomingActions7 (optional) storres the seacond spetial parameter (if existing).
upcomingActions8 (optional) storres the third spetial parameter (if existing).
indicates that the user got prompted to verrify, that he realy wants to stop VaGABfS.
- 1: "stopBot".
- 2: initiating message timestamp.
- 3: initiating message author.
- 4: chat in wich the user got prompted to verrify, that he realy wants to stop VaGABfS.
- 5: time of creation plus 2 minutes.
Indicates, that one of the auto-reply funktions is on cooldown and the bot shoulden't reply to the accociated trigger message.
- 1: "timeout".
- 2: initiating message timestamp.
- 3: initiating message author.
- 4: chat in wich the cooldown should apply.
- 5: time of creation plus the time the cooldown should last for. The time changes depending on the reply that is on cooldown.
- 6: name of the reply.
sends a message.
- 1: "send".
- 2: "automation" information not required.
- 3: "automation" information not required.
- 4: chat to wich the message should get send.
- 5: time at wich the message should be send. If the providet time is in the oast, the message wil get send immediately.
-
6: message that should get send in signal-cli syntax. (exemple
-mthisIsAnExemplewill output: thisIsAnExemple). No spaces are allowed. -
7: (optional) time interval in wich the message should be send again (endlesly)
-m1for one minute,-h1for one hour,-d1for one day.
Auto-reply is a funktion that lets VaGABfS automaticly reply to certain trigger-messages or times.
trigger messages trigger a reply if there currently is no timeout for the reply in the chat the trigger message got send and if existing every condition is met.
- timeout: 30 seconds
- reply: "Doch‼"
- contition: 1/5 chance
- timeout: 30 minutes
- reply: "Guten Morgen‼👋"
- timeout: 12 hours
- reply: "Süßer Otter 🦦 😍"
- timeout: 30 minutes
- reply: "hallo"
- timeout: 15 minutes
- reply: "Gute Nacht💤"
- contition: not send by "+4915255665313"
- timeout: 5 hours
- reply: "Sleep well in your Bettgestell🛏️"
- contition: send by "+4915255665313"
- reply: "it is wednesday my dudes"
