Narrative Scenes

Scenes are YAML files located in plugins/AxLore/scenes/.

Anatomy of a Scene

title:
  en: "The Ancient Prophecy"
  es: "La Antigua Profecía"
display-mode: BOTH 
intro-audio: "church_bells" 
voice-id: "pNInz6obpg8ndMsc7H8p" 
one-time: true  # Play only once per player
text:
  en: "The ancient seal has been broken. Terror awaits us."
  es: "El sello antiguo se ha roto. El terror nos espera."

🎮 Management Commands

While you can use the GUI, these commands are essential for automation:

• /axlore generate <scene>: Essential first step. Contacts ElevenLabs to generate the OGG files for all defined languages.
• /axlore play <scene> [player]: Plays the scene for the specified player (or yourself if empty).
• /axlore shout <scene>: Cinematic mode. Plays the scene for everyone on the server at once.
• /axlore list: Shows all registered scenes and their trigger status.

Triggers & Events

AxLore supports various ways to trigger a narrative automatically:

• JOIN: Triggers when a player enters the server.
• FIRST_JOIN: Perfect for an immersive tutorial intro.
• INTERACT: Triggers when right-clicking a block (Value: Material Name, e.g., DEEPSLATE_COAL_ORE).
• NPC: Triggers when right-clicking a Citizens NPC (Value: NPC ID).
• ZNPC: Triggers when right-clicking a ZNPCsPlus NPC (Value: NPC Name).
• COMMAND: Triggers via customized command logic.
• WG_FLAG: Triggers when entering/leaving a region with axlore-enter or axlore-leave flags.
• REGION_ENTER: Triggers when entering a specific WorldGuard region (Value: Region ID).
• REGION_LEAVE: Triggers when leaving a specific WorldGuard region (Value: Region ID).
• MYTHIC_DEATH: Triggers when a MythicMob dies (Value: Internal Mob ID).
• MYTHIC_INTERACT: Triggers when right-clicking a MythicMob (Value: Internal Mob ID).
• QUEST_START: Triggers when starting a Quest (Value: Quest Title).
• QUEST_COMPLETE: Triggers when finishing a Quest (Value: Quest Title).
• AURASKILLS_LEVELUP: Triggers on AuraSkills level up (Value: skill:level or just skill).
• MCMMO_LEVELUP: Triggers on mcMMO level up (Value: skill:level or just skill).
• SKILL_LEVEL: Legacy consolidated trigger for both skill systems.

Example Config:

trigger:
  type: NPC
  value: "42"  # Triggers when clicking NPC #42

# RPG Example: Custom Boss Dialogue
trigger:
  type: MYTHIC_INTERACT
  value: "SkeletonKing"

⚔️ Detailed RPG configuration

When using RPG triggers, ensure the value matches exactly what the plugin uses internally.

Generation Process

1. Define the scene.
2. Run /axlore generate <name>.
3. The plugin will convert text to high-quality OGG files.

💡 Special "Secret" Features

• Typewriter Effect: In Hologram mode, the letters appear one by one synchronized with the audio, creating a "real talking NPC" feel.

• Intro Synchronization: If you place an audio file in the /plugins/AxLore/intros/ folder, you can use the intro-audio: "filename.mp3" key in your scene. The plugin will automatically detect its duration and delay the AI narration to start right after the intro finishes.

  • Supported Formats: .mp3, .ogg, .wav, .mp4, .m4a (Autoconverted via FFmpeg).

• Language Detection: The plugin automatically detects the player's client language if the texts are correctly configured in the scene.

• One-Time Scenes: Set one-time: true to ensure a player only experiences a scene once in their entire adventure (saved via NBT).