NightCore

https://nightexpressdev.com/nightcore/
Admin
NightCore is a lightweight library providing utilities for Minecraft plugin development, including...
Tokens:3,693
Snippets:82
Trust Score:6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Gradient Colored Text

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Apply a color gradient to text, specifying start and end colors. Colors can be names or HEX values.

```text
<gradient:#00ff00:#00ffff>Hello world!</gradient>
```

--------------------------------

### Clickable Text with Actions

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Make text clickable to trigger actions like running a command or copying text to the clipboard. Ensure the action and value are correctly formatted.

```text
<click:run_command:"/seed">Click</click> to show the world seed!
```

```text
Click <click:copy_to_clipboard:"Haha you suck"> this </click>to copy your score!
```

--------------------------------

### Set Item Lore

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Adds descriptive lines to the item's tooltip. Each line can have its own formatting.

```yaml
Lore:
- '<gray>Hello world</gray>'
- '<white>Example of lore line</white>'
```

--------------------------------

### Applying Text Decorations

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Add styles like bold, italic, underlined, strikethrough, or obfuscated to text. Aliases are available for most decorations.

```text
<underlined>This is <bold>important</bold>!
```

--------------------------------

### Add NightCore Maven Dependency

Source: https://nightexpressdev.com/nightcore/developer-api

Import the NightCore library into your project by adding the provided repository and dependency configurations to your Maven `pom.xml` file. Replace `{VERSION}` with the latest available version.

```xml
<repository>
  <id>nightexpress-releases</id>
  <url>https://repo.nightexpressdev.com/releases</url>
</repository>

<dependency>
  <groupId>su.nightexpress.nightcore</groupId>
  <artifactId>main</artifactId>
  <version>{VERSION}</version>
</dependency>
```

--------------------------------

### Set Display Name

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Sets the name that appears in the game. Supports color and formatting codes.

```yaml
Display_Name: '<red><b>Custom Item</b></red>'
```

--------------------------------

### Coloring Text with Verbose Color Format

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Use a more explicit format for defining colors, accepting color names or HEX values. Aliases `colour` and `c` are supported.

```text
<color:#ff0000>Hello world!</color>
```

```text
<c:#ff00ff>Hello world!</c>
```

--------------------------------

### Set Item Material

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Specifies the base material for the item. This is a required field.

```yaml
Material: diamond_sword
```

--------------------------------

### Coloring Text with Color Names

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Apply predefined or custom colors to text using color names. Ensure the color name exists in your `color_schemes.yml` or is a valid HEX value.

```text
<red>Hello <blue>world!</blue></red>
```

```text
<green>Hello world!</green>
```

```text
<#00ff00>R G B!
```

--------------------------------

### Set Item Amount

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Defines the quantity of the item. This can be overridden by plugins.

```yaml
Amount: 64
```

--------------------------------

### Set Custom Item Model Path

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Specifies the path to a custom item model within a resource pack.

```yaml
Model:
  Path: 'custompack:custom_model'
```

--------------------------------

### Hover Text with Information

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Display custom text or item information when a player hovers over the component. Supports `show_text` and `show_item` actions.

```text
<hover:show_text:"<red>test">TEST
```

--------------------------------

### Set Custom Tooltip Style

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Applies a custom style to the item's tooltip, referencing a style defined in a resource pack.

```yaml
Tooltip:
  Style: 'custompack:custom_style'
```

--------------------------------

### Resetting Text Formatting

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Close all active formatting tags (color, decoration, etc.) and reset to default. The alias `r` can be used.

```text
<yellow><bold>Hello <reset>world!
```

--------------------------------

### Enable Enchant Glint

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Applies the enchanted glint effect to an item without adding any actual enchantments.

```yaml
Enchant_Glint: true
```

--------------------------------

### Customize Message Options

Source: https://nightexpressdev.com/nightcore/configuration/language

Message options are enclosed in square brackets and placed before the message text. They allow for advanced customization like adding sounds, controlling prefixes, and setting message types.

```yaml
SomeMessage: '[sound="minecraft:entity.villager.no;0.8;1.0"]You dont have permission to do that!'
```

--------------------------------

### Set Item Color

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Sets the color for specific items like leather armor, potions, and firework stars using RGB values.

```yaml
Color: 255,0,0 # R,G,B
```

--------------------------------

### Translatable Text with Fallback

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Display translatable text, providing a fallback string if the translation key is not found. Aliases `tr_or` and `translate_or` are available.

```text
You should get a <lang_or:block.minecraft.diamond_block:'Dirt Block'>!
```

--------------------------------

### Apply Custom Skin Texture

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Applies a custom skin texture to player head items using a URL. Textures can be found at Minecraft-Heads.

```yaml
SkinURL: 'https://textures.minecraft.net/texture/ddcb720982b3dd3cd902d9d6bae73d4369b6668cc6a98ed6f570da37f60a29d1'
```

--------------------------------

### Make Item Unbreakable

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Configures the item to be unbreakable, preventing durability loss.

```yaml
Durabilities:
  Unbreakable: false
```

--------------------------------

### Add Enchantments to Item

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Adds enchantments to the item, including custom enchantments if registered on the server.

```yaml
Enchants:
  minecraft:unbreaking: 1
  minecraft:fortune: 10
  excellentenchants:venom: 3
```

--------------------------------

### Displaying Translatable Text

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Show Minecraft messages using the player's locale. Aliases `translation`, `translate`, and `tr` are supported.

```text
You got a <lang:block.minecraft.diamond_block>!
```

--------------------------------

### Hide Item Tooltip

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Completely hides the item's tooltip from being displayed.

```yaml
Hide_Tooltip: true
```

--------------------------------

### Add Line Breaks to Messages

Source: https://nightexpressdev.com/nightcore/configuration/language

Use the '<br>' tag within your message strings to insert new lines. This is useful for messages that need to span multiple lines for better readability.

```yaml
Message: 'You dont have permissions<br>to do that!'
```

--------------------------------

### Set Item Durability Damage

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Sets the current damage value for items that have durability.

```yaml
Durabilities:
  Damage: 20
```

--------------------------------

### Set Item Name

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Sets the internal item name, which differs from the display name. It cannot be edited by an anvil and is not styled with italics.

```yaml
Item_Name: '<red><b>Custom Item</b></red>'
```

--------------------------------

### Set Custom Model Data

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Assigns a numerical identifier for custom item models.

```yaml
Model:
  Data: 10010
```

--------------------------------

### Changing Text Font

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Alter the font of the text using a namespaced key. Defaults to the 'minecraft' font. Custom fonts can be loaded from resource packs.

```text
Nothing <font:uniform>Uniform <font:alt>Alt </font> Uniform
```

```text
<font:myfont:custom_font>Uses a custom font from a resource pack</font>
```

--------------------------------

### Hide Item Components

Source: https://nightexpressdev.com/nightcore/configuration/item-formation

Hides specific item components, such as attributes, from being displayed in the tooltip.

```yaml
Hide_Components: true
```

--------------------------------

### Inserting Newline Characters

Source: https://nightexpressdev.com/nightcore/configuration/text-formation

Insert a line break within the text. The alias `br` is supported. This can also be used within hover text.

```text
Let me insert a <newline>line break here.
```

```text
<hover:show_text:"<red>Hover with a<br><green>line break">Text with<br>line break</hover>
```
Tokens:
Raw