The Basics

Before diving into the detailed configuration options, it's important to understand the basic structure and purpose of the various folders and files used by ServerAssistantAI for configuration.

config.yml:

• This is the main configuration file for ServerAssistantAI. It contains settings for the AI's behavior, appearance, and performance, such as model selection and customization options. You can modify this file to tailor the AI assistant to your server's specific needs.

credentials.yml:

• This file stores the necessary credentials for providers and addons used by ServerAssistantAI, such as API keys and access tokens. It is important to keep this file secure and not share it publicly.

discord/ directory:

• This directory contains configuration files specific to ServerAssistantAI's Discord integration.

  • prompt-header.txt: This file defines the AI's persona and behavior when responding to questions on Discord.

  • information-message.txt: This is the file where information is automatically extracted from the documents in the documents/ directory based on the relevance to the player's question. It also allows you to provide additional information to the AI when generating responses on Discord, including the conversation history from the Discord channel.

  • question-message.txt: This file defines the format for the question message sent to the AI assistant on Discord.

documents/ directory:

• This directory stores all the server-related information, such as rules, features, and commands. The AI assistant uses this information to provide accurate and context-aware responses to player queries. Add as much information as you can about your server to files within this directory. You can use various file formats including .txt, .md, .pdf, and Microsoft Office formats.

minecraft/ directory:

• This directory contains configuration files specific to ServerAssistantAI's Minecraft integration.

  • prompt-header.txt: Similar to the Discord version, this file defines the AI's persona and behavior when responding to questions in Minecraft chat.

  • information-message.txt: This is the file where information is automatically extracted from the documents in the documents/ directory based on the relevance to the player's question and also allows you to provide additional information to the AI when generating responses in Minecraft, including the conversation history from the Minecraft chat.

  • question-message.txt: This file defines the format for the question message sent to the AI assistant in Minecraft, including custom placeholders for player information.

interaction-messages/ directory:

• This directory contains JSON files that define the format and content of the interaction logs sent to designated Discord channels or webhooks whenever a player or bot interacts with the AI assistant on Minecraft or Discord.

  • discord-interaction-message.json: Defines the format for Discord bot interactions.

  • minecraft-interaction-message.json: Defines the format for Minecraft player interactions.

logs/ directory:

• This directory is automatically created when logging is enabled and contains detailed logs of all AI interactions for both Minecraft and Discord. The logs are saved in a structured format that tracks questions, responses, and metadata about each interaction. The logging system can be configured through the logging section in the config.yml file.

messages.yml:

• This file allows you to customize various messages and responses that ServerAssistantAI sends to players in both Minecraft and Discord. It uses the MiniMessage format for Minecraft messages and Discord formatting for Discord messages. You can modify command responses, error messages, and status texts to match your server's style and language.

To get started with configuring ServerAssistantAI, follow these steps:

1. Open the config.yml file and familiarize yourself with the available settings. Adjust the values according to your preferences and server requirements.

2. Fill the credentials.yml file with the credentials required for your configuration.

3. Review and customize the files in the discord/ and minecraft/ directories to fine-tune the AI's behavior and responses on each platform.

4. Populate the documents/ directory with relevant information about your server, such as rules, features, and commands. You can use multiple files in various formats (.txt, .md, .pdf, Word, Excel, PowerPoint). Keep these files up-to-date to ensure accurate responses from the AI.

5. Review and customize the messages.yml file to adapt the messages displayed by ServerAssistantAI in Minecraft and Discord to your server's style and language.

6. If desired, modify the discord-interaction-message.json and minecraft-interaction-message.json files in the interaction-messages/ directory to customize the appearance and content of the interaction logs sent to Discord channels or Discord webhooks.

7. Configure the logging settings in the logging section of config.yml if you want to track and analyze AI interactions. The logs will be saved in the logs/ directory and can be analyzed using our web-based Log Analyzer.

By understanding the purpose and structure of these configuration files and folders, you'll be well-equipped to customize ServerAssistantAI to best suit your server's needs. The following sections will provide more detailed information on each configuration aspect.