BedrockGUI v2

https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2
Admin
BedrockGUI v2 provides Bedrock-style forms (SIMPLE, MODAL, CUSTOM) for Minecraft servers running...
Tokens:4,979
Snippets:57
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Action Composition Example (BedrockGUI DSL)

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Demonstrates chaining multiple actions in sequence for a guided user experience. Includes messages, sounds, delays, and random element selection.

```yaml
message { - "&eStarting..." }
sound { - "ui.button.click" }
delay { - "1000" - "message:Step 2" }
random { - "title:Prize A" - "title:Prize B" }

```

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

### Command Binding Example (YAML)

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Binds a game command to open a specific BedrockGUI form. This example shows how to link the '/gui' command to the 'main_hub' form, including permissions and aliases.

```yaml
commands:
  gui:
    description: "Open the main BedrockGUI hub"
    permission: "bedrockgui.use"
    aliases: [ "menu", "hub", "main" ]
    form: "main_hub"

```

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

### Server Operations Example (BedrockGUI DSL)

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Shows how to execute server commands directly from BedrockGUI actions, such as teleporting a player or changing their gamemode. Uses placeholders for dynamic execution.

```yaml
server { - "tp {player} spawn" - "gamemode survival {player}" }

```

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

### Custom Form Configuration (YAML)

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Sets up a custom form with various interactive components like input fields, sliders, dropdowns, and toggles. Each component can have an optional action, and global actions are executed upon form submission. Supports placeholders.

```yaml
forms:
  feedback_form:
    type: "CUSTOM"
    title: "Feedback"
    components:
      name:
        type: "input"
        text: "Your name"
        placeholder: "Steve"
        default: ""
        action: |
          message {
            - "Thanks, $name!"
          }
      rating:
        type: "slider"
        text: "Rate 1–10"
        min: 1
        max: 10
        step: 1
        default: 5
      category:
        type: "dropdown"
        text: "Category"
        options: [ "Bug", "Suggestion", "Other" ]
        default: 0
      anonymous:
        type: "toggle"
        text: "Send anonymously?"
        default: false
    global_actions:
      - |
        message {
          - "Submitted by $name"
        }
      - |
        message {
          - "Category $category, Rating $rating, Anonymous $anonymous"
        }

```

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

### BedrockGUI: Open Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Opens another BedrockGUI form or menu for the player. Enables navigation between different menus and forms within the plugin's ecosystem.

```yaml
open {
  - "main_hub"
  - "advanced_test_menu"
}
```

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

### BedrockGUI: Server Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Executes commands as the server console. Useful for administrative actions or commands that require console privileges within the BedrockGUI forms.

```yaml
server {
  - "say {player} ran tests"
  - "time set day"
}
```

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

### Modal Form Configuration (YAML)

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Defines a modal confirmation dialog with Yes/No buttons. The 'onClick' actions are executed based on the button pressed. Supports basic text and economy actions.

```yaml
forms:
  confirm_buy:
    type: "MODAL"
    title: "Confirm Purchase"
    description: "Buy the item for $250?"
    buttons:
      yes:
        text: "Yes"
        onClick:
          - |
            economy {
              - "check:250"
              - "remove:250"
            }
      no:
        text: "No"
        onClick:
          - |
            message {
              - "&eCancelled"
            }

```

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

### BedrockGUI: Simple Form Configuration

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Defines a 'SIMPLE' form type for BedrockGUI, including its title, description, and buttons with associated click actions. This is a basic YAML configuration for creating interactive menus.

```yaml
forms:
  main_hub:
    type: "SIMPLE"
    title: "§a§lMain Hub"
    description: "Welcome, {player}!"
    buttons:
      open_shop:
        text: "Shop"
        onClick:
          - |
            open {
              - "shop_menu"
            }
      ping:
        text: "Ping"
        onClick:
          - |
            message {
              - "&aPong!"
            }
```

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

### BedrockGUI: URL Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Sends HTTP(S) links to the player's chat, which clients render as clickable. Facilitates linking to external websites or resources.

```yaml
url {
  - "https://store.server.com/{player}"
}
```

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

### BedrockGUI: Title Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Displays title and subtitle messages to players with customizable timing for fade-in, stay, and fade-out durations. Enhances visual feedback for events.

```yaml
title {
  - "Welcome!:Enjoy your stay:10:60:10"
}
```

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

### BedrockGUI: Sound Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Plays sounds for players, with options to specify volume and pitch. Used to provide auditory feedback for user interactions within forms.

```yaml
sound {
  - "ui.button.click"
  - "entity.experience_orb.pickup:0.8:1.2"
}
```

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

### BedrockGUI: Economy Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Manages player balances through operations like add, remove, set, check, and pay. Integrates with economy plugins to handle virtual currency within forms.

```yaml
economy {
  - "check:500"
  - "add:250"
  - "pay:Friend:100"
}
```

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

### BedrockGUI: Delay Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Introduces a delay in milliseconds before executing a subsequent action. Allows for timed sequences and staggered event triggers within forms.

```yaml
delay {
  - "1000"
  - "message:After 1 second"
}
```

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

### BedrockGUI: Bungee Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Sends a plugin message through the Bungeecord channel. Requires specific subchannels and arguments for different BungeeCord functionalities.

```yaml
bungee {
      subchannel: "Connect"
      - "lobby"
    }

bungee {
      subchannel: "ConnectOther"
      - "{player}"
      - "survival"
    }

bungee {
      subchannel: "Message"
      - "{player}"
      - "§aWelcome to the server!"
    }

bungee {
      subchannel: "KickPlayer"
      - "{player}"
      - "§cYou have been kicked!"
    }
```

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

### BedrockGUI: Broadcast Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Broadcasts messages globally or to targeted audiences based on permissions, world, or proximity. Enables versatile message dissemination within the plugin.

```yaml
broadcast {
  - "Welcome everyone!"
  - "permission:vip.access:VIP notice"
  - "world:world_nether:Nether alert"
  - "radius:20:Nearby message"
}
```

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

### BedrockGUI: Conditional Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Executes different actions based on permission checks or placeholder evaluations. Enables dynamic form behavior based on player status or game state.

```yaml
conditional {
  check: "placeholder:${vault_eco_balance} >= 500"
  true:
    - "message:&aYou can afford it!"
    - "economy:add:100"
  false:
    - "message:&cNeed $500"
}
```

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

### BedrockGUI: Actionbar Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Shows brief messages above the player's hotbar, often used for status updates or short notifications. Provides non-intrusive player feedback.

```yaml
actionbar {
  - "&eLoading..."
  - "&aDone!"
}
```

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

### BedrockGUI: Command Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Executes commands as the player. This action type is used within BedrockGUI forms to trigger in-game commands triggered by player interaction.

```yaml
command {
  - "me hello world"
  - "time query daytime"
}
```

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

### BedrockGUI: Random Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Selects and executes one action from a provided list, optionally with weights. Useful for random rewards or chance-based events in forms.

```yaml
random {
  - "message:Prize A:2.0"
  - "message:Prize B:1.0"
}
```

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

### BedrockGUI: Message Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Sends colorized chat messages to players, supporting both standard '&' color codes and hexadecimal colors. Allows for formatted player communication.

```yaml
message {
  - "&#00ff99Welcome {player}!"
  - "&aBalance: ${vault_eco_balance}"
}
```

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

### BedrockGUI: Inventory Action

Source: https://pintux.gitbook.io/pintux-support/bedrockgui/bedrockgui-v2/index

Performs item operations such as giving, removing, clearing, or checking for items in a player's inventory. Facilitates item management within forms.

```yaml
inventory {
  - "give:diamond:3"
  - "check:diamond"
  - "clear:all"
}
```
Tokens:
Raw