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.

Editor GUI
In-game Editor interface: Manage your NPCs and scenes visually.

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 Flags

AxLore registers three custom flags for fine-grained narrative control:

  • axlore-enter: (New) Triggers a scene when a player enters the region.
  • axlore-leave: (New) Triggers a scene when a player exits the region.
  • axlore-scene: (Legacy) An alias for entering a region, maintained for compatibility.
  1. Select a region.
  2. Run: /rg flag <region_name> axlore-enter <scene_name>
  3. Whenever a player enters that region, the scene will trigger automatically.

📊 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.

PAPI Integration
Example of integration with AuraSkills and dynamic placeholders.

💻 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.

MythicMobs

  • MYTHIC_DEATH: Activates a cinematic when a boss is defeated. Value: InternalName.
  • MYTHIC_INTERACT: Activates dialogue when right-clicking a mob.

Quests (PikaMug / Blackvein)

Quests Integration
Real-time validation of quests and narrative triggers.

  • 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.

AuraSkills & McMMO

  • AURASKILLS_LEVELUP / MCMMO_LEVELUP: Specific triggers for each skill system.
  • SKILL_LEVEL: Consolidated trigger type for both systems.
Important Notice All hooks are **optional**. If you don't use Citizens or WorldGuard, AxLore will simply disable those modules without any performance impact.

Was this helpful?

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