Messages YAML File

The messages.yml file allows you to customize various messages and responses that ServerAssistantAI sends to players in both Minecraft and Discord.

File Structure

The messages.yml file is divided into two main sections:

1. minecraft: Contains messages for in-game interactions

2. discord: Contains messages for Discord interactions

Minecraft Messages

The Minecraft section uses the MiniMessage format for text styling and formatting. You can learn more about the MiniMessage format here.

Discord Messages

The Discord section uses Discord's native formatting. Messages can be prefixed with error: for red embeds or success: for green embeds. More information on Discord message formatting can be found here.

messages.yml

# ServerAssistantAI Messages Configuration

# Minecraft messages. Uses MiniMessage format: https://docs.advntr.dev/minimessage/format.html
minecraft:
  commands:
    help: |-
      <st><gray>-----</gray></st> <gradient:#0073FF:#00C6FF><bold>ServerAssistantAI Help</bold></gradient> <st><gray>-----</gray></st>
      <#ffaa00><bold>Commands:</bold>
      <yellow><click:suggest_command:/serverassistantai ask><yellow>/serverassistantai ask <color:#abab39>[question]</color></click></yellow> <gray>-</gray> <white>Ask the AI a question.</white>
      <yellow><click:suggest_command:/serverassistantai usage><yellow>/serverassistantai usage <color:#abab39>[player]</color></click></yellow> <gray>-</gray> <white>See your or another player's usage.</white>
      <yellow><click:suggest_command:/serverassistantai toggle><yellow>/serverassistantai toggle</click></yellow> <gray>-</gray> <white>Toggle auto-answering.</white>
      <yellow><click:suggest_command:/serverassistantai chat><yellow>/serverassistantai chat</click></yellow> <gray>-</gray> <white>Start a conversation with the AI.</white>
      {permission:serverassistantai.reload}<yellow><click:suggest_command:/serverassistantai reload><yellow>/serverassistantai reload</click></yellow> <gray>-</gray> <white>Reload the plugin.</white>{/permission}
      {permission:serverassistantai.reset}<yellow><click:suggest_command:/serverassistantai reset><yellow>/serverassistantai reset <color:#abab39>[player]</color></click></yellow> <gray>-</gray> <white>Reset a player's usage.</white>{/permission}
      <#ffaa00><bold>Aliases:</bold> <gray><green>/saai</green>, <green>/ai</green>, <green>/assistant</green>
      <st><gray>-----</gray></st> <gradient:#0073FF:#00C6FF><bold>ServerAssistantAI Help</bold></gradient> <st><gray>-----</gray></st>
    ask:
      missing_arguments: '<red>Usage: </red> <yellow>/serverassistantai ask</yellow> <aqua><question></aqua>'
    usage:
      response: <gray><name> asked <blue><usage>/<limit></blue> questions today.</gray>
    toggle:
      response: <gray>Automatic chat question answering is now <status>.</gray>
    chat:
      start: <green>You are now chatting with the bot. <aqua>Use <yellow>/saai chat stop</yellow> to exit.</aqua>
      stop: <green>No longer chatting with the bot.</green>
      self_message: '<gray>You: </gray><message>'
      stop_text: ' <click:run_command:''/saai chat stop''><hover:show_text:''<red><bold>STOP CHAT''><red><bold>🛑</bold></red></hover></click>'
  errors:
    no_permission: <red>You do not have permission to use this command. Please contact a server administrator if you believe this is an error.</red>
    general: <red>An unexpected error occurred. Please contact a server administrator for assistance.</red>
    no_permission_ask: <red>You do not have permission to ask bot questions. Please contact a server administrator for access.</red>
    not_ready: <red>The bot is not ready at the moment. Please try again in a few minutes.</red>
    overloaded: <red>The bot is currently overloaded. Please try again shortly.</red>
    already_answering: <yellow>The bot is still processing your previous question. Please wait for that response before asking another question.</yellow>
    limit_reached: <red>You have reached your daily limit. This limit will reset within 24 hours.</red>
  status:
    replying_title: <aqua>Replying...</aqua>

# Discord messages. Uses Discord formatting. Prefixes: 'error:' (red embed), 'success:' (green embed). More info: https://discord.com/developers/docs/reference#message-formatting
discord:
  commands:
    usage:
      response: success:[name] asked [usage]/[limit] questions today.
    toggle:
      response: success:Automatic chat question answering is now **[status]**.
  errors:
    minimum_words: error:Hi [user.asMention]! Your question is too short to provide a meaningful answer. Please provide more details or context in your question.
    no_permission: error:You do not have permission to use this command. Please contact a server administrator if you believe this is an error.
    no_permission_ask: error:You do not have permission to ask bot questions. Please contact a server administrator for access.
    not_ready: error:The bot is not ready at the moment. Please try again in a few minutes.
    overloaded: error:The bot is currently overloaded. Please try again shortly.
    already_answering: error:The bot is still processing your previous question. Please wait for that response before asking another question.
    limit_reached: error:You have reached your daily limit. This limit will reset within 24 hours.

Remember to reload ServerAssistantAI after making changes to the messages.yml file for the changes to take effect.