diff --git a/docs/assets/stylesheets/theme.css b/docs/assets/stylesheets/theme.css index d460bd9..51a7a08 100644 --- a/docs/assets/stylesheets/theme.css +++ b/docs/assets/stylesheets/theme.css @@ -41,3 +41,11 @@ white-space: nowrap; display: block; } + +.md-icon-color--success { + color: #00c853; +} + +.md-icon-color--warning { + color: #ff9100; +} \ No newline at end of file diff --git a/docs/general/actions.md b/docs/general/actions.md index 1d0b8ca..9a715db 100644 --- a/docs/general/actions.md +++ b/docs/general/actions.md @@ -7,17 +7,6 @@ icon: material/mouse DecentHolograms allows you to add click-actions to individual hologram pages that get executed when the player either left or right-clicks the hologram. -## Format - -Actions themself are in the following formats: - -> ```command -> -> : -> ``` - -Note that you don't have to include the `<>` brackets! - ## Click Types These click types are used in the [`addaction` page command](commands/hologram-pages.md#dh-p-addaction) to add the action for a specific click type. @@ -29,72 +18,91 @@ These click types are used in the [`addaction` page command](commands/hologram-p ## Action Types +The following action types are available to use. + ### `#!command MESSAGE:` { #message } -> Sends a message to the player who clicked the hologram. -> -> - `#!command ` - The message to send. Supports Placeholders, including PlaceholderAPI. +: Sends a message to the player who clicked the hologram. + + - `#!command ` - The message to send. Supports Placeholders, including PlaceholderAPI. + +---- ### `#!command COMMAND:` { #command } -> Executes a command as the player who clicked the hologram. Should the specified command not start with a `/` will it instead be send as a message by the player. -> -> - `#!command ` - The command to execute as the player. Supports Placeholders, including PlaceholderAPI. +: Executes a command as the player who clicked the hologram. Should the specified command not start with a `/` will it instead be send as a message by the player. + + - `#!command ` - The command to execute as the player. Supports Placeholders, including PlaceholderAPI. + +---- ### `#!command CONSOLE:` { #console } -> /// warning | Important -> Commands only available through a proxy cannot be executed by this Action. -> /// -> -> Executes the specified command through the console. -> -> - `#!command ` - The command to execute as the console. Supports Placeholders, including PlaceholderAPI. +: /// warning | Proxy commands cannot be executed by this action! + /// + + Executes the specified command through the console. + + - `#!command ` - The command to execute as the console. Supports Placeholders, including PlaceholderAPI. + +---- ### `#!command CONNECT:` { #connect } -> Sends the player who clicked the hologram to the specified Server. This action only works with Servers connected to a BungeeCord/Velocity proxy. -> -> - `#!command ` - Name of the server the player should be connected to. +: Sends the player who clicked the hologram to the specified Server. This action only works with Servers connected to a BungeeCord/Velocity proxy. + + - `#!command ` - Name of the server the player should be connected to. + +---- ### `#!command TELEPORT::::` / `#!command TELEPORT:::` { #teleport } -> Teleports the player who clicked the hologram to the specified coordinates, and optionally world. -> -> - `#!command ` - Optional world to teleport the player to. Defaults to the World the player is in, if not specified. -> - `#!command ` - X coordinate to teleport the player to. -> - `#!command ` - Y coordinate to teleport the player to. -> - `#!command ` - Z coordinate to teleport the player to. +: Teleports the player who clicked the hologram to the specified coordinates, and optionally world. + + - `#!command ` - Optional world to teleport the player to. Defaults to the World the player is in, if not specified. + - `#!command ` - X coordinate to teleport the player to. + - `#!command ` - Y coordinate to teleport the player to. + - `#!command ` - Z coordinate to teleport the player to. + +---- ### `#!command SOUND:::` / `#!command SOUND:` { #sound } -> Plays the specified sound, optionally with a set volume and pitch, to the player who clicked the Hologram. -> -> - `#!command ` - Name of the sound to play. A list of available sounds is found [here](https://docs.andre601.ch/Spigot-Sounds){ target="_blank" rel="nofollow" } -> - `#!command ` - Optional volume to set. Default if not set is `1.0`. -> - `#!command ` - Optional pitch to set. Default if not set is `1.0`. +: Plays the specified sound, optionally with a set volume and pitch, to the player who clicked the Hologram. + + - `#!command ` - Name of the sound to play. A list of available sounds is found [here](https://docs.andre601.ch/Spigot-Sounds){ target="_blank" rel="nofollow" } + - `#!command ` - Optional volume to set. Default if not set is `1.0`. + - `#!command ` - Optional pitch to set. Default if not set is `1.0`. + +---- ### `#!command PERMISSION:` { #permission } -> Checks whether the player who clicked the Hologram has the specified permission. Unlike other actions does this one act differently by stopping any actions after it from executing, should the player not have the permission. -> -> - `#!command ` - The permission to check. +: Checks whether the player who clicked the Hologram has the specified permission. Unlike other actions does this one act differently by stopping any actions after it from executing, should the player not have the permission. + + - `#!command ` - The permission to check. + +---- ### `#!command NEXT_PAGE:` / `NEXT_PAGE` { #next_page } -> Changes the page of the (optionally specified) Hologram to the next one, if one is available. -> -> - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. +: Changes the page of the (optionally specified) Hologram to the next one, if one is available. + + - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. + +---- ### `#!command PREV_PAGE:` / `PREV_PAGE` { #prev_page } -> Changes the page of the (optionally specified) Hologram to the previous page, if one is available. -> -> - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. +: Changes the page of the (optionally specified) Hologram to the previous page, if one is available. + + - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. + +---- ### `#!command PAGE::` / `#!command PAGE:` { #page } -> Changes to the specified page on the (optionally specified) Hologram, if one is available. -> -> - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. -> - `#!command ` - Page to switch to on the Hologram. +: Changes to the specified page on the (optionally specified) Hologram, if one is available. + + - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. + - `#!command ` - Page to switch to on the Hologram. diff --git a/docs/general/animations.md b/docs/general/animations.md index 50026ba..b19680f 100644 --- a/docs/general/animations.md +++ b/docs/general/animations.md @@ -11,10 +11,11 @@ Custom animations can be configured in files and the process of doing so is expl ## Format -> ```command -> <#ANIM:>Text -> <#ANIM::>Text -> ``` +: + ```command + <#ANIM:>Text + <#ANIM::>Text + ``` /// note To use placeholders inside animations you need to enable `allow-placeholders-inside-animations` in the [`config.yml`](configuration/config.md). @@ -26,44 +27,47 @@ There are some premade animations you can use, that will work with any text. ### Colors -> ```command -> <#ANIM:colors>Text -> OR -> &uText -> ``` +: Switches through all available color codes. This is the same as in HolographicDisplays and also offers the `&u` as an alternative color code to use. + ```command + <#ANIM:colors>Text + ``` ### Wave -> ```command -> <#ANIM:wave:,>Text -> ``` - -/// example -```command -<#ANIM:wave:&f,&b&l>Text -``` -/// +: Colors the text in `#!command ` and makes `#!command ` move through the text. + ```command + <#ANIM:wave:,>Text + ``` + + /// example + ```command + <#ANIM:wave:&f,&b&l>Text + ``` + /// ### Burn -> ```command -> <#ANIM:burn:,>Text -> ``` - -/// example -```command -<#ANIM:burn:&f,&b&l>Text -``` -/// +: Colors the text in `#!command ` and changes it to `#!command ` from left to right. + ```command + <#ANIM:burn:,>Text + ``` + + /// example + ```command + <#ANIM:burn:&f,&b&l>Text + ``` + /// ### Typewriter -> ```command -> <#ANIM:typewriter>Text -> ``` +: Writes the provided text one character at a time. + ```command + <#ANIM:typewriter>Text + ``` ### Scroll -> ```command -> <#ANIM:scroll>Text -> ``` \ No newline at end of file +: Scrolls through the provided text. The length is set to ` / 3 * 2`. + ```command + <#ANIM:scroll>Text + ``` \ No newline at end of file diff --git a/docs/general/commands/features.md b/docs/general/commands/features.md index 0373328..18b69c9 100644 --- a/docs/general/commands/features.md +++ b/docs/general/commands/features.md @@ -3,9 +3,11 @@ title: Features description: General usage of special features for a hologram --- +--8<-- "arguments.md" + ## Commands -> Aliases: `feature`, `f` +: **Aliases:** `feature`, `f` /// info | Command help For a list of all available subcommands run the following command: @@ -18,38 +20,40 @@ For a list of all available subcommands run the following command: ### `#!command /dh f disable ` { #dh-f-disable } -> Aliases: `off` -> -> Disables a Feature. -> -> - `#!command ` - The feature to disable. +: **Aliases:** `off` + + Disables a Feature. + + - `#!command ` - The feature to disable. ---- ### `#!command /dh f enable ` { #dh-f-enable } -> Aliases: `on` -> -> Enables a Feature. -> -> - `#!command ` - The feature to enable. +: **Aliases:** `on` + + Enables a Feature. + + - `#!command ` - The feature to enable. ---- ### `#!command /dh f info ` { #dh-f-info } -> Gives information about a specific feature. -> -> - `#!command ` - The feature to retrieve infos about. +: Gives information about a specific feature. + + - `#!command ` - The feature to retrieve infos about. + +---- ### `#!command /dh f list` { #dh-f-list } -> Lists all available features. +: Lists all available features. ---- ### `#!command /dh f reload ` { #dh-f-reload } -> Reloads a specific feature. -> -> - `#!command ` - The feature to reload. \ No newline at end of file +: Reloads a specific feature. + + - `#!command ` - The feature to reload. \ No newline at end of file diff --git a/docs/general/commands/general.md b/docs/general/commands/general.md index 2b7ddf2..b4ce07e 100644 --- a/docs/general/commands/general.md +++ b/docs/general/commands/general.md @@ -3,6 +3,8 @@ title: General description: General commands of DecentHolograms --- +--8<-- "arguments.md" + ## Commands /// info | Command help @@ -16,30 +18,30 @@ For a list of available subcommands run the following command: ### `#!command /dh convert [file]` { #dh-convert } -> Converts holograms from another hologram plugin. -> The hologram plugin does not have to be on the server. Only its files! -> -> - `#!command ` - The Hologram plugin to convert holograms from. See [this page](../compatibility.md) for a list. -> - `#!command [file]` - Location of the file to convert. Only required if the file is not in the default location of the other plugin. +: Converts holograms from another hologram plugin. + The hologram plugin does not have to be on the server. Only its files! + + - `#!command ` - The Hologram plugin to convert holograms from. See [this page](../compatibility.md) for a list. + - `#!command [file]` - Location of the file to convert. Only required if the file is not in the default location of the other plugin. ---- ### `#!command /dh list [page]` { #dh-list } -> Lists all holograms loaded from a hologram file. -> -> - `#!command [page]` - Page in the list to move to. +: Lists all holograms loaded from a hologram file. + + - `#!command [page]` - Page in the list to move to. ---- ### `#!command /dh reload` { #dh-reload } -> Reloads the plugin. +: Reloads the plugin. ---- ### `#!command /dh version` { #dh-version } -> Aliases: `about`, `ver` -> -> Shows some info about your current DecentHolograms version. \ No newline at end of file +: **Aliases:** `about`, `ver` + + Shows some info about your current DecentHolograms version. \ No newline at end of file diff --git a/docs/general/commands/hologram-line.md b/docs/general/commands/hologram-line.md index c2aabd6..b43d6f5 100644 --- a/docs/general/commands/hologram-line.md +++ b/docs/general/commands/hologram-line.md @@ -3,9 +3,11 @@ title: Hologram Line description: General usage and editing of hologram lines --- +--8<-- "arguments.md" + ## Commands -> Aliases: `line`, `l` +: **Aliases:** `line`, `l` /// info | Command help For a list of all available subcommands run the following command: @@ -18,174 +20,174 @@ For a list of all available subcommands run the following command: ### `#!command /dh l add [content]` { #dh-l-add } -> Aliases: `append` -> -> Add a new line into hologram. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line should be. -> - `#!command [conten]` - Optional [Content](../format-and-colors/index.md) of the new line. Defaults to the [`defaults.text` config option](../configuration/config.md). +: **Aliases:** `append` + + Add a new line into hologram. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line should be. + - `#!command [conten]` - Optional [Content](../format-and-colors/index.md) of the new line. Defaults to the [`defaults.text` config option](../configuration/config.md). ---- ### `#!command /dh l addflag ` { #dh-l-addflag } -> Adds a [flag](../flags.md) to a hologram line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command ` - Name of the [Flag](../flags.md) to add. +: Adds a [flag](../flags.md) to a hologram line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command ` - Name of the [Flag](../flags.md) to add. ---- ### `#!command /dh l align {X|Z|XZ}` { #dh-l-align } -> Aligns `#!command ` with `#!command ` on the specified axis. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the first line. -> - `#!command ` - Index of the second line. -> - `#!command {X|Z|XZ}` - Align `#!command ` with `#!command ` on either the X, Z, or X and Z axis. +: Aligns `#!command ` with `#!command ` on the specified axis. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the first line. + - `#!command ` - Index of the second line. + - `#!command {X|Z|XZ}` - Align `#!command ` with `#!command ` on either the X, Z, or X and Z axis. ---- ### `#!command /dh l edit ` { #dh-l-edit } -> Aliases: `e` -> -> Gives you a chat message to click on to get a pre-made command to edit the specified line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. +: **Aliases:** `e` + + Gives you a chat message to click on to get a pre-made command to edit the specified line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. ---- ### `#!command /dh l height ` { #dh-l-height } -> Aliases: `setheight` -> -> Set the height of a line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command ` - Number between `0.0` and `2.5` to set the line height. +: **Aliases:** `setheight` + + Set the height of a line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command ` - Number between `0.0` and `2.5` to set the line height. ---- ### `#!command /dh l info ` { #dh-l-info } -> Display some general info about a hologram line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. +: Display some general info about a hologram line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. ---- ### `#!command /dh l insert [content]` { #dh-l-insert } -> Insert a new line into hologram at the position of the given line number. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command [content]` - Optional [Content](../format-and-colors/index.md) of the new line. Defaults to the [`defaults.text` config option](../configuration/config.md). +: Insert a new line into hologram at the position of the given line number. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command [content]` - Optional [Content](../format-and-colors/index.md) of the new line. Defaults to the [`defaults.text` config option](../configuration/config.md). ---- ### `#!command /dh l offsetx ` { #dh-l-offsetx } -> Aliases: `offx`, `xoff`, `xoffset` -> -> Set the X offset of a hologram line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command ` - Number between `-2.5` and `2.5` to set the X offset of a line. +: **Aliases:** `offx`, `xoff`, `xoffset` + + Set the X offset of a hologram line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command ` - Number between `-2.5` and `2.5` to set the X offset of a line. ---- ### `#!command /dh l offsetz ` { #dh-l-offsetz } -> Aliases: `offz`, `zoff`, `zoffset` -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command ` - Number between `-2.5` and `2.5` to set the Z offset of a line. +: **Aliases:** `offz`, `zoff`, `zoffset` + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command ` - Number between `-2.5` and `2.5` to set the Z offset of a line. ---- ### `#!command /dh l remove ` { #dh-l-remove } -> Aliases: `del`, `delete`, `rem` -> -> Remove a line from hologram. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. +: **Aliases:** `del`, `delete`, `rem` + + Remove a line from hologram. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. ---- ### `#!command /dh l removeflag ` { #dh-l-removeflag } -> Removes a [flag](../flags.md) from a hologram line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command ` - Name of the [Flag](../flags.md) you want to remove. +: Removes a [flag](../flags.md) from a hologram line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command ` - Name of the [Flag](../flags.md) you want to remove. ---- ### `#!command /dh l set ` { #dh-l-set } -> Set a new content to hologram line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command ` - [Content](../format-and-colors/index.md) of a line. +: Set a new content to hologram line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command ` - [Content](../format-and-colors/index.md) of a line. ---- ### `#!command /dh l setfacing ` { #dh-l-setfacing } -> Aliases: `facing`, `face` -> -> Set the rotation of hologram line facing (Yaw). This only has an effect on `#HEAD:`, `#SMALLHEAD:` and `#ENTITY:` content lines. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command ` - Number between `-180.0` and `180.0` for a specific angle, or a cardinal direction (`NORTH`, `EAST`, `SOUTH` or `WEST`). +: **Aliases:** `facing`, `face` + + Set the rotation of hologram line facing (Yaw). This only has an effect on `#HEAD:`, `#SMALLHEAD:` and `#ENTITY:` content lines. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command ` - Number between `-180.0` and `180.0` for a specific angle, or a cardinal direction (`NORTH`, `EAST`, `SOUTH` or `WEST`). ---- ### `#!command /dh l setpermission [permission]` { #dh-l-setpermission } -> Aliases: `perm`, `permission`, `setperm` -> -> Set a permission required to view a hologram line. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the line is. -> - `#!command ` - Index of the line. -> - `#!command [permission]` - Permission required for a line to be seen. Leave empty to remove any permission. +: **Aliases:** `perm`, `permission`, `setperm` + + Set a permission required to view a hologram line. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the line is. + - `#!command ` - Index of the line. + - `#!command [permission]` - Permission required for a line to be seen. Leave empty to remove any permission. ---- ### `#!command /dh l swap ` { #dh-l-swap } -> Swap two lines in a hologram. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Index of the page, on which the lines are. -> - `#!command ` - Index of the first line. -> - `#!command ` - Index of the second line. \ No newline at end of file +: Swap two lines in a hologram. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Index of the page, on which the lines are. + - `#!command ` - Index of the first line. + - `#!command ` - Index of the second line. \ No newline at end of file diff --git a/docs/general/commands/hologram-pages.md b/docs/general/commands/hologram-pages.md index f626d4a..ee723d0 100644 --- a/docs/general/commands/hologram-pages.md +++ b/docs/general/commands/hologram-pages.md @@ -3,9 +3,11 @@ title: Hologram Pages description: General usage and editing of hologram pages --- +--8<-- "arguments.md" + ## Commands -> Aliases: `page`, `p` +: **Aliases:** `page`, `p` /// info | Command help For a list of all available subcommands run the following command: @@ -18,97 +20,97 @@ For a list of all available subcommands run the following command: ### `#!command /dh p actions [listPage]` { #dh-p-actions } -> View actions set on the specified [Click type](../actions.md#click-types) in page of a hologram. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Index of the page. -> - `#!command ` - [Click type](../actions.md#click-types). -> - `#!command [listPage]` - Optional page in the list to move to. - +: View actions set on the specified [Click type](../actions.md#click-types) in page of a hologram. + + - `#!command ` - Name of the hologram. + - `#!command ` - Index of the page. + - `#!command ` - [Click type](../actions.md#click-types). + - `#!command [listPage]` - Optional page in the list to move to. + ---- ### `#!command /dh p add [content]` { #dh-p-add } -> Aliases: `append` -> -> Add a new page into hologram. -> -> - `#!command ` - Name of the hologram. -> - `#!command [content]` - Optional [Content](../format-and-colors/index.md) of the first line in the new page. Defaults to the [`defaults.text` config option](../configuration/config.md). +: **Aliases:** `append` + + Add a new page into hologram. + + - `#!command ` - Name of the hologram. + - `#!command [content]` - Optional [Content](../format-and-colors/index.md) of the first line in the new page. Defaults to the [`defaults.text` config option](../configuration/config.md). ---- ### `#!command /dh p addaction ` { #dh-p-addaction } -> Adds the specified [``](../actions.md) for the specified `#!command ` to a hologram page. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Index of the page. -> - `#!command ` - [Click type](../actions.md#click-types) that triggers this action. -> - `#!command ` - [Action](../actions.md#action-types) to trigger. +: Adds the specified [``](../actions.md) for the specified `#!command ` to a hologram page. + + - `#!command ` - Name of the hologram. + - `#!command ` - Index of the page. + - `#!command ` - [Click type](../actions.md#click-types) that triggers this action. + - `#!command ` - [Action](../actions.md#action-types) to trigger. ---- ### `#!command /dh p clearactions ` { #dh-p-clearactions } -> Clears `#!command ` of all [Actions](../actions.md) specified for `#!command `. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Index of the page. -> - `#!command ` - [Click type](../actions.md#click-types). +: Clears `#!command ` of all [Actions](../actions.md) specified for `#!command `. + + - `#!command ` - Name of the hologram. + - `#!command ` - Index of the page. + - `#!command ` - [Click type](../actions.md#click-types). ---- ### `#!command /dh p insert [content]` { #dh-p-insert } -> Insert a new page into hologram. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Position of the page to insert the new one before. -> - `#!command [content]` - Optional [Content](../format-and-colors/index.md) of the first line in the new page. Defaults to the [`defaults.text` config option](../configuration/config.md). +: Insert a new page into hologram. + + - `#!command ` - Name of the hologram. + - `#!command ` - Position of the page to insert the new one before. + - `#!command [content]` - Optional [Content](../format-and-colors/index.md) of the first line in the new page. Defaults to the [`defaults.text` config option](../configuration/config.md). ---- ### `#!command /dh p remove ` { #dh-p-remove } -> Aliases: `del`, `delete`, `rem` -> -> Remove a page from hologram. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Index of the page to remove. +: **Aliases:** `del`, `delete`, `rem` + + Remove a page from hologram. + + - `#!command ` - Name of the hologram. + - `#!command ` - Index of the page to remove. ---- ### `#!command /dh p removeaction ` { #dh-p-removeaction } -> Aliases: `remaction` -> -> Removes an [Action](../actions.md) for `#!command ` from `#!command `. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Index of the page. -> - `#!command ` - [Click type](../actions.md#click-types) that triggers this action. -> - `#!command ` - Index of the action in the list. +: **Aliases:** `remaction` + + Removes an [Action](../actions.md) for `#!command ` from `#!command `. + + - `#!command ` - Name of the hologram. + - `#!command ` - Index of the page. + - `#!command ` - [Click type](../actions.md#click-types) that triggers this action. + - `#!command ` - Index of the action in the list. ---- ### `#!command /dh p swap ` { #dh-p-swap } -> Swaps `#!command ` with `#!command `. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Index of the first page. -> - `#!command ` - Index of the second page. +: Swaps `#!command ` with `#!command `. + + - `#!command ` - Name of the hologram. + - `#!command ` - Index of the first page. + - `#!command ` - Index of the second page. ---- ### `#!command /dh p switch [player]` { #dh-p-switch } -> Aliases: `go`, `view` -> -> Switch to another page in a hologram. -> -> - `#!command ` - Name of the hologram. -> - `#!command ` - Index of the page to view. -> - `#!command [player]` - Optional player to switch the page for. \ No newline at end of file +: **Aliases:** `go`, `view` + + Switch to another page in a hologram. + + - `#!command ` - Name of the hologram. + - `#!command ` - Index of the page to view. + - `#!command [player]` - Optional player to switch the page for. Defaults to command executor if not set. \ No newline at end of file diff --git a/docs/general/commands/hologram.md b/docs/general/commands/hologram.md index ee5c939..e0a3794 100644 --- a/docs/general/commands/hologram.md +++ b/docs/general/commands/hologram.md @@ -3,9 +3,11 @@ title: Hologram description: General usage and editing of Holograms --- +--8<-- "arguments.md" + ## Commands -> Aliases: `hologram`, `holo`, `h` +: **Aliases:** `hologram`, `holo`, `h` /// info | Command help For a list of all available subcommands run the following command: @@ -18,243 +20,243 @@ For a list of all available subcommands run the following command: ### `#!command /dh h addflag ` { #dh-h-addflag } -> Adds a [flag](../flags.md) to a hologram. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Name of the [Flag](../flags.md) to add. +: Adds a [flag](../flags.md) to a hologram. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Name of the [Flag](../flags.md) to add. ---- ### `#!command /dh h align {X|Y|Z|XZ|FACING} ` { #dh-h-align } -> Moves a hologram to the location of the other hologram on a specified axis. -> -> - `#!command ` - Name of the Hologram. -> - `#!command {X|Y|Z|XZ|FACING}` - Aligns the hologram on either the X, Y, Z, or X and Z axis of the `#!command `, or sets the same facing angle as the `#!command `. -> - `#!command ` - Name of the other Hologram. +: Moves a hologram to the location of the other hologram on a specified axis. + + - `#!command ` - Name of the Hologram. + - `#!command {X|Y|Z|XZ|FACING}` - Aligns the hologram on either the X, Y, Z, or X and Z axis of the `#!command `, or sets the same facing angle as the `#!command `. + - `#!command ` - Name of the other Hologram. ---- ### `#!command /dh h center ` { #dh-h-center } -> Moves a hologram into the center of the block on its current X and Z location. -> -> - `#!command ` - Name of the Hologram. +: Moves a hologram into the center of the block on its current X and Z location. + + - `#!command ` - Name of the Hologram. ---- ### `#!command /dh h clone [temp] [-l::::]` { #dh-h-clone } -> Aliases: `copy` -> -> Clone an existing hologram. -> -> - `#!command ` - Name of the Hologram to clone. -> - `#!command ` - Name of the new, clones Hologram. -> - `#!command [temp]` - Optional boolean to set, whether the cloned hologram should be temporary (not save to file) or not. Default is `false` -> - `#!command [-l::::]` - Optional location argument, which allows you to specify the location where the cloned hologram should be placed. This argument can also be used by console users to execute the command. -> -> /// example | Examples -> ``` -> /dh h clone test test_clone -> /dh h clone test test_clone true -> /dh h clone test test_clone -l:world:0:100:0 -> /dh h clone test test_clone true -l:world:0:100:0 -> ``` -> /// +: **Aliases:** `copy` + + Clone an existing hologram. + + - `#!command ` - Name of the Hologram to clone. + - `#!command ` - Name of the new, clones Hologram. + - `#!command [temp]` - Optional boolean to set, whether the cloned hologram should be temporary (not save to file) or not. Default is `false` + - `#!command [-l::::]` - Optional location argument, which allows you to specify the location where the cloned hologram should be placed. This argument can also be used by console users to execute the command. + + /// example | Examples + ``` + /dh h clone test test_clone + /dh h clone test test_clone true + /dh h clone test test_clone -l:world:0:100:0 + /dh h clone test test_clone true -l:world:0:100:0 + ``` + /// ---- ### `#!command /dh h create [-l::::] [content]` { #dh-h-create } -> Aliases: `create`, `c` -> -> Create a new hologram. -> -> - `#!command ` - Name of the created Hologram. -> - `#!command [-l::::]` - Optional location argument, which allows you to specify the location where the hologram should be placed. This argument can also be used by console users to execute the command. -> - `#!command [content]` - Content of the first line. (Optional) -> -> /// example | Examples -> ``` -> /dh h create test -> /dh h create test -l:world:0:100:0 -> /dh h create test First Line -> /dh h create test -l:world:0:100:0 First Line -> ``` -> /// +: **Aliases:** `create`, `c` + + Create a new hologram. + + - `#!command ` - Name of the created Hologram. + - `#!command [-l::::]` - Optional location argument, which allows you to specify the location where the hologram should be placed. This argument can also be used by console users to execute the command. + - `#!command [content]` - Content of the first line. (Optional) + + /// example | Examples + ``` + /dh h create test + /dh h create test -l:world:0:100:0 + /dh h create test First Line + /dh h create test -l:world:0:100:0 First Line + ``` + /// ---- ### `#!command /dh h delete ` { #dh-h-delete } -> Aliases: `del`, `remove`, `rem` -> -> Delete an existing hologram. -> -> - `#!command ` - Name of the Hologram. +: **Aliases:** `del`, `remove`, `rem` + + Delete an existing hologram. + + - `#!command ` - Name of the Hologram. ---- ### `#!command /dh h disable ` { #dh-h-disable } -> Aliases: `off` -> -> Disable a hologram. While disabled, it won't be displayed to anyone. -> -> - `#!command ` - Name of the Hologram. +: **Aliases:** `off` + + Disable a hologram. While disabled, it won't be displayed to anyone. + + - `#!command ` - Name of the Hologram. ---- ### `#!command /dh h downorigin {true|false}` { #dh-h-downorigin } -> Sets the value of down origin. If true, hologram's location will be relative to its bottom. -> -> - `#!command ` - Name of the Hologram. -> - `#!command {true|false}` - Whether the hologram's location should be relative to its bottom line or not. +: Sets the value of down origin. If true, hologram's location will be relative to its bottom. + + - `#!command ` - Name of the Hologram. + - `#!command {true|false}` - Whether the hologram's location should be relative to its bottom line or not. ---- ### `#!command /dh h enable ` { #dh-h-enable } -> Aliases: `on` -> -> Enable a hologram. -> -> - `#!command ` - Name of the Hologram. +: **Aliases:** `on` + + Enable a hologram. + + - `#!command ` - Name of the Hologram. ---- ### `#!command /dh h info ` { #dh-h-info } -> Prints some general info about a hologram. -> -> - `#!command ` - Name of the Hologram. +: Prints some general info about a hologram. + + - `#!command ` - Name of the Hologram. ---- ### `#!command /dh h lines [listPage]` { #dh-h-lines } -> Lists all the holograms lines. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Page to list the lines of. -> - `#!command [listPage]` - Optional page in the list to move to. +: Lists all the holograms lines. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Page to list the lines of. + - `#!command [listPage]` - Optional page in the list to move to. ---- ### `#!command /dh h move ` { #dh-h-move } -> Aliases: `mv` -> -> Teleports the given hologram to the given coordinates. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - New X location of the Hologram. -> - `#!command ` - New Y location of the Hologram. -> - `#!command ` - New Z location of the Hologram. +: **Aliases:** `mv` + + Teleports the given hologram to the given coordinates. + + - `#!command ` - Name of the Hologram. + - `#!command ` - New X location of the Hologram. + - `#!command ` - New Y location of the Hologram. + - `#!command ` - New Z location of the Hologram. ---- ### `#!command /dh h movehere ` { #dh-h-movehere } -> Aliases: `mvhr` -> -> Teleports the given hologram to your location. -> -> - `#!command ` - Name of the Hologram. +: **Aliases:** `mvhr` + + Teleports the given hologram to your location. + + - `#!command ` - Name of the Hologram. ---- ### `#!command /dh h near ` { #dh-h-near } -> Lists of holograms in the specified distance from you. -> -> - `#!command ` - Distance to check in blocks. +: Lists of holograms in the specified distance from you. + + - `#!command ` - Distance to check in blocks. ---- ### `#!command /dh h removeflag ` { #dh-h-removeflag } -> Removes a [flag](../flags.md) from the hologram. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Name of the [Flag](../flags.md) you want to remove. +: Removes a [flag](../flags.md) from the hologram. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Name of the [Flag](../flags.md) you want to remove. ---- ### `#!command /dh h rename ` { #dh-h-rename } -> Rename an existing hologram. -> -> - `#!command ` - Name of the Hologram, you want to rename. -> - `#!command ` - The Hologram's new name. +: Rename an existing hologram. + + - `#!command ` - Name of the Hologram, you want to rename. + - `#!command ` - The Hologram's new name. ---- ### `#!command /dh h setdisplayrange ` { #dh-h-setdisplayrange } -> Set maximum distance a player can be from a hologram to see it. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Number between `1` and `64` to set the display range in blocks. +: Set maximum distance a player can be from a hologram to see it. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Number between `1` and `64` to set the display range in blocks. ---- ### `#!command /dh h setfacing ` { #dh-h-setfacing } -> Aliases: `facing`, `face`, `setface` -> -> Set the rotation of hologram facing (yaw). Only affects `#HEAD:`, `#SMALLHEAD:` and `#ENTITY:` content lines. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Number between `-180.0` and `180.0` for a specific angle, or a cardinal direction (`NORTH`, `EAST`, `SOUTH` or `WEST`). +: **Aliases:** `facing`, `face`, `setface` + + Set the rotation of hologram facing (yaw). Only affects `#HEAD:`, `#SMALLHEAD:` and `#ENTITY:` content lines. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Number between `-180.0` and `180.0` for a specific angle, or a cardinal direction (`NORTH`, `EAST`, `SOUTH` or `WEST`). ---- ### `#!command /dh h setpermission [permission]` { #dh-h-setpermission } -> Aliases: `permission`, `setperm`, `perm` -> -> Set the current permission required to view the hologram. -> -> - `#!command ` - Name of the Hologram. -> - `#!command [permission]` - Permission required for a hologram to be seen. Leave empty to remove any permission. +: **Aliases:** `permission`, `setperm`, `perm` + + Set the current permission required to view the hologram. + + - `#!command ` - Name of the Hologram. + - `#!command [permission]` - Permission required for a hologram to be seen. Leave empty to remove any permission. ---- ### `#!command /dh h setupdateinterval ` -> Aliases: `updateinterval` -> -> Set update interval. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Number between `1` and `1200` to set the interval in ticks (20 ticks = 1 sec.). +: **Aliases:** `updateinterval` + + Set update interval. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Number between `1` and `1200` to set the interval in ticks (20 ticks = 1 sec.). ---- ### `#!command /dh h setupdaterange ` -> Set maximum distance a player can be from a hologram to see it's updates. -> -> - `#!command ` - Name of the Hologram. -> - `#!command ` - Number between `1` and `64` to set the update range in blocks. +: Set maximum distance a player can be from a hologram to see it's updates. + + - `#!command ` - Name of the Hologram. + - `#!command ` - Number between `1` and `64` to set the update range in blocks. ---- ### `#!command /dh h teleport ` { #dh-h-teleport } -> Aliases: `tele`, `tp` -> -> Teleports you to the given hologram. -> -> - `#!command ` - Name of the Hologram. +: **Aliases:** `tele`, `tp` + + Teleports you to the given hologram. + + - `#!command ` - Name of the Hologram. ---- ### `#!command /dh h update ` { #dh-h-update } -> Hide the hologram and then Show it again. -> -> - `#!command ` - Name of the Hologram. +: Hide the hologram and then Show it again. + + - `#!command ` - Name of the Hologram. diff --git a/docs/general/commands/index.md b/docs/general/commands/index.md index ca0be25..5453dec 100644 --- a/docs/general/commands/index.md +++ b/docs/general/commands/index.md @@ -14,15 +14,7 @@ DecentHolograms offers a user-friendly command interface that allows you to edit - `/dh lines help` - For help with Hologram Lines related commands. - `/dh features help` - For help with Features related commands. -## Arguments - -Parenthesis only specifiy the type of an argument, they are **not** part of the final command. - -| Parenthesis | Meaning | -|-------------|--------------------------| -| `<>` | Required argument. | -| `[]` | Optional argument. | -| `{}` | List of possible values. | +--8<-- "arguments.md" ## Aliases diff --git a/docs/general/compatibility.md b/docs/general/compatibility.md index 1ce0a3a..658cc6d 100644 --- a/docs/general/compatibility.md +++ b/docs/general/compatibility.md @@ -19,63 +19,79 @@ To allow placeholders to be parsed, enable `allow-placeholders-inside-animations DecentHolograms supports the conversion of Holograms from other hologram plugins to itself. Below is a list of all currently supported plugins, the command you have to use and notes on how DecentHologram will treat specific cases. -/// note -The plugins **do not** have to be enabled to allow a conversion. Only their Hologram file needs to be present in their default location. +/// note | The plugin does not need to be enabled to convert. Only its hologram files are needed. /// ### CMI -> ``` -> /dh convert CMI -> ``` - -Special actions: - -- :octicons-check-16: `#!command ICON:` is converted to `#!command #ICON:` -- :octicons-check-16: `!nextpage!` reates a new page -- :octicons-alert-16: Holograms with names that start with `#<` or `#>` will be skipped. +: + ``` + /dh convert CMI + ``` + + **Default File Location:** `plugins/CMI/holograms.yml` + + **Special Actions:** + + - :octicons-check-16:{ .md-icon-color--success } `#!command ICON:` gets converted to `#!command #ICON:` + - :octicons-check-16:{ .md-icon-color--success } `!nextpage!` creates a new Hologram Page. + - :octicons-alert-16:{ .md-icon-color--warning } Holograms with names that start with `#<` or `#>` will be skipped ### FutureHolograms -> ``` -> /dh convert FutureHolograms -> ``` - -Special Actions: - -- :octicons-alert-16: No notable Actions outside basic Hologram conversion. +: + ``` + /dh convert FutureHolograms + ``` + + **Default File Location:** `plugins/FutureHolograms/holograms.yml` + + **Special Actions:** + + - :octicons-alert-16:{ .md-icon-color--warning } No notable actions outside basic Hologram cinversion. ### GHolo -> ``` -> /dh convert GHolo -> ``` - -Special Actions: - -- :octicons-check-16: `#!command ICON:` is converted to `#!command #ICON:` -- :octicons-check-16: `#!command ENTITY:` is converted to `#!command #ENTITY:` -- :octicons-check-16: `[x]`, `[X]` and `[|]` are converted into their respective unicode characters. -- :octicons-check-16: [#rrggbb text #rrggbb] is converted to <#rrggbb>text</#rrggbb> +: + ``` + /dh convert GHolo + ``` + + **Default File Location:** `plugins/GHolo/data/h.data` + + **Special Actions:** + + - :octicons-check-16:{ .md-icon-color--success } `#!command ICON:` gets converted to `#!command #ICON:` + - :octicons-check-16:{ .md-icon-color--success } `#!command ENTITY:` gets converted to `#!command #ENTITY:` + - :octicons-check-16:{ .md-icon-color--success } `[x]`, `[X]` and `[|]` get converted into Unicde characters + - :octicons-check-16:{ .md-icon-color--success } [#rrggbb text #rrggbb] + gets converted to + <#rrggbb>text</#rrggbb> ### Holograms -> ``` -> /dh convert Holograms -> ``` - -Special Actions: - -- :octicons-check-16: `#!command ITEM:` is converted to `#!command #ICON:` +: + ``` + /dh convert Holograms + ``` + + **Default File Location:** `plugins/Holograms/holograms.yml` + + **Special Actions:** + + - :octicons-check-16:{ .md-icon-color--success } `#!command ITEM:` gets converted to `#!command #ICON:` ### HolographicDisplays -> ``` -> /dh convert HolographicDisplays -> ``` - -Special Actions: - -- :octicons-check-16: `#!command ICON:` is converted to `#!command #ICON:` -- :octicons-check-16: `#!command {papi: }` is converted to `#!command %%` -- :octicons-check-16: `#!command {empty}` is converted into an empty Hologram line using a color code. \ No newline at end of file +: + ``` + /dh convert HolographicDisplays + ``` + + **Default File Location:** `plugins/HolographicDisplays/database.yml` + + **Special Actions:** + + - :octicons-check-16:{ .md-icon-color--success } `#!command ICON:` gets converted to `#!command #ICON:` + - :octicons-check-16:{ .md-icon-color--success } `#!command {papi: }` gets converted to `%%` + - :octicons-check-16:{ .md-icon-color--success } `#!command {empty}` creates an empty line using a color code. \ No newline at end of file diff --git a/docs/general/format-and-colors/colors.md b/docs/general/format-and-colors/colors.md index 5c4ad20..795904c 100644 --- a/docs/general/format-and-colors/colors.md +++ b/docs/general/format-and-colors/colors.md @@ -21,39 +21,34 @@ DecentHolograms supports multiple formats for RGB colors, all of which are defin ## Gradients -Gradients in DecentHolograms are defined using the following format: - -/// tip -You can use formatting codes inside the gradients. -/// - -> ```command -> <#RRGGBB>This text is going to have a gradient. -> ``` - -Example gradient: - -> ```command -> <#00FFFF>&l&nDECENT HOLOGRAMS -> ``` +: /// tip | Formatting codes can be used in-between the gradients. + /// + + Gradients can be defined using `#!command <#rrggbb>text` where `#!command <#rrggbb>` is the starting color and `#!command ` the ending color. + + /// example + ```command + <#FF0000>Gradient! + ``` + /// ## Rainbow Gradients -Rainbow Gradients in DecentHolograms are defined using the following formats: - -/// tip -You can also put another number from 0 to 999 instead of the 1 to make the rainbow different. -/// - -> ```command -> Rainbow Text -> ``` - -## Rainbow Color - -Rainbow Color is an animated color that cycles through all colors gradually, giving the text a dynamic and visually striking effect. -Former HolographicDisplays users may be familiar with this one, as it uses the same color code: - -> ``` -> &uSome color-changing text -> ``` \ No newline at end of file +: A rainbow gradient can be created using `text`. The `1` can be replaced with any number from 0 to 999 to change the rainbow. + + /// example + ```command + Rainbow Gradient! + ``` + /// + +## Rainbow Color (Animated) { #rainbow-color } + +: Using `<#ANIM:colors>`, you can make your Text cycle through all available color codes. + This is similar to what you may know from HolographicDisplays and does in fact also provide a `&u` color code for your convenience. + + /// example + ```command + &uAnimated rainbow text! + ``` + /// \ No newline at end of file diff --git a/docs/general/format-and-colors/index.md b/docs/general/format-and-colors/index.md index 7e2e66e..ebe3d0c 100644 --- a/docs/general/format-and-colors/index.md +++ b/docs/general/format-and-colors/index.md @@ -32,7 +32,7 @@ This is the default line type used by DecentHolograms. Only when the Line follow ---- -## `#ICON` (Floating Item) { #icon } +## `#!command #ICON: ` { #icon } Displays a floating item in the Hologram. Do keep in mind that the item will spin around, which can't be disabled by the plugin. If you want non-moving items, use the [`#HEAD`](#head) or [`#SMALLHEAD`](#smallhead) Line Type. @@ -60,7 +60,7 @@ Do keep in mind that the item will spin around, which can't be disabled by the p ---- -## `#HEAD` { #head } +## `#!command #HEAD: ` { #head } Displays the item/block as an armor stand's Head gear. Items displayed this way won't rotate, but may have a visible offset to the Hologram's center. @@ -85,7 +85,7 @@ Items displayed this way won't rotate, but may have a visible offset to the Holo ---- -## `#SMALLHEAD` { #smallhead } +## `#!command #SMALLHEAD: ` { #smallhead } Displays the item/block as a small armor stand's Head gear. Items displayed this way won't rotate, but may have a visible offset to the Hologram's center. @@ -110,13 +110,16 @@ Items displayed this way won't rotate, but may have a visible offset to the Holo ---- -## `#ENTITY` { #entity } +## `#!command #ENTITY: ` { #entity } -Displays an entity. A list of all available entities can be found [here](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html){ target="_blank" rel="nofollow" }. +Displays an entity. A list of all available entities can be found [here][entities]{ target="_blank" rel="nofollow" }. /// note | Notes - The entity will be displayed in a sitting position, if it has one. This can't be changed. -- Certain Entity types can not be used in the Hologram. A list can be seen [here](https://github.com/DecentSoftware-eu/DecentHolograms/blob/main/src/main/java/eu/decentsoftware/holograms/api/utils/entity/DecentEntityType.java){ target="_blank" rel="nofollow" }. +- Certain Entity types can not be used in the Hologram. A list can be seen [here][blacklist]{ target="_blank" rel="nofollow" } (Last updated: April 27th, 2024). + +[entities]: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html +[blacklist]: https://github.com/DecentSoftware-eu/DecentHolograms/blob/f28df4373f4d56e17eb33005885222f726ac1350/src/main/java/eu/decentsoftware/holograms/api/utils/entity/DecentEntityType.java#L21-L51 /// /// tab | Format @@ -147,5 +150,5 @@ The following options can be set for the `` in `()`: - Player name (i.e. `d0by`). - Placeholder resolving to a Player name such as `{player}`. This will result in the player seeing their own head in the hologram. -- A Base64-encoded Texture String. You can find those on sites such as https://minecraft-heads.com{ target="_blank" rel="nofollow" }. +- A Base64-encoded Texture String. You can find those on sites such as https://minecraft-heads.com{ target="_blank" rel="nofollow" } and are usually refered to as "value". - `HEADDATABASE_` where `` is a number from https://minecraft-heads.com{ target="_blank" rel="nofollow" } (Requires the plugin [HeadDatabase](https://www.spigotmc.org/resources/14280/){ target="_blank" rel="nofollow" }). \ No newline at end of file diff --git a/docs/general/setup.md b/docs/general/setup.md index 19bc9da..f7c3a18 100644 --- a/docs/general/setup.md +++ b/docs/general/setup.md @@ -15,13 +15,7 @@ With a wide range of commands, effectively utilizing this plugin may require a b ### Arguments -Parenthesis only specifiy the type of an argument, they are **not** part of the final command. - -| Parenthesis | Meaning | -|-------------|--------------------------| -| `<>` | Required argument. | -| `[]` | Optional argument. | -| `{}` | List of possible values. | +--8<-- "arguments.md:2" ### Tab Completion @@ -29,61 +23,14 @@ The majority of commands and sub-commands feature tab-completion functionality, ## Editing Holograms -This tutorial provided a basic guide for editing holograms, including instructions for creating and modifying them. For a complete list of commands, please refer to [this page](). - -### Create a Hologram [[More]](commands/hologram.md) { #create-a-hologram } - -Creating a hologram is easy, simply use the command below to get started. - -> ```command -> /dh create [initial content] -> ``` - -/// tip -By default, the hologram will spawn with a single line that reads "Blank Line". You can change the default line content in the [config.yml]() file or specify the content in the command as shown in the example provided. -/// - -### Edit lines [[More]](commands/hologram-line.md) { #edit-lines } - -A full list of possible line types and content for hologram lines can be found on [this page](). - -#### Add a line - -> ```command -> /dh line add -> ``` - -#### Set a line - -> ```command -> /dh line set -> ``` - -#### Remove a line - -> ```command -> /dh line remove -> ``` +The below section will give you a basic example of creating and managing a hologram. For more info, visit the following pages: -### Edit pages [[More]](commands/hologram-pages.md) { #edit-pages } +
-#### Add a page +- ### [:material-floppy: Format & Colors](format-and-colors/index.md) +- ### [:material-keyboard: Commands](commands/index.md) -> ```command -> /dh page add [initial content] -> ``` - -#### Remove a page - -> ```command -> /dh page remove -> ``` - -#### View a page - -> ```command -> /dh page switch -> ``` +
## Hologram Creation Example @@ -91,50 +38,47 @@ Here is an example of how to create a new hologram with multiple lines and pages ### Create the hologram -> ``` -> /dh create example -> ``` - -![creating a hologram](../assets/images/setup/hologram-create.png){ loading="lazy" } +: /// info | To execute as console, you have to add the `-l::::` argument. + /// + + ``` + /dh create example + ``` + + ![creating a hologram](../assets/images/setup/hologram-create.png){ loading="lazy" } ### Edit lines -> ``` -> /dh line set example 1 1 &3&lDECENT HOLOGRAMS -> /dh line add example 1 &fHolograms plugin -> ``` - -![editing a hologram](../assets/images/setup/hologram-edit.png){ loading="lazy" } +: + ``` + /dh line set example 1 1 &3&lDECENT HOLOGRAMS + /dh line add example 1 &fHolograms plugin + ``` + + ![editing a hologram](../assets/images/setup/hologram-edit.png){ loading="lazy" } ### Add another page -You can have as many pages as you'd like. - -> ``` -> /dh page add example -> /dh page switch example 2 -> ``` - -![adding a page to a hologram](../assets/images/setup/hologram-page.png){ loading="lazy" } +: You can have as many pages as you'd like. + + ``` + /dh page add example + /dh page switch example 2 + ``` + + ![adding a page to a hologram](../assets/images/setup/hologram-page.png){ loading="lazy" } ### Setup actions -To allow players to navigate between pages, you can simply do this: - -> ``` -> /dh page addaction example 1 RIGHT NEXT_PAGE -> /dh page addaction example 2 LEFT PREV_PAGE -> ``` - -By setting up appropriate click actions, players can navigate between the pages by right-clicking the first page to switch to the next page, and left-clicking the second page to switch back to the first page. - -#### You can also switch to a specific page { #switch-to-specific-page } - -> ``` -> /dh page addaction example 2 RIGHT PAGE:1 -> ``` - -We offer a variety of click actions, all of which are explained in detail on [this page](actions.md). +: To allow players to navigate between pages, you can simply do this: + + ``` + /dh page addaction example 1 RIGHT NEXT_PAGE + /dh page addaction example 2 LEFT PREV_PAGE + ``` + + This allows players to navigate between the pages by left/right-clicking the hologram. + More actions are available and can be found [here](actions.md). ## Conclusion diff --git a/docs/index.md b/docs/index.md index 6f03c67..4a82f9d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,12 +30,12 @@ If you need assistance or have any inquiries, please feel free to reach out to u We also welcome bug reports and suggestions on both our Discord and our GitHub repository. /// warning | Official downloads -Official downloads of DecentHolograms are only provided through its Spigot Page, GitHub Repository and the Discord Server. +Downloads for DecentHolograms are only provided on its Spigot Page, GitHub Repository and the DecentSoftware Discord. -Any other site offering downloads for DecentHolograms does so without or knowledge nor our endorsement or support. -Please do **not** download from such sites! They may contain changes that could add malware to your server or contain expoits and/or backdoors that could harm your server. +Any other site sharing downloads of DecentHolograms does so without or knowledge, nor our consent. +Do **not** download the plugin from such pages! The jar can contain malware, exploits or backdoors that can harm your server. -**Only download the plugin from its original sources as mentioned above!** +**Only download the plugin from its original sources!** /// - [:simple-spigotmc: SpigotMC Page](https://www.spigotmc.org/resources/96927/){ target="_blank" rel="noreferral" } diff --git a/hooks/__pycache__/replacer.cpython-311.pyc b/hooks/__pycache__/replacer.cpython-311.pyc new file mode 100644 index 0000000..787e180 Binary files /dev/null and b/hooks/__pycache__/replacer.cpython-311.pyc differ diff --git a/hooks/replacer.py b/hooks/replacer.py new file mode 100644 index 0000000..cd9aed5 --- /dev/null +++ b/hooks/replacer.py @@ -0,0 +1,25 @@ +# +# A simple hook that replaces any appearances of \| with just |. +# +# There is an inconsistency between GitHub flavourited Markdown and Python Markdown. +# GFM treats | inside a table cell as a table cell separator, even if it was put in +# inline code while Python Markdown does not. +# +# The only way to prevent this is to escape it by prefixing it with a back slash (\). +# Unfortunately does this cause issues on Python-Markdown, as it renders inline code +# content as-is without special treatments whatsoever, meaning that `\|` will be +# rendered as \| in the end. +# +# This hook now turns any \| into | when the site is being processed, so that it +# shows as | in the final page while not breaking tables on GitHub. +# +import re + +from mkdocs.config.defaults import MkDocsConfig +from mkdocs.structure.files import File, Files +from mkdocs.structure.pages import Page + +def on_page_content( + html: str, page: Page, config: MkDocsConfig, files: Files +): + return re.sub(r"\\\|","|",html) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 931c32d..2f583e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,6 +64,7 @@ markdown_extensions: permalink: true toc_depth: 3 - md_in_html + - def_list # PyMDownX extensions - pymdownx.blocks.admonition: types: @@ -91,6 +92,9 @@ markdown_extensions: - pymdownx.snippets: base_path: 'snippets' +hooks: + - hooks/replacer.py + not_in_nav: | general/index.md api/index.md diff --git a/snippets/arguments.md b/snippets/arguments.md new file mode 100644 index 0000000..41ab323 --- /dev/null +++ b/snippets/arguments.md @@ -0,0 +1,9 @@ +## Arguments + +Parenthesis are used to indicate arguments. They are not required in the actual command you use! + +| Parenthesis | Meaning | +|-------------|------------------------------------------------------| +| `<>` | Indicates a required argument. | +| `[]` | Indicates a optional argument. | +| `{}` | Gives a list of possible options, separated by `\|`. | \ No newline at end of file