zTextGenerator

https://maxlego08.gitbook.io/ztextgenerator
Admin
zTextGenerator is a plugin designed to enhance in-game inventories and menus by adding beautiful,...
Tokens:14,468
Snippets:115
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Full Text Example with Options (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

A comprehensive YAML example showcasing a text definition with various optional configurations, including title, alignment, alphabet, inventory settings, and multi-line content with specific alphabets.

```yaml
- name: "example-both"
  title: "<dark_gray>Lorem Ipsum<white>"
  alignment: LEFT
  alphabet: "tiny"
  inventory-size: 45
  inventory-name: ":offset_-48::generic_5::offset_-162:"
  lines:
    - alphabet: "normal"
      element: "Lorem ipsum dolor sit amet,"
    - "consectetur adipiscing elit. Integer eleifend"
    - "odio ut turpis faucibus, ac laoreet ante"
    - "maximus."
    - alphabet: "normal"
      element: "Duis lacinia nibh a odio accumsan"
    - ""
    - "bibendum. Vestibulum malesuada ac lacus eu"
    - "consequat. Sed lobortis quis tortor sed"
    - "mollis. Praesent at nibh sem."
```

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

### Add Gradle Repository for ZTextGenerator API

Source: https://maxlego08.gitbook.io/ztextgenerator/developper/getting-started

Configure your Gradle project to use the GroupeZ releases repository for the ZTextGenerator API. This is typically done in your build.gradle or settings.gradle file.

```kotlin
maven {
    name = "groupezReleases"
    url = uri("https://repo.groupez.dev/releases")
}
```

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

### Define Start Offset (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Sets the initial offset for the book's content, affecting its starting position or rendering.

```yaml
start-offset: 10
```

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

### Configure Start Offset (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML snippet to define the 'start-offset' applied before the inventory name. This is particularly relevant for integrations like ItemsAdder.

```yaml
start-offset: -48
```

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

### Add Maven Repository for ZTextGenerator API

Source: https://maxlego08.gitbook.io/ztextgenerator/developper/getting-started

Configure your Maven project to use the GroupeZ releases repository to access the ZTextGenerator API. This involves adding a repository block to your pom.xml file.

```xml
<repository>
  <id>groupez-releases</id>
  <name>GroupeZ Repository</name>
  <url>https://repo.groupez.dev/releases</url>
</repository>
```

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

### Add Gradle Dependency for ZTextGenerator API

Source: https://maxlego08.gitbook.io/ztextgenerator/developper/getting-started

Add the ZTextGenerator API as an implementation dependency in your Gradle project. This makes the API available for use in your application.

```kotlin
implementation("fr.maxlego08.text:ztextgenerator-api:1.0.0")
```

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

### Display Text via Command (Shell)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

Shell command example for opening and displaying a text to a specific player. It includes optional parameters for animation type and speed.

```shell
/text open <player> <text> [<animation type>] [<speed>]
```

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

### Configure Inventory Name (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML example for setting the 'inventory-name', which defines the appearance or identifier of the inventory used for text display. It can be overridden by global settings.

```yaml
inventory-name: ":offset_-48::generic_5::offset_-162:"
```

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

### Configure Inventory Title (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML example for setting the 'title' of the inventory that displays the text. This title appears when the text is opened in an inventory format.

```yaml
title: "<dark_gray>Lorem Ipsum<white>"
```

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

### Add Maven Dependency for ZTextGenerator API

Source: https://maxlego08.gitbook.io/ztextgenerator/developper/getting-started

Include the ZTextGenerator API as a dependency in your Maven project. This allows your project to use the classes and methods provided by the API.

```xml
<dependency>
  <groupId>fr.maxlego08.text</groupId>
  <artifactId>ztextgenerator-api</artifactId>
  <version>1.0.0</version>
</dependency>
```

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

### Configure Text Name (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML example showing how to set a unique 'name' for a text. This name is used to identify and reference the text within the zTextGenerator system.

```yaml
name: "example-both"
```

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

### Configure Text Alphabet (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML example for specifying the 'alphabet' to be used for rendering the text. This determines the character set and styling of the text displayed to the player.

```yaml
alphabet: "tiny"
```

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

### Configure End Offset (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML example for setting the 'end-offset' applied after the inventory name. Similar to start-offset, this is useful for specific plugin integrations.

```yaml
end-offset: -168
```

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

### Get Raw Text with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Retrieves the raw text content. This placeholder simply returns the provided text without any modifications or calculations.

```zTextGenerator
%ztextgenerator_text_<text>%
```

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

### Get Book Content with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Retrieves content from a specific page of a custom book created with zTextGenerator. Requires the book name and page number as arguments.

```zTextGenerator
%ztextgenerator_book_<book>_<page>%
```

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

### ZTextGenerator Centered Text Formatting

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

Configures a UI element with centered text using ZTextGenerator's formatting codes. This example shows how to apply offsets and use placeholders for dynamic content.

```yaml
name: ":offset_-48::generic_dark_full::offset_-168:<white>:offset_80:%ztextgenerator_center_normal_0_Hey how are you?%:offset_40:%ztextgenerator_center_normal_1_this is a centered placeholder%"
size: 54
```

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

### ZTextGenerator Left-Aligned Text Formatting

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

Configures a UI element with left-aligned text using ZTextGenerator's formatting codes. This example demonstrates the use of offsets and placeholders for text alignment.

```yaml
name: ":offset_-48::generic_dark_full::offset_-168:<white>%ztextgenerator_left_normal_0_Hey how are you?%%ztextgenerator_left_normal_1_this is a left placeholder%"
size: 54
```

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

### ZTextGenerator Right-Aligned Text Formatting

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

Configures a UI element with right-aligned text using ZTextGenerator's formatting codes. This example showcases offsets and placeholders for achieving right alignment.

```yaml
name: ":offset_-48::generic_dark_full::offset_-8:<white>%ztextgenerator_right_normal_0_Hey how are you?%%ztextgenerator_right_normal_1_this is a right placeholder%"
size: 54
```

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

### Get Inventory Title Length with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Retrieves the length of an inventory title. This placeholder is specifically designed for calculating the width of titles within an inventory context.

```zTextGenerator
%ztextgenerator_title_length_<title>%
```

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

### Get Text Length with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Calculates the visual length of text based on a specified alphabet. Each alphabet defines custom character widths, enabling precise text alignment and layout control.

```zTextGenerator
%ztextgenerator_length_<alphabet>_<text>%
```

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

### Display Book via zMenu Action (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Configuration for opening a book within the zMenu plugin using the 'book open' action, specifying the book and page.

```yaml
actions:
  - type: book open
    # Book name
    book: example
    # Book page
    page: 1
```

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

### Display Book via Placeholder (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Placeholder format to retrieve and display the content of a book, including both left and right pages.

```yaml
%ztextgenerator_book_<book name>_<page>%
```

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

### Display Book via Command (Shell)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Command to open a specific book and page for a player. Requires player name, book name, and page number.

```shell
/text book <player> <book name> <page>
```

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

### zMenu Action Configuration for Text Display

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

This YAML configuration demonstrates how to use zTextGenerator within zMenu to display text with specified animations. It includes options for text name, animation type (NONE, LETTER_BY_LETTER, WORD_BY_WORD), and animation delay.

```yaml
actions:
  - type: text open
    # Text name
    text: example-normal
    # NONE, No animation, the full text is displayed immediately.
    # LETTER_BY_LETTER, Reveals the text character by character.
    # WORD_BY_WORD, Reveals the text word by word.
    animation: NONE
    # Delay between each frame in ticks for the animation
    animation-delay: 2 # 2 ticks = 10 frames per second
```

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

### ZTextGenerator Actions: Add, Remove, Close, Open Book/Dialogue/Text

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

Demonstrates common actions within ZTextGenerator, including adding and removing values, closing interfaces, and opening books or dialogues with various text display animations. These actions are typically configured in YAML files.

```yaml
name: ":offset_-48::exemple_actions::offset_-56:<white>%ztextgenerator_right_normal_0_{ztextgenerator_test}%"
size: 54
items:
  add:
    slot: 14
    item:
      material: PAPER
      model-id: 1
      name: "<gradient:#34d399:#22c55e><bold>Add Value</bold></gradient>"
      lore:
        - "&7Add a new entry to the generator."
        - "<green>✔ Action: ztextgenerator-add-value"
    actions:
      - type: ztextgenerator-add-value
      - type: refresh inventory

  remove:
    slot: 12
    item:
      material: PAPER
      model-id: 1
      name: "<gradient:#f97316:#ef4444><bold>Remove Value</bold></gradient>"
      lore:
        - "&7Remove the last recorded value."
        - "<red>✖ Action: ztextgenerator-remove-value"
    actions:
      - type: ztextgenerator-remove-value
      - type: refresh inventory

  close:
    slot: 8
    item:
      material: PAPER
      model-id: 1
      name: "<gradient:#f43f5e:#fb7185><bold>Close</bold></gradient>"
    actions:
      - type: close

  open-book:
    slots:
      - 27-30
    item:
      material: PAPER
      model-id: 1
      name: "<gradient:#38bdf8:#0ea5e9><bold>Open Book</bold></gradient>"
      lore:
        - "&7Display the content of the &fexample book&7."
        - "&8Perfect for tutorials or stories."
        - "<aqua>📖 Book: example (page 1)"
    actions:
      - type: book open
        # Book name
        book: example
        # Book page
        page: 1

  open-dialog:
    slots:
      - 32-35
    item:
      material: PAPER
      model-id: 1
      name: "<gradient:#a855f7:#6366f1><bold>Open Dialogue</bold></gradient>"
      lore:
        - "&7Launch a dialogue with a word-by-word animation."
        - "&8Perfect for NPCs or quest scenes."
        - "<light_purple>💬 Text: example-dialogue"
        - "<gray>Animation: WORD_BY_WORD (2 ticks)"
    actions:
      - type: text open
        # Text name
        text: example-dialogue
        # NONE, No animation, the full text is displayed immediately.
        # LETTER_BY_LETTER, Reveals the text character by character.
        # WORD_BY_WORD, Reveals the text word by word.
        animation: WORD_BY_WORD
        # Delay between each frame in ticks for the animation
        animation-delay: 2 # 2 ticks = 10 frames per second

  open-text:
    slots:
      - 36-39
    item:
      material: PAPER
      model-id: 1
      name: "<gradient:#facc15:#f97316><bold>Open Text (Normal)</bold></gradient>"
      lore:
        - "&7Display a text using the &fstandard alphabet&7."
        - "&8Instant display, no animation."
        - "<gold>📝 Text: example-normal"
    actions:
      - type: text open
        # Text name
        text: example-normal
        # NONE, No animation, the full text is displayed immediately.
        # LETTER_BY_LETTER, Reveals the text character by character.
        # WORD_BY_WORD, Reveals the text word by word.
        animation: NONE
        # Delay between each frame in ticks for the animation
        animation-delay: 2 # 2 ticks = 10 frames per second

  open-text-tiny:
    slots:
      - 41-44
    item:
      material: PAPER
      model-id: 1
      name: "<gradient:#14f195:#00d18c><bold>Open Text (Tiny)</bold></gradient>"
      lore:
        - "&7Display a text using the &fsmall alphabet&7."
        - "&8Useful for compact titles or signatures."
        - "<green>📝 Text: example-tiny"
    actions:
      - type: text open
        # Text name
        text: example-tiny
        # NONE, No animation, the full text is displayed immediately.
        # LETTER_BY_LETTER, Reveals the text character by character.
        # WORD_BY_WORD, Reveals the text word by word.
        animation: NONE
        # Delay between each frame in ticks for the animation
        animation-delay: 2 # 2 ticks = 10 frames per second

```

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

### Add and Remove Value Actions for zTextGenerator Placeholder

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/zmenu

Demonstration actions (`ztextgenerator-add-value`, `ztextgenerator-remove-value`) used to dynamically modify the value of a zTextGenerator placeholder (e.g., %ztextgenerator_test%) within zMenu inventory files.

```yaml
# Example usage within an inventory file:
# %ztextgenerator_test%
```

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

### Configure Inventory Size (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML snippet to specify the 'inventory-size' for the text display. This value is typically taken from the file or the global config.yml.

```yaml
inventory-size: 45
```

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

### Open Text Action with Animation in zMenu

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/zmenu

Enables opening text with various animation types (NONE, LETTER_BY_LETTER, WORD_BY_WORD) and controlling the animation delay. Configuration is done via YAML.

```yaml
actions:
  - type: text open
    # Text name
    text: example-dialogue
    # NONE, No animation, the full text is displayed immediately.
    # LETTER_BY_LETTER, Reveals the text character by character.
    # WORD_BY_WORD, Reveals the text word by word.
    animation: WORD_BY_WORD
    # Delay between each frame in ticks for the animation
    animation-delay: 2 # 2 ticks = 10 frames per second
```

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

### Define Offset Between Pages (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Sets the spacing or offset between the left and right pages of the book.

```yaml
offset-between: 10
```

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

### Define Detailed Book Page with Line Formatting (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Allows for detailed page definition where each line can have custom alignment, alphabet, and content, including color codes.

```yaml
pages:
  - page: 1
    left:
      - alignment: LEFT
        alphabet: "normal"
        content: "<black>Line 1"
      - alignment: RIGHT
        alphabet: "normal"
        content: "<black>Line 2"
      - alignment: CENTER
        alphabet: "normal"
        content: "<black>Line 3"
      - alignment: LEFT
        alphabet: "normal"
        content: "<black>Line 4"
      - alignment: RIGHT
        alphabet: "normal"
        content: "<black>Line 5"
      - alignment: CENTER
        alphabet: "normal"
        content: "<black>Line 6"
      - alignment: LEFT
        alphabet: "normal"
        content: "<black>Line 7"
    right: "<black>Lorem ipsum dolor sit amet consectetur adipisicing elit. Quisquam, quibusdam."
```

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

### Define Inventory Name (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Sets the name for the book's inventory, often used for internal referencing or item display.

```yaml
inventory-name: ":offset_-48::exemple_book::offset_-250:"
```

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

### Define Simple Book Page (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Defines a book page with simple text content for both left and right sides. Automatic line wrapping is applied.

```yaml
pages:
  - page: 1
    left: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce ultrices felis a libero tempus, at dignissim arcu vehicula. Vestibulum id consequat risus. Vestibulum viverra condimentum consequat. Aenean nulla libero, lacinia id iaculis in, lacinia lobortis enim."
    right: "Etiam sit amet dictum nunc. Nam eget placerat turpis. Suspendisse ullamcorper molestie metus vitae pharetra. Phasellus varius, sem vel tristique placerat, nisl nibh consectetur eros, quis tincidunt augue leo a risus."
```

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

### Define Text Alignment (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Determines the alignment of the text within the book pages. Accepts LEFT, CENTER, or RIGHT. Defaults to LEFT.

```yaml
alignment: LEFT
```

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

### Configure Text Language (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML snippet demonstrating how to set the 'language' for a text, allowing for multi-language support. zTextGenerator will display the appropriate text based on the player's language settings.

```yaml
language: fr_fr
```

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

### Define Book Language (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Specifies the language of the book. If not provided, it defaults to the language set in the main config.yml.

```yaml
language: en_us
```

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

### Display Localized Text with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Shows text that automatically adapts to the player's language. If a localized version of the text key is not found, the default text is displayed. This ensures a consistent user experience across different languages.

```zTextGenerator
%ztextgenerator_text_welcome_message%
```

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

### Define Book Name (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Specifies the name of the book. This is a required element for book creation.

```yaml
name: "example"
```

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

### Define a Basic Text Structure (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

This YAML snippet demonstrates the fundamental structure required for defining a text in zTextGenerator. It includes the mandatory 'name', 'alphabet', and 'lines' fields.

```yaml
texts:
  - name: 'test'
    alphabet: 'normal'
    lines:
      - 'test'
```

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

### Define Text Lines (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML snippet illustrating how to define the 'lines' of text to be displayed. Each item in the list represents a line of text, and custom alphabets can be specified per line.

```yaml
lines:
  - "Lorem ipsum dolor sit amet, consectetur"
  - "adipiscing elit. Integer eleifend odio ut"
```

```yaml
- alphabet: "normal"
  element: "Lorem ipsum dolor sit amet,"
- "consectetur adipiscing elit. Integer eleifend"
- "odio ut turpis faucibus, ac laoreet ante"
- "maximus."
- alphabet: "normal"
  element: "Duis lacinia nibh a odio accumsan"
- ""
- "bibendum. Vestibulum malesuada ac lacus eu"
- "consequat. Sed lobortis quis tortor sed"
- "mollis. Praesent at nibh sem."
```

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

### Configure Inventory Title Alphabet (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/alphabets

The 'inventory-title' alphabet is a default configuration used by zTextGenerator for measuring character widths in Minecraft inventory titles. It should not be modified or deleted as it's essential for the plugin's functionality. This YAML file defines character names and their corresponding pixel lengths.

```yaml
# Est utilisé pour gérer les titres des inventaires, ne pas supprimer ou modifier
name: "inventory-title"
font-infos:
  - char: 'ç'
    length: 5
  - char: 'Ç'
    length: 5
  - char: 'A'
    length: 6
  - char: 'a'
    length: 6
  - char: 'B'
    length: 6
  - char: 'b'
    length: 6
  - char: 'C'
    length: 6
  - char: 'c'
    length: 6
  - char: 'D'
    length: 6
  - char: 'd'
    length: 6
  - char: 'E'
    length: 6
  - char: 'e'
    length: 6
  - char: 'F'
    length: 6
  - char: 'f'
    length: 5
  - char: 'G'
    length: 6
  - char: 'g'
    length: 6
  - char: 'H'
    length: 6
  - char: 'h'
    length: 6
  - char: 'I'
    length: 4
  - char: 'i'
    length: 2
  - char: 'î'
    length: 4
  - char: 'Î'
    length: 4
  - char: 'ï'
    length: 4
  - char: 'Ï'
    length: 4
  - char: 'J'
    length: 6
  - char: 'j'
    length: 6
  - char: 'K'
    length: 6
  - char: 'k'
    length: 5
  - char: 'L'
    length: 6
  - char: 'l'
    length: 3
  - char: 'M'
    length: 6
  - char: 'm'
    length: 6
  - char: 'N'
    length: 6
  - char: 'n'
    length: 6
  - char: 'O'
    length: 6
  - char: 'o'
    length: 6
  - char: 'P'
    length: 6
  - char: 'p'
    length: 6
  - char: 'Q'
    length: 6
  - char: 'q'
    length: 6
  - char: 'R'
    length: 6
  - char: 'r'
    length: 6
  - char: 'S'
    length: 6
  - char: 's'
    length: 6
  - char: 'T'
    length: 6
  - char: 't'
    length: 4
  - char: 'U'
    length: 6
  - char: 'u'
    length: 6
  - char: 'V'
    length: 6
  - char: 'v'
    length: 6
  - char: 'W'
    length: 6
  - char: 'w'
    length: 6
  - char: 'X'
    length: 6
  - char: 'x'
    length: 6
  - char: 'Y'
    length: 6
  - char: 'y'
    length: 6
  - char: 'Z'
    length: 6
  - char: 'z'
    length: 6
  - char: '1'
    length: 4
  - char: '2'
    length: 6
  - char: '3'
    length: 6
  - char: '4'
    length: 6
  - char: '5'
    length: 6
  - char: '6'
    length: 6
  - char: '7'
    length: 6
  - char: '8'
    length: 6
  - char: '9'
    length: 6
  - char: '0'
    length: 6
  - char: '!'
    length: 2
  - char: '@'
    length: 6
  - char: '#'
    length: 6
  - char: '$'
    length: 6
  - char: '%'
    length: 6
  - char: '^'
    length: 6
  - char: '&'
    length: 6
  - char: '*'
    length: 6
  - char: '('
    length: 5
  - char: ')'
    length: 5
  - char: '-'
    length: 6
  - char: '_'
    length: 6
  - char: '+'
    length: 6
  - char: '='
    length: 6
  - char: '{'
    length: 5
  - char: '}'
    length: 5
  - char: '['
    length: 4
  - char: ']'
    length: 4
  - char: ':'
    length: 2
  - char: ';'
    length: 2
  - char: '"'
    length: 4
  - char: "'"
    length: 1
  - char: '<'
    length: 5
  - char: '>'
    length: 5
  - char: '?'
    length: 6
  - char: '/'
    length: 6
  - char: '\\'
    length: 6
  - char: '|'
    length: 2
  - char: '~'
    length: 6
  - char: '`'
    length: 3
  - char: '.'
    length: 3
  - char: ','
    length: 2
  - char: ' '
    length: 4
```

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

### Define Book Alphabet (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Sets the default alphabet to be used for the book's text. This can influence character rendering and formatting.

```yaml
alphabet: "normal"
```

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

### Test Single Character Alphabet Display in Minecraft

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/alphabets

Tests a single character's display within a Minecraft inventory using a specified alphabet. This command is crucial for verifying character alignment and appearance.

```minecraft_command
/text alphabet letter <letter> <alphabet> <letters by line> <max line> <letter length> <inventory title> <inventory size>
```

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

### Define Left Page Width (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Specifies the width of the left-hand page in the book.

```yaml
left-size: 110
```

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

### Define Right Page Width (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/books

Specifies the width of the right-hand page in the book.

```yaml
right-size: 110
```

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

### Configure Tiny Font Character Lengths (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/alphabets

This YAML configuration defines the 'tiny' font for ZTextGenerator. It specifies the visual length for each character, impacting how text is rendered. This is crucial for consistent typography across different platforms.

```yaml
name: "tiny"
font-infos:
  - char: 'ç'
    length: 3
  - char: 'Ç'
    length: 3
  - char: 'A'
    length: 4
  - char: 'a'
    length: 4
  - char: 'B'
    length: 4
  - char: 'b'
    length: 4
  - char: 'C'
    length: 4
  - char: 'c'
    length: 4
  - char: 'D'
    length: 4
  - char: 'd'
    length: 4
  - char: 'E'
    length: 4
  - char: 'e'
    length: 4
  - char: 'F'
    length: 4
  - char: 'f'
    length: 3
  - char: 'G'
    length: 4
  - char: 'g'
    length: 4
  - char: 'H'
    length: 4
  - char: 'h'
    length: 4
  - char: 'I'
    length: 3
  - char: 'i'
    length: 2
  - char: 'î'
    length: 3
  - char: 'Î'
    length: 3
  - char: 'ï'
    length: 3
  - char: 'Ï'
    length: 3
  - char: 'J'
    length: 4
  - char: 'j'
    length: 4
  - char: 'K'
    length: 4
  - char: 'k'
    length: 3
  - char: 'L'
    length: 4
  - char: 'l'
    length: 2
  - char: 'M'
    length: 4
  - char: 'm'
    length: 4
  - char: 'N'
    length: 4
  - char: 'n'
    length: 4
  - char: 'O'
    length: 4
  - char: 'o'
    length: 4
  - char: 'P'
    length: 4
  - char: 'p'
    length: 4
  - char: 'Q'
    length: 4
  - char: 'q'
    length: 4
  - char: 'R'
    length: 4
  - char: 'r'
    length: 4
  - char: 'S'
    length: 4
  - char: 's'
    length: 4
  - char: 'T'
    length: 4
  - char: 't'
    length: 3
  - char: 'U'
    length: 4
  - char: 'u'
    length: 4
  - char: 'V'
    length: 4
  - char: 'v'
    length: 4
  - char: 'W'
    length: 4
  - char: 'w'
    length: 4
  - char: 'X'
    length: 4
  - char: 'x'
    length: 4
  - char: 'Y'
    length: 4
  - char: 'y'
    length: 4
  - char: 'Z'
    length: 4
  - char: 'z'
    length: 4
  - char: '1'
    length: 2
  - char: '2'
    length: 4
  - char: '3'
    length: 4
  - char: '4'
    length: 4
  - char: '5'
    length: 4
  - char: '6'
    length: 4
  - char: '7'
    length: 4
  - char: '8'
    length: 4
  - char: '9'
    length: 4
  - char: '0'
    length: 4
  - char: '!'
    length: 2
  - char: '@'
    length: 4
  - char: '#'
    length: 4
  - char: '$'
    length: 4
  - char: '%'
    length: 4
  - char: '^'
    length: 4
  - char: '&'
    length: 4
  - char: '*'
    length: 3
  - char: '('
    length: 3
  - char: ')'
    length: 3
  - char: '-'
    length: 3
  - char: '_'
    length: 4
  - char: '+'
    length: 4
  - char: '='
    length: 4
  - char: '{'
    length: 3
  - char: '}'
    length: 3
  - char: '['
    length: 3
  - char: ']'
    length: 3
  - char: ':'
    length: 2
  - char: ';'
    length: 2
  - char: '"'
    length: 3
  - char: "'"
    length: 2
  - char: '<'
    length: 3
  - char: '>'
    length: 3
  - char: '?'
    length: 4
  - char: '/'
    length: 4
  - char: '\\'
    length: 4
  - char: '|'
    length: 1
  - char: '~'
    length: 4
  - char: '`'
    length: 2
  - char: '.'
    length: 2
  - char: ','
    length: 2
  - char: ' '
    length: 4
  - char: 'é'
    length: 4
  - char: 'è'
    length: 4
  - char: 'à'
    length: 4
  - char: 'â'
    length: 4
  - char: 'Â'
    length: 4
  - char: '²'
    length: 3
  - char: '€'
    length: 4
font-transformations:
  specials:
    - char: "'"
      replacement: 'apostrophe_t_%height%'
    - char: '.'
      replacement: 'dot_t_%height%'
    - char: ':'
      replacement: 'colon_t_%height%'
    - char: ';'
      replacement: 'semicolon_t_%height%'
    - char: ','
      replacement: 'comma_t_%height%'
    - char: '-'
      replacement: 'dash_t_%height%'
    - char: '"'
      replacement: 'quote_t_%height%'
    - char: '?'
      replacement: 'question_mark_t_%height%'
    - char: '!'
      replacement: 'exclamation_mark_t_%height%'
    - char: '('
      replacement: 'parenthesis_open_t_%height%'
    - char: ')'
      replacement: 'parenthesis_close_t_%height%'
    - char: '/'
      replacement: 'slash_t_%height%'
    - char: '_'
      replacement: 'underscore_t_%height%'
    - char: '*'
      replacement: 'asterisk_t_%height%'
    - char: '^'
      replacement: 'caret_t_%height%'
    - char: '$'
      replacement: 'dollar_t_%height%'
    - char: '€'
      replacement: 'euro_t_%height%'
    - char: '¤'
      replacement: 'currency_t_%height%'
    - char: '<'
      replacement: 'less_than_t_%height%'
    - char: '>'
      replacement: 'greater_than_t_%height%'
    - char: '°'
      replacement: 'degree_t_%height%'
    - char: '='
      replacement: 'equal_t_%height%'
    - char: '+'
      replacement: 'plus_t_%height%'
    - char: '['
      replacement: 'bracket_left_t_%height%'
    - char: ']'
      replacement: 'bracket_right_t_%height%'
    - char: '{'
      replacement: 'brace_left_t_%height%'
    - char: '}'
      replacement: 'brace_right_t_%height%'
    - char: '@'
      replacement: 'arob_t_%height%'
    - char: '#'
      replacement: 'htag_t_%height%'
    - char: '&'
      replacement: 'and_t_%height%'
    - char: '%'
      replacement: 'percent_t_%height%'
    - char: '²'

```

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

### Configure Maximum Line Length (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/texts

YAML snippet to set the 'length' for each line, primarily used for centered or right-aligned text. The default value is 160.

```yaml
length: 160
```

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

### Calculate Inventory Title Length with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Calculates the width of an inventory title. This is useful for precise text placement, such as centering or balancing text elements within GUI designs.

```zTextGenerator
%ztextgenerator_title_length_Main_Menu%
```

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

### Center Text with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Centers text within a specified height using a custom alphabet for width calculation. The offset is temporary and must be managed by the user. Useful for inventory titles and labels.

```zTextGenerator
%ztextgenerator_center_<alphabet>_<height>_<text>%
```

```yaml
name: ":offset_-48::generic_dark::offset_-168:<white>:offset_80:%ztextgenerator_center_normal_0_Hey how are you?%:offset_40:%ztextgenerator_center_normal_1_this is a centered placeholder%"
size: 54
```

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

### Validate Full Alphabet Display in Minecraft

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/alphabets

Displays all characters of a given alphabet in a Minecraft inventory for visual alignment checks. An optional delay can be set between character displays.

```minecraft_command
/text alphabet validation <alphabet> [<seconds>]
```

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

### Right-Align Text with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Displays text aligned to the right using a specified alphabet and line height. The offset is temporary and must be managed by the user. This is useful for creating structured interfaces.

```yaml
name: ":offset_-48::generic_dark::offset_-8:<white>%ztextgenerator_right_normal_0_Hey how are you?%%ztextgenerator_right_normal_1_this is a right placeholder%"
size: 54
```

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

### Configure Normal Font in ZTextGenerator (YAML)

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/alphabets

This YAML configuration defines the 'normal' font for ZTextGenerator. It includes 'font-infos' to specify the length of each character and 'font-transformations' to map special characters to their transformed representations, ensuring consistent output.

```yaml
name: "normal"
font-infos:
  - char: 'ç'
    length: 4
  - char: 'Ç'
    length: 4
  - char: 'A'
    length: 5
  - char: 'a'
    length: 5
  - char: 'B'
    length: 5
  - char: 'b'
    length: 5
  - char: 'C'
    length: 5
  - char: 'c'
    length: 5
  - char: 'D'
    length: 5
  - char: 'd'
    length: 5
  - char: 'E'
    length: 5
  - char: 'e'
    length: 5
  - char: 'F'
    length: 5
  - char: 'f'
    length: 4
  - char: 'G'
    length: 5
  - char: 'g'
    length: 5
  - char: 'H'
    length: 5
  - char: 'h'
    length: 5
  - char: 'I'
    length: 3
  - char: 'i'
    length: 2
  - char: 'î'
    length: 3
  - char: 'Î'
    length: 3
  - char: 'ï'
    length: 3
  - char: 'Ï'
    length: 3
  - char: 'J'
    length: 5
  - char: 'j'
    length: 5
  - char: 'K'
    length: 5
  - char: 'k'
    length: 4
  - char: 'L'
    length: 5
  - char: 'l'
    length: 2
  - char: 'M'
    length: 5
  - char: 'm'
    length: 5
  - char: 'N'
    length: 5
  - char: 'n'
    length: 5
  - char: 'O'
    length: 5
  - char: 'o'
    length: 5
  - char: 'P'
    length: 5
  - char: 'p'
    length: 5
  - char: 'Q'
    length: 5
  - char: 'q'
    length: 5
  - char: 'R'
    length: 5
  - char: 'r'
    length: 5
  - char: 'S'
    length: 5
  - char: 's'
    length: 5
  - char: 'T'
    length: 5
  - char: 't'
    length: 3
  - char: 'U'
    length: 5
  - char: 'u'
    length: 5
  - char: 'V'
    length: 5
  - char: 'v'
    length: 5
  - char: 'W'
    length: 5
  - char: 'w'
    length: 5
  - char: 'X'
    length: 5
  - char: 'x'
    length: 5
  - char: 'Y'
    length: 5
  - char: 'y'
    length: 5
  - char: 'Z'
    length: 5
  - char: 'z'
    length: 5
  - char: '1'
    length: 3
  - char: '2'
    length: 5
  - char: '3'
    length: 5
  - char: '4'
    length: 5
  - char: '5'
    length: 5
  - char: '6'
    length: 5
  - char: '7'
    length: 5
  - char: '8'
    length: 5
  - char: '9'
    length: 5
  - char: '0'
    length: 5
  - char: '!'
    length: 2
  - char: '@'
    length: 5
  - char: '#'
    length: 5
  - char: '$'
    length: 5
  - char: '%'
    length: 5
  - char: '^'
    length: 5
  - char: '&'
    length: 5
  - char: '*'
    length: 3
  - char: '('
    length: 4
  - char: ')'
    length: 4
  - char: '-'
    length: 3
  - char: '_'
    length: 5
  - char: '+'
    length: 5
  - char: '='
    length: 5
  - char: '{'
    length: 3
  - char: '}'
    length: 3
  - char: '['
    length: 3
  - char: ']'
    length: 3
  - char: ':'
    length: 2
  - char: ';'
    length: 2
  - char: '"'
    length: 3
  - char: "'"
    length: 2
  - char: '<'
    length: 4
  - char: '>'
    length: 4
  - char: '?'
    length: 5
  - char: '/'
    length: 5
  - char: '\\'
    length: 5
  - char: '|'
    length: 2
  - char: '~'
    length: 5
  - char: '`'
    length: 3
  - char: '.'
    length: 2
  - char: ','
    length: 2
  - char: ' '
    length: 4
  - char: 'é'
    length: 5
  - char: 'è'
    length: 5
  - char: 'à'
    length: 5
  - char: 'â'
    length: 5
  - char: 'Â'
    length: 5
  - char: '²'
    length: 4
  - char: '€'
    length: 5
font-transformations:
  specials:
    - char: "'"
      replacement: 'apostrophe_%height%'
    - char: '.'
      replacement: 'dot_%height%'
    - char: ':'
      replacement: 'colon_t_%height%'
    - char: ';'
      replacement: 'semicolon_%height%'
    - char: ','
      replacement: 'comma_%height%'
    - char: '-'
      replacement: 'dash_%height%'
    - char: '"'
      replacement: 'quote_%height%'
    - char: '?'
      replacement: 'question_mark_%height%'
    - char: '!'
      replacement: 'exclamation_mark_%height%'
    - char: '('
      replacement: 'parenthesis_open_%height%'
    - char: ')'
      replacement: 'parenthesis_close_%height%'
    - char: '/'
      replacement: 'slash_%height%'
    - char: '_'
      replacement: 'underscore_%height%'
    - char: '*'
      replacement: 'asterisk_%height%'
    - char: '^'
      replacement: 'caret_%height%'
    - char: '$'
      replacement: 'dollar_%height%'
    - char: '€'
      replacement: 'euro_%height%'
    - char: '¤'
      replacement: 'currency_%height%'
    - char: '<'
      replacement: 'less_than_%height%'
    - char: '>'
      replacement: 'greater_than_%height%'
    - char: '°'
      replacement: 'degree_%height%'
    - char: '='
      replacement: 'equal_%height%'
    - char: '+'
      replacement: 'plus_%height%'
    - char: '['
      replacement: 'bracket_left_%height%'
    - char: ']'
      replacement: 'bracket_right_%height%'
    - char: '{'
      replacement: 'brace_left_%height%'
    - char: '}'
      replacement: 'brace_right_%height%'
    - char: '@'
      replacement: 'arob_%height%'
    - char: '#'
      replacement: 'htag_%height%'
    - char: '&'
      replacement: 'and_%height%'
    - char: '%'
      replacement: 'percent_%height%'
    - char: '²'
      replacement: 'superscript_2_%height%'
    - char: 'ü'
      replacement: 'u_l_tr_%height%'

```

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

### Right Align Text with zTextGenerator

Source: https://maxlego08.gitbook.io/ztextgenerator/configurations/placeholders

Aligns text to the right within a specified height using a custom alphabet for width calculation. The offset is temporary and must be managed by the user. Suitable for various inventory layouts.

```zTextGenerator
%ztextgenerator_right_<alphabet>_<height>_<text>%
```
Tokens:
Raw