Insights

Integrations

The CUSTOM keys other Exylia plugins fire, NPC clicks from ExyliaDisplays and any plugin, firing your own keys, PlaceholderAPI and player settings.

CUSTOM keys from other Exylia plugins

Other Exylia plugins announce what their players do, and ExyliaJourney turns each of those events into a CUSTOM key a step or a trigger can wait for. Nothing needs setting up: when the other plugin is installed its keys start firing; when it is not, they never do.

A key names the plugin, what happened and, where there is one, what it happened to. A step or trigger asking for a key also counts every more specific key under it: exylia:mines:break counts a block broken in any mine, exylia:mines:break:gold only in the mine gold.

Key	Fired for	When
`exylia:mines:break:<mine>`	The player	A block broken in an ExyliaMines mine.
`exylia:crates:open:<crate>`	The player	A crate opened in ExyliaCrates.
`exylia:clans:create`	The player	A clan created.
`exylia:clans:join`	The player	A clan joined.
`exylia:classes:equip:<class>`	The player	An ExyliaClasses class equipped.
`exylia:classes:ability:<class>`	The player	A class ability used.
`exylia:ffa:join:<arena>`	The player	An FFA arena joined to play (not to spectate).
`exylia:ffa:kill:<arena>`	The killer	A kill in an FFA arena.
`exylia:events:join:<event>`	The player	An ExyliaEvents game joined.
`exylia:events:win:<event>`	Each winner	An ExyliaEvents game won.
`exylia:practice:queue:<ranked\|unranked>:<kit>`	The player	A Practice queue joined.
`exylia:practice:match`	Every player of the match	A Practice match finished.
`exylia:practice:win`	Each winner	A Practice match won.
`exylia:survival:kit:<kit>`	The player	A SurvivalCore kit claimed.
`exylia:survival:rankup:<rank>`	The player	Ranked up to that rank.
`exylia:survival:sethome`	The player	A home set.
`exylia:survival:warp:<warp>`	The player	A warp used.
`exylia:survival:bounty`	The killer	A bounty claimed.
`exylia:market:buy:<source>`	The buyer	Something bought on ExyliaMarket.
`exylia:market:sell:<source>`	The seller	Something sold on ExyliaMarket.
`exylia:sandbox:join`	The player	A sandbox world joined.
`exylia:specials:use:<item>`	The player	An ExyliaSpecials item used.
`exylia:specials:duel-win`	The winner	A 1v1 won.
`exylia:totems:save`	The player	A totem saved the player.
`exylia:tabletop:win`	The winner	A tabletop match won.
`exylia:capture:zone`	The capturing player	A zone captured in ExyliaCapture.

A cancelled event fires nothing.

Examples

# a step: open three crates of any kind
objective:
  type: CUSTOM
  key: exylia:crates:open
  amount: 3
 
# a journey that starts the first time a player joins a clan
triggers:
  - type: CUSTOM
    key: exylia:clans:join

Your own keys

Any plugin can fire its own keys through the Exylia API:

ExyliaAPI.get(JourneyService.class).ifPresent(journeys -> journeys.trigger(player, "shop:opened", 1));

and an admin, the console or any plugin that runs console commands, with:

/journeyadmin trigger <player> <key> [amount]

Keys are matched without regard to case. See API.

NPC clicks

Every NPC placed through ExyliaLib counts for INTERACT_NPC objectives and NPC_CLICK triggers, with no setup:

NPC	How to name it
This plugin's own (`npcs:` in `config.yml`; the demo writes one)	Its bare id: `guide`.
ExyliaDisplays' NPCs	Their bare id: `blacksmith`.
Any other plugin's placed NPC	`<plugin>:<id>`.

The editor's NPC field lists every NPC placed on the server to pick from. The NPC a step points at glows for that player alone, and the beacon stands over it.

The older click line [ACTION] exyliajourney:npc %npc% on an ExyliaDisplays NPC still works and is no longer needed; a click it repeats is counted once. /journeyadmin trigger <player> npc:<id> counts as clicking that NPC.

The plugin's own NPCs

npcs: in config.yml places NPCs for journeys to point at, without any other plugin:

npcs:
  guide:
    location: world,0,64,0,90   # world,x,y,z[,yaw[,pitch]]
    skin: Notch                 # a player name, or '' for the default
    glow: '#8A51C4'             # an outline for everybody, or '' for none

They need PacketEvents.

PlaceholderAPI

With PlaceholderAPI the %journey_...% placeholders work in every other plugin, and any PlaceholderAPI placeholder can be used in requirements.condition and in PLACEHOLDER objectives.

Player settings

The four guidance switches are registered with ExyliaLib's /settings under Journey guidance, next to the switches in /journey. See Guidance.

Something missing on this page? Tell us on Discord