Skip to content

Commands

Jedddy edited this page Dec 9, 2023 · 38 revisions

ProgPH Bot Commands

Categories:

Bracket meanings:

<> - required
[] - optional

Announcements

/announce

/announce <channel> <submission_type> [photo=None] [mention=None]

Sends an announcement to a specified channel.
If the `mention` parameter is used, you will have to format your announcement with any of the following tags:
-------------------------------
$user - Users
$role - Roles
$channel - Any kind of channel
@everyone - To mention everyone
-------------------------------
Example:

"Hello everyone, please check out $channel"

Then after you submit your modal, you'll get prompted to choose the roles/members/channels you want to mention. For the command to work properly as intended, only select the correct number of tags written in your announcement modal.
Based on the example above, you should only pick the correct amount of channels  and it'll get automatically converted to a discord channel mention.
You can have more than 1 type of tag if you wish.

/shout
/shout <channel> <message>

Sends a one line announcement to the specified channel.

AutoResponder

/add

/responder add <response_type>

Adds a trigger message and a response message for the auto-responder feature.
Response Types:
-------------------------------
reply - The bot will reply when responding to the trigger
regular - The bot will send a regular message when triggered
-------------------------------
Matching Types: (default: Lenient)
-------------------------------
1. String Matching Types
    - Strict
      - Entire message must match the response string exactly AS-IS
        - Example:
          - Responder: ml po -> bukas nalang ML
            - MATCH: **ml po**
            - NOT MATCH: ht**ml po**
            - NOT MATCH: tara **ml po** tayo
    - Strict Contains
      - Entire message must contain the response string exactly AS-IS
        - Example:
          - Responder: ml po -> bukas nalang ML
            - MATCH: **ml po**
            - NOT MATCH: ht**ml po**
            - MATCH: tara **ml po** tayo
    - Lenient
      - Entire message must contain the response string regardless of trailing and leading characters
        - Example:
          - Responder: ml po -> bukas nalang ML
            - MATCH: **ml po**
            - MATCH: ht**ml po**
            - MATCH: tara **ml po** tayo
    - Regex
      - The entire message must pass as TRUE for the provided regular expression
      - Must use RE2 RegEx
        - Example:
          - Responder: .\*ml p(O|o|0).* -> bukas nalang ML
            - MATCH: **ml po**
            - MATCH: ht**ml pO**
            - MATCH: tara **ml p0** tayo
-------------------------------

/all
Views all trigger message and their respective responses.

/delete
Deletes triggers from the database, the bot will send a selection view for the user to freely pick the trigger they want to remove.

Trivia


/setup
/trivia setup <channel> <schedule>

Sets up the trivia module, this command can only be used once

/toggle
/trivia toggle

Toggles the feature to turn ON or OFF.

/schedule
/trivia schedule <schedule>

Updates the schedule of the trivia message, can't be used if the trivia module is not set up. Time is at 24hour format

/channel
/trivia channel <channel>

Updates the channel of the trivia message, can't be used if the trivia module is not set up.

/config
/trivia config

Shows the current trivia configuration

AutoTagging

/manage

/tagging manage

Add/Edit auto tags to the database, a view with 2 selection items will pop up. You will pick which role/user u want to add to the auto tags.

/all
/tagging all

Views all auto tags saved on the database.

/toggle
/tagging toggle

Toggles the feature to turn ON or OFF.

/remove
/tagging remove <entry_id>

Removes an auto tag from the database.

You can get the entry id when you do /tagging all

Define

This command was made possible by this API
word

pph-define <word>

Returns the definition of a given word. If given word has more than one definitions, returns all definitions

/toggle

/define toggle

Toggles the command on or off. Only accessible to Admins

JobHiring

/config

/hiring config

View the configurations for job hiring feature

/toggle

/hiring toggle

Turns the feature on/off.

/setup

/hiring setup

Setup the feature for the bot, (You may have to do this several times if you try to do a Once Only schedule.

/channel

/hiring channel

Changes the channel to send the job hiring posts to.

/schedule

/hiring schedule

Changes the schedule of the job hiring posts.

There will be 3 types of schedules to choose from.
- 1. Every day at a specific time.
- 2. Once on a specific day (will delete the setup after it gets sent. so make sure to setup before using again.)
- 3. Recurring

-------------------------------
1. Every day at a specific time.
    The format should be HH:MM

2. Once on a specific day.
    The format should be MM/DD/YYYY

3. Recurring.
    This is a bit tricky, but you can do something like 1d1h1m (1 day 1 hour and 1 minute)

    Here are the supported labels:
        s - second(s)
        m - minute(s)
        h - hour(s)
        d - day(s)
        wk - week(s)
        mt - month(s)

AnonymousPosting

/post

/anon post

Post anonymously to a certain allowed channel.
You will get a UUID pointing to your post. So make sure not to lose that.

/reply

/anon reply

Reply anonymously to a certain post.

/toggle

/anon toggle

Toggle the feature.

/forums

/anon forums <action>

Do something with forums, it can be:
Add: Add allowed forums to for posting.
Remove: Remove a certain forum from allowed forums.
View All: View all allowed forums.

/setlogs

/anon setlogs <channel>

Set a channel as a logging channel for this feature.

/setbutton

/anon setbutton [message]

Set a channel as a "buttons" channel for this feature where members can click to post/reply.
The old button will automatically get deleted when you re-invoke this command on a different channel.

ForumCleanup

/forums

/forum-cleanup forums <action>

Do something with forums, it can be:
Add: Add allowed forums to for posting.
Remove: Remove a certain forum from allowed forums.
View All: View all allowed forums.

/schedule

/forum-cleanup schedule <every>

Day = Once everyday
Week = Once every week

/config

/forum-cleanup config

Setup the configurations (only number of days before closing/locking

/toggle

/forum-cleanup toggle

Toggle this feature

DevHelpSolver

/config

/help-solver config

Configure the feature

/toggle

/help-solver toggle

Toggle the feature

solved

pph-solved

Mark a post as solved

Welcomer

/setup

/setup <role> <channel>

Setup the welcomer, `role` is the role to lookout for, when a member obtains this role, the bot finds the `channel` and welcomes them.

/message

/message

Set a welcome message to welcome members.

You can add a [mention] to your message and it will automatically get converted to a mention to the welcomed member. Note that this will only convert ONE `[mention]` other `[mention]`s will be left as is.
Example:

"Welcome to the server! [mention]" -> "Welcome to the server! <member mentioned here>

PeriodicalReminder

/setup

/setup <member_role> <visitor_role>

Setup the roles required for checking

/toggle

/toggle

Toggles the feature

/message

/message

Set the reminder message

/schedule

/schedule <day> <interval>

Updates the schedule, day = day of the week, interval = per week or per month

/config

/config

View the configuration for this cog

ForumAssist

/new

/forum-assist new

Creates a new configuration.

/edit

/forum-assist edit

Edits an existing configuration. There is no way to add default values to channel and user selects. So you would have to pick the correct forum again before editing the configuration.

/list

forum-assist list

Lists all configurations.

/delete

forum-assist delete

Deletes an existing configuration.
Clone this wiki locally