# 💭 Holograms

Besides the hologram that sits above an npc, you can also create holograms on their own. They are drawn by the same [hologram engine](#hologram-engine) as the npc holograms, so no external hologram plugin is needed.

Stand where you want it and click **Add Hologram** in **Editor > Holograms**. The hologram is created at your current location and is added to the list right away.

<figure><img src="../../.gitbook/assets/holograms/add-hologram.png" alt="" width="563"><figcaption><p>Holograms (Add Hologram)</p></figcaption></figure>

Once it exists, left-click it in the list to open its editor. The options are split into [Edit Hologram](#edit-hologram) and [Customize Hologram](#customize-hologram).

## Hologram Engine

Shared by every hologram, npc holograms included, and set in **Editor > Settings**. Switching it redraws every hologram and npc right away.

| Engine | Description |
| --- | --- |
| Built-in | The default, needs no other plugin |
| PhoenixHolograms | Hands the drawing to PhoenixHolograms, selectable only while it is installed |

With PhoenixHolograms, the lines, scale, background color and actions carry over; line gap, billboard, text opacity, see through and shadow use the PhoenixHolograms defaults. If PhoenixHolograms is removed, the plugin falls back to Built-in and logs a warning.

> **Info:**
Each hologram is saved in its own file inside the **holograms** folder of the PhoenixLobby folder.

## Edit Hologram

### Change Identifier

With this option, you can rename the identifier of the hologram. The identifier is used internally by the plugin and has to be unique, so no two holograms can share the same one. It is not shown to players.

<figure><img src="../../.gitbook/assets/holograms/change-identifier.png" alt="" width="563"><figcaption><p>Edit Hologram (Change Identifier)</p></figcaption></figure>

### Display

With this option, you can change the item and the name used for the hologram inside the editor. This only affects how the hologram is listed in the menu, it does not change anything players see in the world.

<figure><img src="../../.gitbook/assets/holograms/display.png" alt="" width="563"><figcaption><p>Edit Hologram (Display)</p></figcaption></figure>

### Hologram Lines

With this option, you can configure the text of the hologram. Every entry is its own line, and empty entries can be used to leave a gap between two lines.

<figure><img src="../../.gitbook/assets/holograms/hologram-lines.png" alt="" width="563"><figcaption><p>Edit Hologram (Hologram Lines)</p></figcaption></figure>

### Hologram Location

With this option, you can move the hologram to the position you are standing at. The tooltip shows the world, the coordinates, and the yaw and pitch it is currently using.

<figure><img src="../../.gitbook/assets/holograms/hologram-location.png" alt="" width="563"><figcaption><p>Edit Hologram (Hologram Location)</p></figcaption></figure>

### Actions

With this option, you can set the actions that are executed when a player clicks the hologram. The same action types used by npcs and hotbar items are available here.

<figure><img src="../../.gitbook/assets/holograms/actions.png" alt="" width="563"><figcaption><p>Edit Hologram (Actions)</p></figcaption></figure>

### Toggle State

With this option, you can disable a hologram without removing it. A disabled hologram stays saved with all of its options but does not appear in the world.

<figure><img src="../../.gitbook/assets/holograms/toggle-state.png" alt="" width="563"><figcaption><p>Edit Hologram (Toggle State)</p></figcaption></figure>

### Clone Hologram

With this option, you can duplicate the hologram under a new identifier. The copy keeps every option of the original, which is useful when you want several holograms sharing the same style.

<figure><img src="../../.gitbook/assets/holograms/clone-hologram.png" alt="" width="563"><figcaption><p>Edit Hologram (Clone Hologram)</p></figcaption></figure>

### Delete Hologram

With this option, you can remove the hologram from the server.

> **Danger:**
Deleting a hologram cannot be undone. Use **Toggle State** instead if you only want to hide it for a while.

<figure><img src="../../.gitbook/assets/holograms/delete-hologram.png" alt="" width="563"><figcaption><p>Edit Hologram (Delete Hologram)</p></figcaption></figure>

## Customize Hologram

### Height Offset

With this option, you can raise or lower the hologram from its base position, which is useful for lining it up with a block or a decoration.

<figure><img src="../../.gitbook/assets/holograms/height-offset.png" alt="" width="563"><figcaption><p>Customize Hologram (Height Offset)</p></figcaption></figure>

### Line Gap

With this option, you can change the spacing between each hologram line. The default is 0.3, a lower value pulls the lines closer together and a higher value spreads them apart.

<figure><img src="../../.gitbook/assets/holograms/line-gap.png" alt="" width="563"><figcaption><p>Customize Hologram (Line Gap)</p></figcaption></figure>

### Billboard

With this option, you can change how the hologram faces players. Four modes are available:

* **Fixed:** The hologram does not rotate at all
* **Vertical:** The hologram rotates around the vertical axis only
* **Horizontal:** The hologram rotates around the horizontal axis only
* **Center:** The hologram always faces the player

<figure><img src="../../.gitbook/assets/holograms/billboard.png" alt="" width="563"><figcaption><p>Customize Hologram (Billboard)</p></figcaption></figure>

### Hologram Scale

With this option, you can change the size of the hologram. The default is 1.

<figure><img src="../../.gitbook/assets/holograms/hologram-scale.png" alt="" width="563"><figcaption><p>Customize Hologram (Hologram Scale)</p></figcaption></figure>

### Text Opacity

With this option, you can change how solid the hologram text is. The value goes up to 255, which is fully solid, and lower values make the text more transparent.

<figure><img src="../../.gitbook/assets/holograms/text-opacity.png" alt="" width="563"><figcaption><p>Customize Hologram (Text Opacity)</p></figcaption></figure>

### See Through

With this option, you can define whether the hologram is visible through blocks. When it is disabled, the hologram is hidden as soon as a block is between it and the player.

<figure><img src="../../.gitbook/assets/holograms/see-through.png" alt="" width="563"><figcaption><p>Customize Hologram (See Through)</p></figcaption></figure>

### Shadow

With this option, you can define whether the hologram casts a text shadow, which helps the text stay readable against a bright background.

<figure><img src="../../.gitbook/assets/holograms/shadow.png" alt="" width="563"><figcaption><p>Customize Hologram (Shadow)</p></figcaption></figure>

### Background Color

With this option, you can change the color of the panel behind the text. It accepts either an a,r,g,b value or a #AARRGGBB hex code, where the first part is the transparency. The default is 0,0,0,0, which leaves the background fully transparent.

<figure><img src="../../.gitbook/assets/holograms/background-color.png" alt="" width="563"><figcaption><p>Customize Hologram (Background Color)</p></figcaption></figure>

Source: https://www.phoenixplugins.com/docs/phoenix-lobby/featues/holograms