Chat Bot - H1DD3NxN1NJA/ChatManager GitHub Wiki

Sections

• Chat Bot
• Understanding Chat Bot
• Creating a New Chat Bot
• Placeholders

Chat Bot (top)

The chat bot feature is a simple little thing added to help servers owners with their server. When a player asks a question in chat, and that question is in the ChatBot.yml file, the bot will respond with an answer, but it can also execute commands to the player its responding to. You can also have a required permission, so if the player doesn't have the correct permission the bot wont do anything towards that player.

Important information regarding the chat bot

Make sure when players use the chat bot they don't add unnecessary punctuation marks (I.E. ?.,!). The chat bot may not pick it up if players use those when they aren't added to the question. Also make sure the grammar feature is disabled, due to it adding the punctuation marks at the end of a sentence problems can and will occur making the chat bot not work.

Understanding Chat Bot (top)

This area should help you understand the chat bot feature as simple as possible.

This is one of the preset sections in the ChatBot.yml file, I'm going to break it down for you so you know how to use it properly.

Everything in this section besides the Players_Messages: can either be replaced with "" or "none" so the bot doesn't do anything you don't want it to do.

  Three:
    Players_Messages:
    - "help me"
    - "can someone help me?"
    Bot_Response: "&fSure thing &e{player}&f, do &e/help&f!"
    Required_Permission: "ChatBot.help"
    No_Permission_Message: "&4No"
    Executed_Command: "none"

1. The name of this section is Three:, you can change it to whatever you want it to be. Make sure you add two spaces before adding the sections name.
2. The next section Players_Messages: is the message the player has to type in chat for the bot to activate, you can add as many messages as you like for this section. When adding Player_Messages: make sure you add four spaces before you add it, as well as adding the messages.
3. The next section to this is the Bot_Response:, here you add the message the bot responds with to the player that's sending the message. Make sure you add four spaces before adding the section.
4. The next section to this is the Required_Permission: section. Players need this permission to activate the bot. Without it, the bot will just respond with the No_Permission_Message: and wont execute the command.
5. The final section to this is the Executed_Command: section. Here you can have the bot execute any command you want it to. The command executes though console, so make sure the command can be executed in console before you add it. If you have a required permission, and the player sending the message doesn't have it, the bot wont execute the command towards that player. You do not need a required permission for the bot to execute the command.

I hope this helped you understand how to use the chat bot feature properly.

Creating a New Chat Bot (top)

If you want to create a new chat bot, and you are stuck on doing it, this section should help you out. The chat bot isn't to complicated at all, it shouldn't take more than five minutes to make a section, depending on how many player messages you are adding. FYI, the players messages aren't case sensitive, you can add all lowercase and if the player talks in all CAPS the bot will still be activated.

1. Add the name to the chat bot section.

  OpMe:

2. Add the players messages you want to use to activate the bot.

    Players_Messages:
    - "ChatBot, can you op me?"
    - "op me"
    - "Can you please op me ChatBot."

3. Add the bot response, the response you want the bot to give the player that sends the proper message.

    Bot_Response: "&7You got it &c{player}&7!"

4. Add the required permission, you must give players this permission if you want them to use this section of the chat bot. You don't have to add a required permission if you don't want to, but for the tutorial we'll add one. The permission can be anything you want, it can even be something like "IAmThe.Best.OpMe.Please"

    Required_Permission: "ChatBot.OpMe"

5. Now were gonna add the no permission message. This is the message the bot sends to the player that activates it, but they don't have the proper permission for the Bot_Response: and the Executed_Command:.

    No_Permission_Message: "&7Sorry &c{player}&7, but you don't have the correct permission to receive op."

6. Finally we add the executed command. This command is executed from console, and is only executed the the player that activates the bot. Make sure you DO NOT add the "/"

    Executed_Command: "op {player}"

You are now done with creating the OpMe chat bot. The section should now look like this.

  OpMe:
    Players_Messages:
    - "ChatBot, can you op me?"
    - "op me"
    - "Can you please op me ChatBot."
    Bot_Response: "&7You got it &c{player}&7!"
    Required_Permission: "ChatBot.OpMe"
    No_Permission_Message: "&7Sorry &c{player}&7, but you don't have the correct permission to receive op."
    Executed_Command: "op {player}"

You can add as many Chat Bot sections as you like, there is no limit.

Placeholders (top)

This is a list of all the available placeholders you can use for the chat bot.

If you like to see a list of all the available placeholders you can use for the chat bot please go here.

If you wish to use PlaceholderAPI's placeholders, you can find them here.