character.yml

The character.yml is a configuration file that defines the behavior and identity of the in-game characters powered by OpenAI.

Character Configuration Guide

The character.yml configuration file defines the behavior and identity of the in-game characters powered by OpenAI. Adjusting the parameters in this file customizes the character's interactions with players, ensuring a unique and immersive experience.

• Character Identity

  • character-id: Unique identifier for the character. It's used to retrieve the character's data from cache.

    • Example: harrypotter

  • character-name: The full name of the character.

    • Example: "Harry Potter"

  • character-role: Describes the character's role or title.

    • Example: "Harry Potter"

  • character-personality: Describes the character's personality traits, guiding their behavior and responses.

    • Example: "cheerful, curious, and always eager for adventure"

• Communication Settings

  • character-tag: The tag players use to initiate conversation with the AI character.

    • Example: "HPotter"

  • character-prefix: The prefix displayed when the AI character speaks.

    • Example: "&eHarry Potter: &f"

  • bye-word: The word or phrase ending the conversation with the AI.

    • Example: "bye"

  • auto-cancel-time: Time in seconds the plugin waits for player input before ending the conversation.

    • Default: 30

• Player Interaction Format

  • player-format: Format for the player's name, which may include placeholders for additional player info.

    • Example: "%luckperms_prefix% %player_name%"

• AI Integration

  • template-prompt: Provides initial context to the AI, ensuring interactions align with the character's identity.

  • resume-tokens: Maximum token count for resumed conversations. A low value may truncate responses.

    • Default: 500

  • greet-prompt: The opening prompt sent to the AI.

  • bye-prompt: The prompt sent to the AI when concluding a conversation.

  • greet-when-resumed-prompt: Prompt sent to the AI when revisiting a conversation.

  • ongoing-resume-request-prompt: Used during conversations to manage the token limit.

  • final-resume-request-prompt: Summarizes the entire conversation for the AI.

• Storage & Limitations

  • rank-group-placeholder: Placeholder for retrieving a player's rank group, used for setting conversation storage limitations.

    • Example: %vault_group%

  • storage-limitations: Defines how long past conversations are kept based on the player's rank group.

  • interactions: Limits how often a player can converse with the AI either daily, weekly, or monthly.

This guide outlines the key settings in the character.yml file. Tailor these settings to your server's requirements for the best player experience.