Holograms

This feature can be activated by installing any of the following hologram plugins:

Plugin	Required Version	Additional Dependencies
DecentHolograms	2.7.5 or above	PlaceholderAPI for in-line placeholders.
Holographic Displays	3.0.0 or above	None

If you have both plugins installed, you can use the hologram.default option in the "config.yml" to set which plugin should be used.

NPC Holograms

Example

npc_holograms: #(7)!
  myHologram: #(8)!
    lines: #(1)!
      - "Some text!" 
    vector: 0;0.5;0 #(2)!
    follow: true #(3)!
    conditions: has_some_quest,!finished_some_quest #(4)!
    check_interval: 20 #(5)!
    npcs: Mayor,Guard #(6)!
    max_range: 40 #(9)!

1. The lines of the hologram.
2. A vector that points from the Npc's location to the hologram's location. Can be used to configure an offset. Optional.
3. If the hologram follows the Npc. Optional, defaults to false.
4. Conditions that must be true for the hologram to display.
5. How often the conditions are checked. Optional.
6. A list of NpcIDs that the hologram is attached to.
7. The section that all holograms must be placed in.
8. The identifier of the hologram. Must be unique.
9. Maximum hologram display distance. Optional.

If you have moving NPCs (walking around) then you can have the holograms follow them by setting follow: true, but this will cause a lot of updates to the holograms and may cause lag if used on a lot of Npcs. So only set this to true for holograms with a Npc that actually moves. Also, not every Npc supports that feature.

Hidden Holograms

Installing either of these plugins will enable you to create hidden holograms, which will be shown to players only if they meet specified conditions.

In order to create a hologram, you have to add a holograms section. Add a node named as your hologram to this section and define lines, conditions and location subnodes. The first one should be a list of texts - these will be the lines of a hologram. Color codes are supported. Second is a list of conditions separated by commas. Third is a location in a standard format, like in teleport action. If max_range is specified, the hologram will only be visible in this range, if not, the default value from the connected hologram plugin will be used. An example of such hologram definition:

holograms:
  beton:
    lines:
    - 'item:custom_item'
    - '&2Top questers this month'
    - 'top:completed_quests;desc;10;§a{place}. §6{name}§2 - §6{score}'
    - '&2Your amount: &6%point.completed_quests.amount%'
    - '&Total amount: &6%azerothquests>globalpoint.total_completed_quests.amount%'
    conditions: has_some_quest,!finished_some_quest    
    location: 100;200;300;world
    # How often to check conditions (optional)
    check_interval: 20
    # Maximum hologram display distance (optional)
    max_range: 40

Item Lines

A line can also represent a floating item. To do so enter the line as 'item:custom_item'. It will be replaced with the custom_item defined in the items section. If the Item is defined for example as map, a floating map will be seen between two lines of text.

Ranking Holograms

Holograms created by BetonQuest can rank users by the score of a point. Such scoreboards (not to be confused with the Minecraft vanilla scoreboard) are configured as one line and replaced by multiple lines according to the limit definition.

A top line is defined with 'top:point;order;limit;<formattingString>'. point is just a point from a package. The order is either 'desc' for descending or 'asc' for ascending. The limit is just the number of entries to show. You can freely define the formatting of the displayed hologram and even omit the placeholders for place, player or score.

Example

honorRank:
  lines:
    - Most honorable players!
    - top:honor;DESC;10;{place}. {name} - {score}
  location: 100;198;300;world
colorfulHonorRank:
  lines:
    - Most <gold>honorable</gold> players!
    - top:honor;DESC;10;<light_purple>{name}</light_purple> has <dark_green>{score}</dark_green> 
      points on the <yellow>{place}.</yellow> place!
  location: 100;202;300;world

Gradients

Placeholders remain unresolved if formatting such as gradient or rainbow is used.

Each BetonQuest placeholder can be displayed on a hologram in a text line. If you wish to refer to a placeholder that is not in the same package as the hologram, then you must specify a package before the placeholder.

HolographicDisplays: Potential lags

The HolographicDisplays documentation warns against using too many individual hologram placeholders since they are rendered for each player individually. If you are using HolographicDisplays to save resources, it is recommended to minimize the use of non-static placeholders.

The hologram's conditions are checked every 10 seconds, meaning a hologram will respond to a condition being met or unmet every 10 seconds. If you want to make it faster, decrease hologram.update_interval option in "config.yml" file and set it to a number of ticks you want to pass between updates (one second is 20 ticks). Don't set it to 0 or negative numbers, it will result in an error.

Keep in mind that each hologram plugin also updates its holograms on a timer individually, meaning that hologram placeholders will refresh at a much quicker rate than the above.