⚙️ Plugin Configuration

AxLore is managed through two main files: config.yml (logic and scenes) and credentials.yml (private keys).

📄 Configuration Files

• config.yml: Defines the AI engine, hosting method, and all narrative scenes.
• credentials.yml: Securely stores your ElevenLabs API Keys and Dropbox tokens. Never share this file.

🎙️ AI Engine (ElevenLabs)

Configure the quality and behavior of the generated voices.

elevenlabs:
  model: "eleven_multilingual_v2"  # Recommended for high-fidelity narrations
  voice-settings:
    stability: 0.5        # Controls variability (0.0 to 1.0)
    similarity-boost: 0.8 # How much it resembles the original voice
    speed: 1.0            # Narrator speed (0.7 to 1.2)

🎭 Audio Effects

Add atmosphere to your scenes using the effect node:

• whisper: Ambient whispering.
• echo: Cave or large hall echo.
• dark: Deep and menacing voice.
• epic: Cinematic and heroic sound.

⚡ Audio Optimization (FFmpeg)

AxLore includes an automated optimization engine to ensure that the Resource Pack doesn't overload your players' bandwidth.

• MP3 to OGG Conversion: The plugin downloads high-fidelity MP3s from the cloud and automatically converts them to OGG Vorbis (96kbps).
• Efficiency: This process reduces the file size by up to 60% without losing perceptible narrative quality.
• Automatic Requirement: If FFmpeg is not detected in the system, the plugin will attempt to download a portable version automatically.

📦 Resource Pack Hosting

Players need to download a pack to hear the voices. AxLore offers two methods:

🏠 Internal Hosting (hosting)

AxLore runs its own web server (NanoHTTPD).

• Best for: VPS with open ports or local networks.
• Setup: Ensure the port (e.g., 8090) is open in your firewall.

🔵 Dropbox (dropbox)

Automatically uploads the pack to the cloud. This is the most reliable option for public servers.

1. Link your account with /axlore dropbox auth.
2. AxLore will handle the upload and generate direct download links.

🎬 Creating Scenes (scenes)

Scenes are the heart of AxLore. Each one defines what is said and when.

⚙️ Display Options (display)

• HOLOGRAM: Text appears above the player or entity.
• BOSSBAR: Text appears in the top boss bar.
• BOTH: Both methods simultaneously.

🚀 Triggers (triggers)

• REGION: Activated when entering a WorldGuard region.
• KILL: Activated when killing a specific mob.
• COMMAND: Activated manually with /axlore play.