Skip to content

Commit

Permalink
Use def_list for indents (+ site improvements)
Browse files Browse the repository at this point in the history
  • Loading branch information
Andre601 committed Apr 27, 2024
1 parent ce40067 commit 59d92a7
Show file tree
Hide file tree
Showing 18 changed files with 614 additions and 594 deletions.
8 changes: 8 additions & 0 deletions docs/assets/stylesheets/theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,11 @@
white-space: nowrap;
display: block;
}

.md-icon-color--success {
color: #00c853;
}

.md-icon-color--warning {
color: #ff9100;
}
110 changes: 59 additions & 51 deletions docs/general/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
> <action_type>
> <action_type>:<args>
> ```
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.
Expand All @@ -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>` { #message }

> Sends a message to the player who clicked the hologram.
>
> - `#!command <message>` - The message to send. Supports Placeholders, including PlaceholderAPI.
: Sends a message to the player who clicked the hologram.

- `#!command <message>` - The message to send. Supports Placeholders, including PlaceholderAPI.

----

### `#!command 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 <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 <command>` - The command to execute as the player. Supports Placeholders, including PlaceholderAPI.

----

### `#!command CONSOLE:<command>` { #console }

> /// warning | Important
> Commands only available through a proxy cannot be executed by this Action.
> ///
>
> Executes the specified command through the console.
>
> - `#!command <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 <command>` - The command to execute as the console. Supports Placeholders, including PlaceholderAPI.

----

### `#!command CONNECT:<server>` { #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 <server>` - 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 <server>` - Name of the server the player should be connected to.

----

### `#!command TELEPORT:<world>:<x>:<y>:<z>` / `#!command TELEPORT:<x>:<y>:<z>` { #teleport }

> Teleports the player who clicked the hologram to the specified coordinates, and optionally world.
>
> - `#!command <world>` - Optional world to teleport the player to. Defaults to the World the player is in, if not specified.
> - `#!command <x>` - X coordinate to teleport the player to.
> - `#!command <y>` - Y coordinate to teleport the player to.
> - `#!command <z>` - Z coordinate to teleport the player to.
: Teleports the player who clicked the hologram to the specified coordinates, and optionally world.

- `#!command <world>` - Optional world to teleport the player to. Defaults to the World the player is in, if not specified.
- `#!command <x>` - X coordinate to teleport the player to.
- `#!command <y>` - Y coordinate to teleport the player to.
- `#!command <z>` - Z coordinate to teleport the player to.

----

### `#!command SOUND:<sound>:<volume>:<pitch>` / `#!command SOUND:<sound>` { #sound }

> Plays the specified sound, optionally with a set volume and pitch, to the player who clicked the Hologram.
>
> - `#!command <sound>` - 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 <volume>` - Optional volume to set. Default if not set is `1.0`.
> - `#!command <pitch>` - 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 <sound>` - 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 <volume>` - Optional volume to set. Default if not set is `1.0`.
- `#!command <pitch>` - Optional pitch to set. Default if not set is `1.0`.

----

### `#!command PERMISSION:<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 <permission>` - 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 <permission>` - The permission to check.

----

### `#!command NEXT_PAGE:<hologram>` / `NEXT_PAGE` { #next_page }

> Changes the page of the (optionally specified) Hologram to the next one, if one is available.
>
> - `#!command <hologram>` - 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 <hologram>` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set.

----

### `#!command PREV_PAGE:<hologram>` / `PREV_PAGE` { #prev_page }

> Changes the page of the (optionally specified) Hologram to the previous page, if one is available.
>
> - `#!command <hologram>` - 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 <hologram>` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set.

----

### `#!command PAGE:<hologram>:<page>` / `#!command PAGE:<page>` { #page }

> Changes to the specified page on the (optionally specified) Hologram, if one is available.
>
> - `#!command <hologram>` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set.
> - `#!command <page>` - Page to switch to on the Hologram.
: Changes to the specified page on the (optionally specified) Hologram, if one is available.
- `#!command <hologram>` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set.
- `#!command <page>` - Page to switch to on the Hologram.
70 changes: 37 additions & 33 deletions docs/general/animations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ Custom animations can be configured in files and the process of doing so is expl

## Format

> ```command
> <#ANIM:<name>>Text</#ANIM>
> <#ANIM:<name>:<args>>Text</#ANIM>
> ```
:
```command
<#ANIM:<name>>Text</#ANIM>
<#ANIM:<name>:<args>>Text</#ANIM>
```

/// note
To use placeholders inside animations you need to enable `allow-placeholders-inside-animations` in the [`config.yml`](configuration/config.md).
Expand All @@ -26,44 +27,47 @@ There are some premade animations you can use, that will work with any text.

### Colors

> ```command
> <#ANIM:colors>Text</#ANIM>
> 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</#ANIM>
```

### Wave

> ```command
> <#ANIM:wave:<color1>,<color2>>Text</#ANIM>
> ```
/// example
```command
<#ANIM:wave:&f,&b&l>Text</#ANIM>
```
///
: Colors the text in `#!command <color1>` and makes `#!command <color2>` move through the text.
```command
<#ANIM:wave:<color1>,<color2>>Text</#ANIM>
```

/// example
```command
<#ANIM:wave:&f,&b&l>Text</#ANIM>
```
///

### Burn

> ```command
> <#ANIM:burn:<color1>,<color2>>Text</#ANIM>
> ```
/// example
```command
<#ANIM:burn:&f,&b&l>Text</#ANIM>
```
///
: Colors the text in `#!command <color1>` and changes it to `#!command <color2>` from left to right.
```command
<#ANIM:burn:<color1>,<color2>>Text</#ANIM>
```

/// example
```command
<#ANIM:burn:&f,&b&l>Text</#ANIM>
```
///

### Typewriter

> ```command
> <#ANIM:typewriter>Text</#ANIM>
> ```
: Writes the provided text one character at a time.
```command
<#ANIM:typewriter>Text</#ANIM>
```

### Scroll

> ```command
> <#ANIM:scroll>Text</#ANIM>
> ```
: Scrolls through the provided text. The length is set to `<text length> / 3 * 2`.
```command
<#ANIM:scroll>Text</#ANIM>
```
40 changes: 22 additions & 18 deletions docs/general/commands/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -18,38 +20,40 @@ For a list of all available subcommands run the following command:

### `#!command /dh f disable <feature>` { #dh-f-disable }

> Aliases: `off`
>
> Disables a Feature.
>
> - `#!command <feature>` - The feature to disable.
: **Aliases:** `off`
Disables a Feature.
- `#!command <feature>` - The feature to disable.

----

### `#!command /dh f enable <feature>` { #dh-f-enable }

> Aliases: `on`
>
> Enables a Feature.
>
> - `#!command <feature>` - The feature to enable.
: **Aliases:** `on`
Enables a Feature.
- `#!command <feature>` - The feature to enable.

----

### `#!command /dh f info <feature>` { #dh-f-info }

> Gives information about a specific feature.
>
> - `#!command <feature>` - The feature to retrieve infos about.
: Gives information about a specific feature.

- `#!command <feature>` - 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 <feature>` { #dh-f-reload }

> Reloads a specific feature.
>
> - `#!command <feature>` - The feature to reload.
: Reloads a specific feature.
- `#!command <feature>` - The feature to reload.
26 changes: 14 additions & 12 deletions docs/general/commands/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: General
description: General commands of DecentHolograms
---

--8<-- "arguments.md"

## Commands

/// info | Command help
Expand All @@ -16,30 +18,30 @@ For a list of available subcommands run the following command:

### `#!command /dh convert <plugin> [file]` { #dh-convert }

> Converts holograms from another hologram plugin.
> The hologram plugin does not have to be on the server. Only its files!
>
> - `#!command <plugin>` - 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 <plugin>` - 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.
: **Aliases:** `about`, `ver`
Shows some info about your current DecentHolograms version.
Loading

0 comments on commit 59d92a7

Please sign in to comment.