💬Chat

Overview

The chat module use the language model ChatGPT by OpenAI to allows your virtual players to communicate with real players flowlessly. As it relies on one of the best language model in the world, this module is ideal if you want to boost your server statistics without any of your players noticing.

Configuration

The configuration of the chat module is really easy but you need to understand each part to avoid making mistakes.

ChatGPT settings

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                             CHAT GPT SETTINGS                           | #
# |                                                                         | #
# |                 Tweak how chat gpt behaves on your server.              | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #
chat-gpt:
  # This is your Open Ai secret key
  # You can obtain one for free at https://platform.openai.com
  # There is a tutorial on how to get one at https://elephas.app/blog/how-to-create-openai-api-keys-cl5c4f21d281431po7k8fgyol0
  secret-key: "your-open-ai-secret-key"

  # This option allows you to give some context to ChatGPT to make it more natural.
  # You can tweak this to your liking and see what works best for you.
  context: "You are a minecraft player playing in a survival server and you need to act like a player. Don't let other players know you are an AI, never! Your responses should be as natural as possible and short."

In this section, you can edit the ChatGPT related settings.

First of all you need to get an OpenAI api key, it's quite easy and OpenAI often offer you $5 as a welcome gift, which can let you test our module.

You will find a good tutorial about getting an OpenAI key here. Regarding the prices, you can find them out on this page.

Once you have your OpenAI secret key, paste it in the secret-key field.

The second option is really important to make the chat module works properly. If you ever heard about ChatGPT, you might know that it can handle context and understand how to deal with it.

It's exactly what we're trying to do here with the context field. We give ChatGPT some advices/rules before every conversation, by default we explain that the ai is playing on a survival server and it must act like a player and not as a language model.

The more precise you are on the context you give, the more accurate the ai will be on your server.

Triggers settings

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                             TRIGGERS SETTINGS                           | #
# |                                                                         | #
# |                   Modify how and when chat gpt triggers.                | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #
triggers:
  # Delay between the trigger and the poof player response.
  # Time is in seconds.
  delay:
    minimum: 60
    maximum: 120

  # This option allows you to set the minimum amount of players online to trigger chat gpt.
  minimum-players: 2

  # This option allows you to set if the poof player should be able to answer when their name is mentioned.
  mention: true

  # The poof players will talk in chat randomly.
  # This option allows you to set the minimum and maximum time between each chat.
  # Time is in seconds.
  random:
    # true = enabled, false = disabled
    enabled: true
    minimum: 120
    maximum: 3600

Private messages settings

This feature only works with EssentialsX for now.

# +-------------------------------------------------------------------------+ #
# |                                                                         | #
# |                        PRIVATE MESSAGES SETTINGS                        | #
# |                                                                         | #
# |         Controls how poof players handle their private messages.        | #
# |                                                                         | #
# +-------------------------------------------------------------------------+ #
# This feature is currently compatible with:
# - EssentialsX
private-messages:
  # This option allows you to toggle the private messages feature.
  enabled: true

  # This option allows you to set the delay between the trigger and the poof player response.
  # Time is in seconds.
  delay:
    minimum: 30
    maximum: 120