### DecentHolograms API Integration Guide
Source: https://wiki.decentholograms.eu/api/get-started
This section details how to add the DecentHolograms plugin as a dependency for your own plugins to leverage its API. It also mentions the requirement of having the DecentHolograms plugin installed on the server for the API to work.
```APIDOC
API Integration:
Purpose: Integrate DecentHolograms API into your plugins.
Dependencies:
- DecentHolograms plugin must be installed on the server.
- Your plugin can optionally declare DecentHolograms as a soft dependency.
Setup:
- Add the DecentHolograms plugin to your server.
- Ensure your plugin can access the DecentHolograms API classes and methods.
Notes:
- The API will not function if the DecentHolograms plugin is not present.
- Latest plugin versions are available on the GitHub Releases page.
```
--------------------------------
### Add CodeMC Repository for NBT-API
Source: https://wiki.decentholograms.eu/api/get-started
If encountering NBT-API errors, add the CodeMC repository to your build file to resolve dependency issues.
```gradle
repositories{
// Other repositories, including jitpack
maven{
id="codemc"
url="https://repo.codemc.io/repository/maven-public/"
}
}
```
```maven
codemc
https://repo.codemc.io/repository/maven-public/
```
--------------------------------
### Add DecentHolograms API Dependency
Source: https://wiki.decentholograms.eu/api/get-started
Configure your build file to include the DecentHolograms API library. This involves adding the Jitpack repository and the dependency artifact.
```gradle
repositories{
maven{
id="jitpack"
url="https://jitpack.io/"
}
}
depencencies{
compileOnly'com.github.decentsoftware-eu:decentholograms:2.9.6'
}
```
```maven
jitpack
https://jitpack.io/
com.github.decentsoftware-eu
decentholograms
2.9.6
provided
```
--------------------------------
### Add DecentHolograms as Soft Plugin Dependency (plugin.yml)
Source: https://wiki.decentholograms.eu/api/get-started
Configure your plugin.yml to declare DecentHolograms as a soft dependency, ensuring it loads before your plugin without preventing startup if DecentHolograms is absent.
```yaml
name:'MyPlugin'
author:'Me'
version:'1.0.0'
main:'com.example.plugin.MyPlugin'
softdepend:
-DecentHolograms
```
--------------------------------
### Add DecentHolograms as Soft Plugin Dependency (paper-plugin.yml)
Source: https://wiki.decentholograms.eu/api/get-started
Configure your paper-plugin.yml to declare DecentHolograms as a soft dependency, ensuring it loads before your plugin without preventing startup if DecentHolograms is absent.
```yaml
name:'MyPlugin'
author:'Me'
version:'1.0.0'
main:'com.example.plugin.MyPlugin'
dependencies:
server:
DecentHolograms:
load:BEFORE
required:false# This is the default when not present
```
--------------------------------
### Hologram Configuration Example
Source: https://wiki.decentholograms.eu/general/configuration/hologram
A sample hologram.yml file demonstrating how to configure hologram properties such as location, display settings, and page content.
```yaml
location:world:0.500:100.0:0.500
enabled:true
display-range:64
update-range:64
update-interval:20
facing:0.0
down-origin:false
pages:
-lines:
-content:"PageLine"
height:0.3
offsetX:0.0
offsetZ:0.0
actions:
RIGHT:
-MESSAGE:You pressed right
SHIFT_RIGHT:
-MESSAGE:You pressed shift-right
LEFT:
-MESSAGE:You pressed left
SHIFT_LEFT:
-MESSAGE:You pressed shift-left
```
--------------------------------
### Add DecentHolograms as Hard Plugin Dependency (paper-plugin.yml)
Source: https://wiki.decentholograms.eu/api/get-started
Configure your paper-plugin.yml to declare DecentHolograms as a hard dependency, requiring it to be present and loaded before your plugin.
```yaml
name:'MyPlugin'
author:'Me'
version:'1.0.0'
main:'com.example.plugin.MyPlugin'
dependencies:
server:
DecentHolograms:
load:BEFORE
required:true
```
--------------------------------
### Add DecentHolograms as Hard Plugin Dependency (plugin.yml)
Source: https://wiki.decentholograms.eu/api/get-started
Configure your plugin.yml to declare DecentHolograms as a hard dependency, requiring it to be present for your plugin to load.
```yaml
name:'MyPlugin'
author:'Me'
version:'1.0.0'
main:'com.example.plugin.MyPlugin'
depend:
-DecentHolograms
```
--------------------------------
### Create Hologram Example
Source: https://wiki.decentholograms.eu/general/setup
Demonstrates the command to create a new hologram. For console execution, a specific world and coordinate argument is required.
```minecraft-command
/dh create example
# For console execution:
# /dh create -l:::: example
```
--------------------------------
### Example Animation File Configuration
Source: https://wiki.decentholograms.eu/general/configuration/animation
An example YAML file demonstrating the structure for configuring custom animations. It includes settings for animation speed, pause duration between runs, and the list of text steps to cycle through.
```yaml
#
# Speed of the animation in ticks.
# Represents the delay between animation steps.
#
# For speed of 2, the animation will wait
# two ticks between each step.
speed:2
#
# Pause of the animation in ticks.
# Represents the delay between animation runs.
#
# For speed of 20, the animation will wait
# 20 ticks between each run.
pause:20
#
# Steps of the animation
#
# List of strings that's going to be cycled
# over during the animation.
#
# You can use '{text}' placeholder, to display
# the text, that is inside this animation
# in the hologram:
# - <#ANIM:example>This text
```
--------------------------------
### Add and Switch Hologram Pages Example
Source: https://wiki.decentholograms.eu/general/setup
Illustrates how to add new pages to an existing hologram and switch to a specific page. This allows for multi-page holographic displays.
```minecraft-command
/dh page add example
/dh page switch example 2
```
--------------------------------
### Setup Hologram Page Navigation Actions
Source: https://wiki.decentholograms.eu/general/setup
Explains how to set up actions for hologram lines to allow players to navigate between pages by interacting with the hologram. Supports NEXT_PAGE and PREV_PAGE actions.
```minecraft-command
/dh page addaction example 1 RIGHT NEXT_PAGE
/dh page addaction example 2 LEFT PREV_PAGE
```
--------------------------------
### General Help Command
Source: https://wiki.decentholograms.eu/general/commands/hologram
Displays help information for the DecentHolograms command system. Use this to get an overview of all available subcommands.
```APIDOC
/dh h help
- Description: Displays help information for the DecentHolograms command system.
- Aliases: hologram, holo, h
- Permission: dh.command.holograms
```
--------------------------------
### Example Hologram with Actions
Source: https://wiki.decentholograms.eu/general/examples/example-actions
Demonstrates how to configure a hologram with interactive actions, such as left-click, right-click, and shift-left-click, triggering messages, console commands, teleports, or permission checks.
```yaml
location:world:0.500:100.000:0.500
enabled:true
display-range:64
update-range:64
update-interval:20
facing:0.0
down-origin:false
pages:
-lines:
-content:'&f&lServerName'
height:0.3
-content:'&fOurserveristhebestintheworld'
height:0.3
-content:'&f(Rightorleftmouseclick)'
height:0.3
actions:LEFT:
-MESSAGE:&fSome text that you just see in minecraft chat when you left click
-CONSOLE:give {player} dirt 5
-TELEPORT:world:10:100:10
RIGHT:
-MESSAGE:&fSome text that you just see in minecraft chat when you right click
-COMMAND:plugins
-SOUND:BLOCK_GLASS_BREAK
SHIFT_LEFT:
-PERMISSION:some.permission.use
-MESSAGE:&fCongratulations, you have enough permissions after left click with shift.
```
--------------------------------
### Convert Holograms Command
Source: https://wiki.decentholograms.eu/general/commands/general
Converts holograms from another hologram plugin to DecentHolograms format. The source plugin does not need to be installed on the server, only its files.
```APIDOC
/dh[file]
- Converts holograms from a specified plugin.
- Parameters:
- : The Hologram plugin to convert from. Refer to the compatibility page for a list.
- [file]: Optional. Location of the file to convert. Only needed if the file is not in the default location for the source plugin.
- Permission: dh.command.convert
```
--------------------------------
### Edit Hologram Lines Example
Source: https://wiki.decentholograms.eu/general/setup
Shows how to set the text for a specific line of a hologram and add new lines. Supports color codes and formatting.
```minecraft-command
/dh line set example 1 &3&lDECENT HOLOGRAMS
/dh line add example 1 &fHolograms plugin
```
--------------------------------
### Example - Entity Hologram Configuration
Source: https://wiki.decentholograms.eu/general/examples/example-entity
This YAML file demonstrates the configuration for an entity-based hologram in DecentHolograms. It defines the hologram's position, visibility settings, and the content of its lines, including placeholders for entity-specific data like level and health.
```yml
location:world:0.500:100.000:0.500
enabled:true
display-range:64
update-range:64
update-interval:20
facing:0.0
down-origin:true
pages:
-lines:
-content:'&b&lLEVELLEDMOBS'
height:0.3
-content:'&f'
height:0.3
-content:'&fOnsurvival,eachmobhasadifferent'
height:0.3
-content:'&flevelandnumberoflives'
height:0.6
-content:'&8&l༺E76BLvl1&8|&fSpider&8|&f24&8/&f24E76B♥&8&l༻'
height:0.3
-content:'#ENTITY:SPIDER'
height:0.3
actions:{}
```
--------------------------------
### Decent Holograms Demo Configuration
Source: https://wiki.decentholograms.eu/general/examples/example-demo
This YAML configuration defines a demo hologram with multiple pages, showcasing various line types including text with formatting, entity displays, player heads, icons, and animations. It also includes interactive actions like page navigation via left and right clicks.
```YAML
location:world:0.500:100.000:0.500
enabled:true
display-range:64
update-range:64
update-interval:20
facing:0.0
down-origin:true
pages:
-lines:
-content:<#B22AFE>&l&nDECENT HOLOGRAMS#ff8157>
height:0.3
-content:Very powerful hologram plugin and API
height:0.6
-content:'&a✔<#b9ff28>RGBSupport'
height:0.3
offsetX:1.03
-content:'&a✔RainbowText'
height:0.3
offsetX:1.01
-content:'&a✔CustomAnimations'
height:0.3
offsetX:0.71
-content:'&a✔&bManyUsefulCommands'
height:0.3
offsetX:0.42
-content:'&a✔&bPlaceholderAPISupport'
height:0.3
offsetX:0.33
-content:'&a✔&bCustomizableheightforeachline'
height:0.3
offsetX:-0.26
-content:'&a✔&bCustomizableOffsetsforeachline'
height:0.3
offsetX:-0.36
-content:'&a✔&bPermissionsforHolograms&Lines'
height:0.3
offsetX:-0.33
-content:'&a✔&bDisplay&Updatedistance'
height:0.3
offsetX:0.23
-content:'&a✔&bDamageDisplayFeature'
height:0.3
offsetX:0.36
-content:'&a✔&bHealDisplayFeature'
height:0.6
offsetX:0.57
-content:<#B22AFE><- Left Click | Right Click >#ff8157>
height:0.3
actions:
RIGHT:
-NEXT_PAGE
-lines:
-content:<#B22AFE>&l&nDECENT HOLOGRAMS#ff8157>
height:0.3
-content:'&fMultipledifferentlinetypes'
height:0.4
-content:'#ENTITY:GUARDIAN'
height:1.5
-content:'#HEAD:PLAYER_HEAD(d0by)'
height:0.75
-content:'#SMALLHEAD:PLAYER_HEAD(Venty_)'
height:0.6
-content:'#ICON:GRASS_BLOCK'
height:0.6
-content:<#B22AFE><- Left Click | Right Click >#ff8157>
height:0.3
actions:
LEFT:
-PREV_PAGE
RIGHT:
-NEXT_PAGE
-lines:
-content:<#B22AFE>&l&nDECENT HOLOGRAMS#ff8157>
height:0.3
-content:'&fAnimations?Iguess..'
height:0.6
-content:'<#ANIM:wave:&f,&b&n>WaveAnimation#ANIM>'
height:0.3
-content:'<#ANIM:burn:&f,&b&n>BurnAnimation#ANIM>'
height:0.3
-content:'<#ANIM:typewriter>TypewriterAnimation#ANIM>'
height:0.3
-content:'<#ANIM:scroll>ScrollAnimation#ANIM>'
height:0.3
-content:'&uColorsAnimation'
height:0.3
-content:'<#ANIM:example>CustomAnimation#ANIM>'
height:0.6
-content:<#B22AFE><- Left Click | Right Click >#ff8157>
height:0.3
actions:
LEFT:
-PREV_PAGE
```
--------------------------------
### DecentHolograms Burn Animation
Source: https://wiki.decentholograms.eu/general/animations
Applies a 'burn' animation that colors the text in `` and transitions it to `` from left to right. An example shows its usage with color codes.
```custom-markup
<#ANIM:burn:,>Text#ANIM>
```
```custom-markup
<#ANIM:burn:&f,&b&l>Text#ANIM>
```
--------------------------------
### DecentHolograms Wave Animation
Source: https://wiki.decentholograms.eu/general/animations
Applies a 'wave' animation. It colors the text with `` and makes `` move through the text. An example demonstrates using color codes.
```custom-markup
<#ANIM:wave:,>Text#ANIM>
```
```custom-markup
<#ANIM:wave:&f,&b&l>Text#ANIM>
```
--------------------------------
### Get Hologram Instance
Source: https://wiki.decentholograms.eu/api/basic-usage/dhapi
Retrieves a Hologram instance by its unique name. Returns null if no hologram with the given name exists.
```APIDOC
DHAPI.getHologram(String name);
```
--------------------------------
### Show Help Command
Source: https://wiki.decentholograms.eu/general/commands/general
Displays a list of available subcommands for the DecentHolograms plugin. This is the primary command to discover other functionalities.
```APIDOC
/dh help
- Lists all available subcommands for the DecentHolograms plugin.
```
--------------------------------
### Get Hologram Line
Source: https://wiki.decentholograms.eu/api/basic-usage/dhapi
Retrieves a specific line from a HologramPage using a 0-indexed line position. Requires a valid HologramPage instance.
```APIDOC
DHAPI.getHologramLine(HologramPage hologramPage, int lineIndex);
```
--------------------------------
### List All Subcommands
Source: https://wiki.decentholograms.eu/general/commands/features
Executes the help command to display a list of all available subcommands for the DecentHolograms feature manager.
```bash
/dh f help
```
--------------------------------
### DecentHolograms Command Help Overview
Source: https://wiki.decentholograms.eu/general/commands
Provides general help for the DecentHolograms plugin. This command lists the main command categories and subcommands available, aiding users in navigating the plugin's functionality.
```APIDOC
/dh help
- Displays general help for DecentHolograms.
```
--------------------------------
### DecentHolograms Hologram Command Help
Source: https://wiki.decentholograms.eu/general/commands
Access help specific to managing holograms within the DecentHolograms plugin. This command provides details on creating, modifying, and managing holographic displays.
```APIDOC
/dh holograms help
- Displays help for hologram-related commands.
```
--------------------------------
### Gradient Text
Source: https://wiki.decentholograms.eu/general/format-and-colors/colors
Allows creating gradient effects by specifying a start and end color for a block of text. Formatting codes can be used within gradients. The syntax is <#startcolor>text#endcolor>.
```text
<#FF0000>Gradient!#00FF00>
```
--------------------------------
### List Holograms Command
Source: https://wiki.decentholograms.eu/general/commands/general
Lists all holograms loaded from a specific hologram file. This command allows navigation through paginated lists of holograms.
```APIDOC
/dh[page]
- Lists all holograms loaded from a hologram file.
- Parameters:
- [page]: Optional. The page number in the list to navigate to.
- Permission: dh.command.list
```
--------------------------------
### Basic Color and Formatting Codes
Source: https://wiki.decentholograms.eu/general/format-and-colors/colors
DecentHolograms supports basic color and formatting using the '&' character followed by a code. For example, '&1' applies dark blue color, and '&l' applies bold formatting.
```text
&1
&l
```
--------------------------------
### Get Hologram Page
Source: https://wiki.decentholograms.eu/api/basic-usage/dhapi
Obtains a HologramPage instance from a Hologram using a 0-indexed page index. Returns null if the index is out of bounds (less than 0 or greater than or equal to the number of pages).
```APIDOC
DHAPI.getHologramPage(Hologram hologram, int pageIndex);
```
--------------------------------
### DecentHolograms Feature Commands Help
Source: https://wiki.decentholograms.eu/general/configuration/features
Provides instructions on how to view all available commands for features within the DecentHolograms plugin. This is the primary method to discover and understand feature-specific commands.
```APIDOC
Command:
/dh features help
Description:
Displays a list of all available commands related to the 'features' module in DecentHolograms. This command is used to get help and discover the functionality provided by the features system.
Parameters:
None
Returns:
A list of feature-related commands and their brief descriptions.
Usage Example:
Execute '/dh features help' in the game console or chat to see the available commands.
```
--------------------------------
### Configure Tree Hologram with Player Heads
Source: https://wiki.decentholograms.eu/general/examples/example-tree
This YAML configuration defines a hologram structured like a tree. It specifies the hologram's world location, display properties, and a list of pages, each containing lines composed of player head elements with defined heights and offsets.
```yaml
location:world:0.500:100.000:0.500
enabled:true
display-range:64
update-range:64
update-interval:20
facing:0.0
down-origin:true
pages:
-lines:
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMzc5NWVkZWViNmI3ZWQ0MWMyNjhjZWZlYWZiZTk2MGI3YzQ5NTUwZGFlYjYzMWI1NjE1NmJmNWZlYjk4NDcifX19=)'
height:0.61
offsetX:0.1
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMzc5NWVkZWViNmI3ZWQ0MWMyNjhjZWZlYWZiZTk2MGI3YzQ5NTUwZGFlYjYzMWI1NjE1NmJmNWZlYjk4NDcifX19=)'
height:0.0
offsetX:0.7
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMzc5NWVkZWViNmI3ZWQ0MWMyNjhjZWZlYWZiZTk2MGI3YzQ5NTUwZGFlYjYzMWI1NjE1NmJmNWZlYjk4NDcifX19=)'
height:0.0
offsetX:-0.5
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMzc5NWVkZWViNmI3ZWQ0MWMyNjhjZWZlYWZiZTk2MGI3YzQ5NTUwZGFlYjYzMWI1NjE1NmJmNWZlYjk4NDcifX19=)'
height:0.0
offsetZ:0.65
offsetX:0.1
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMzc5NWVkZWViNmI3ZWQ0MWMyNjhjZWZlYWZiZTk2MGI3YzQ5NTUwZGFlYjYzMWI1NjE1NmJmNWZlYjk4NDcifX19=)'
height:0.0
offsetZ:-0.6
offsetX:0.1
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMzc5NWVkZWViNmI3ZWQ0MWMyNjhjZWZlYWZiZTk2MGI3YzQ5NTUwZGFlYjYzMWI1NjE1NmJmNWZlYjk4NDcifX19=)'
height:0.61
offsetX:0.1
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDI3ZWVhYjZiMDFjNjFjODBiNDQ0OWEwNWU5MmQzNWNiMDVkMzM2NTQ0YzljYmFmNDhjMTYxNGU4NDkyMCJ9fX0=)'
height:0.61
offsetX:0.1
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDI3ZWVhYjZiMDFjNjFjODBiNDQ0OWEwNWU5MmQzNWNiMDVkMzM2NTQ0YzljYmFmNDhjMTYxNGU4NDkyMCJ9fX0=)'
height:0.61
offsetX:0.1
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMmNkYzBmZWI3MDAxZTJjMTBmZDUwNjZlNTAxYjg3ZTNkNjQ3OTMwOTJiODVhNTBjODU2ZDk2MmY4YmU5MmM3OCJ9fX0=)'
height:0.0
offsetX:0.7
-content:'#HEAD:PLAYER_HEAD(eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDI3ZWVhYjZiMDFjNjFjODBiNDQ0OWEwNWU5MmQzNWNiMDVkMzM2NTQ0YzljYmFmNDhjMTYxNGU4NDkyMCJ9fX0=)'
height:0.0
offsetX:0.1
actions:{}
```
--------------------------------
### RGB Color Formats
Source: https://wiki.decentholograms.eu/general/format-and-colors/colors
Supports multiple hexadecimal formats for RGB colors, starting from version 1.16. The format is RR (red), GG (green), BB (blue). Supported formats include #RRGGBB, RRGGBB, <#RRGGBB>, and {#RRGGBB}.
```text
#RRGGBB
RRGGBB
<#RRGGBB>
{#RRGGBB}
```
--------------------------------
### Minecraft Recipe Hologram Configuration (YAML)
Source: https://wiki.decentholograms.eu/general/examples/example-recipe-with-offsets
This YAML file defines a hologram designed to showcase a Minecraft crafting recipe. It specifies the hologram's world location, rendering parameters like display range and update interval, and meticulously lists the content for each line, including text and specific item representations like player heads with custom textures.
```yaml
location:world:0.500:100.000:0.500
enabled:true
display-range:64
update-range:64
update-interval:20
facing:0.0
down-origin:true
pages:
-lines:
-content:'&b&lINVISIBLEITEMFRAMES'
height:0.3
offsetX:1.74
-content:'&f'
height:0.3
offsetX:1.74
-content:'&fWanttomakeaninvisibleitemframe?'
height:0.3
offsetX:1.74
-content:'&fHereisasample:'
height:0.3
offsetX:1.74
-content:''
height:0.9
offsetX:1.74
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:0.74
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:1.74
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:2.74
-content:''
height:0.9
-content:'#SMALLHEAD:player_head{SkullOwner:{Id:[I;2045853103,1216626859,-1909090844,1917203233],Properties:{textures:[{Value:"eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjgyYWQxYjljYjRkZDIxMjU5YzBkNzVhYTMxNWZmMzg5YzNjZWY3NTJiZTM5NDkzMzgxNjRiYWM4NGE5NmUifX19"}]}}}'
height:0.0
offsetX:3.74
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:0.74
-content:'#HEAD:SEA_PICKLE'
height:0.0
offsetX:1.74
-content:'#HEAD:ITEM_FRAME!ENCHANTED'
height:0.0
offsetX:4.74
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:2.74
-content:''
height:0.9
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:0.74
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:1.74
-content:'#HEAD:ITEM_FRAME'
height:0.0
offsetX:2.74
actions:{}
```
--------------------------------
### Version/About Command
Source: https://wiki.decentholograms.eu/general/commands/general
Displays information about the current version of the DecentHolograms plugin. It also includes aliases for convenience.
```APIDOC
/dh
- Shows information about the current DecentHolograms version.
- Aliases: about, ver
- Permission: dh.command.version
```
--------------------------------
### Hologram Pages and Lines Configuration
Source: https://wiki.decentholograms.eu/general/configuration/hologram
Details the structure for defining multiple pages and the content, layout, and positioning of individual lines within each page.
```APIDOC
Hologram Pages & Lines:
pages:
Type: List of objects
Description: Contains the individual pages a hologram can have.
Each page can have multiple lines and actions.
pages[*].lines:
Type: List of objects
Description: Contains the individual lines for a specific page.
pages[*].lines[*].content:
Type: String
Description: The text or identifier for the hologram line. Supports special formatting and colors.
pages[*].lines[*].height:
Type: Float
Description: Sets the vertical spacing between this line and others. Defaults vary by line type (text, #ICON, #HEAD, #SMALLHEAD).
pages[*].lines[*].offsetX:
Type: Float
Description: Horizontal offset for the line along the X-axis, relative to the hologram's center. Range: -2.5 to 2.5.
pages[*].lines[*].offsetZ:
Type: Float
Description: Horizontal offset for the line along the Z-axis, relative to the hologram's center. Range: -2.5 to 2.5.
pages[*].actions:
Type: Map
Description: Defines actions triggered by player input (e.g., RIGHT, LEFT) for this page.
Example:
RIGHT:
- MESSAGE: "You pressed right"
```
--------------------------------
### DecentHolograms General Commands
Source: https://wiki.decentholograms.eu/general/commands/general
Provides an overview of the general commands available in the DecentHolograms plugin. These commands are used for managing plugin operations, converting files, listing items, and checking the version.
```APIDOC
DecentHolograms General Commands:
/dh convert [file]
- Description: Converts hologram files from one plugin's format to another. If no file is specified, it attempts to convert all files in the default directory.
- Parameters:
- plugin: The target plugin format to convert to (e.g., 'holographicdisplays').
- [file]: Optional. The specific file to convert. If omitted, all files in the default directory are processed.
- Usage Example: /dh convert holographicdisplays myholograms.yml
/dh list [page]
- Description: Lists all holograms managed by the plugin. Supports pagination to navigate through a large number of holograms.
- Parameters:
- [page]: Optional. The page number to display. Defaults to the first page if not provided.
- Usage Example: /dh list 5
/dh reload
- Description: Reloads the plugin's configuration files and data. This is useful after making changes to configuration files without restarting the server.
- Parameters: None
- Usage Example: /dh reload
/dh version
- Description: Displays the current version of the DecentHolograms plugin and checks for available updates.
- Parameters: None
- Usage Example: /dh version
```
--------------------------------
### Basic Text Formatting
Source: https://wiki.decentholograms.eu/general/format-and-colors
Demonstrates the default text line type and how to apply color and style codes. These codes are specific to the DecentHolograms plugin for in-game text rendering.
```DecentHolograms Syntax
```
```DecentHolograms Syntax
&aThis&f&lText&a!
```
--------------------------------
### Convert HolographicDisplays to DecentHolograms
Source: https://wiki.decentholograms.eu/general/compatibility
This command converts holograms from the HolographicDisplays plugin to DecentHolograms format. It uses the `database.yml` file from HolographicDisplays. Placeholders and special tags are converted.
```APIDOC
Hologram Conversion - HolographicDisplays:
Command: /dh convert HolographicDisplays
Description: Converts holograms from the HolographicDisplays plugin to DecentHolograms.
Dependencies:
- HolographicDisplays plugin (only its database files are needed).
Input:
Default File Location: plugins/HolographicDisplays/database.yml
Special Actions Conversion:
- ICON:- -> #ICON:
-
- {papi: } -> %%
- {empty} -> Creates an empty line using a color code.
```