Documentation Guide

Professional Integrations

Connect AxLore with Citizens, WorldGuard, and PlaceholderAPI.

🔌 Professional Integrations

AxLore is designed to work seamlessly with the most popular plugin ecosystems in the Minecraft world. Instead of using complex commands, AxLore uses native event-driven hooks for high performance and reliability.

👥 NPC Integrations

AxLore automatically detects and hooks into:

  • Citizens: Use the numeric NPC ID as the trigger value.
  • ZNPCsPlus / ServersNPC: Use the NPC Name as the trigger value.

Setting up an NPC Trigger:

You can do this manually in config.yml or using the simple command:
/axlore link npc <scene_name> <npc_id_or_name>

🚩 WorldGuard Regions

The most powerful way to create immersive environments is using WorldGuard regions. AxLore registers a custom flag for this purpose.

The axlore-scene Flag

  1. Select a region.
  2. Run: /rg flag <region_name> axlore-scene <scene_name>
  3. Whenever a player enters that region, the scene will trigger automatically.
Pro Tip This method is superior to the `REGION` trigger type because it is handled natively by the WorldGuard flag system, ensuring zero lag.

📊 PlaceholderAPI

AxLore exposes its internal state so you can display it in scoreboards, menus, or chat.

Placeholder Description
%axlore_lang% Displays the player's selected language.
%axlore_is_playing% Returns true or false.
%axlore_current_scene% The technical name of the active scene.
%axlore_current_title% The translated title of the active scene.
%axlore_is_muted% Returns true if the player has narrations muted.
%axlore_active_sessions% (Global) How many players are currently listening to events.

💻 Developer API & ConditionalEvents

For advanced users, AxLore fires a custom event whenever a scene is triggered:
com.axxtrial.license.event.AxLoreSceneTriggerEvent

Integration with ConditionalEvents

You can use ConditionalEvents to listen to this event, add extra conditions (like "only if player has X item"), and then let the story proceed or cancel it!

Event Name: AxLoreSceneTriggerEvent
Variables:

  • %scene%: The name of the scene.
  • %player%: The player triggering the scene.

⚔️ RPG Integration Suite

AxLore features a native, high-performance bridge for the most popular free RPG plugins. These integrations are passive; they only consume resources when a specific event is detected.

MythicMobs

Transform boss battles into cinematic experiences.

  • MYTHIC_DEATH: Activates a cinematic when a boss is defeated. Value: InternalName.
  • MYTHIC_INTERACT: Activates dialogue when right-clicking a mob. Value: InternalName.
    • Pro Tip: The InternalName is the name of the YAML file or the top-level ID in your MythicMobs configuration (e.g., SkeletonKing:).

Quests (PikaMug)

Integrate NPC dialogue directly into your questing system.

  • QUEST_START: Triggers a narrative intro when a quest is accepted.
  • QUEST_COMPLETE: Triggers a victory cinematic when a quest is finished.
    • Value: Use the exact Title of the quest as defined in the Quests editor.

AuraSkills & McMMO

Reward player progression with unique lore or tutorials.

  • SKILL_LEVEL: Triggers when a player reaches a specific milestone.
  • Format: skillname:level (e.g., mining:10 or swords:50).
  • Logic: AxLore listens for the SkillLevelUpEvent (AuraSkills) or McMMOPlayerLevelUpEvent (McMMO) and maps them to your local scenes.

Performance & Stability

The RPG Suite leverages a Reflection-based Architecture. This allows AxLore to support these plugins without requiring them as a "hard dependency". If you upgrade or change your RPG plugins, AxLore will continue to build and run perfectly, automatically re-detecting the new versions at runtime.

Important Notice All hooks are **optional**. If you don't use Citizens or WorldGuard, AxLore will simply disable those modules and run normally without any performance impact.

Was this helpful?

Help us improve our documentation.(Anonymous & any language)