Skip to content

Commit 6888a41

Browse files
committed
Update README.md to clarify command click types and add support for right-click and shift-click commands
1 parent 3705bb6 commit 6888a41

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Give your players a slick, clickable GUI menu to run their most-used island comm
99

1010
## ✨ Features
1111

12-
- 🖱️ **Click-to-run**players open a GUI and click buttons to execute commands instantly
12+
- 🖱️ **Click-to-run**left-click, right-click, and shift-click can each trigger a different command
1313
- 🗂️ **Multiple panels** — define as many panels as you want per gamemode; assign them to players via permissions
1414
- 🎨 **Rich icons** — use any vanilla material, BentoBox `ItemParser` format, or [ItemsAdder](https://github.com/LoneDev6/ItemsAdder) custom items
1515
- 📋 **Live placeholders** — button descriptions support PlaceholderAPI, color codes, and `[gamemode]` substitution
@@ -94,7 +94,9 @@ panel-list:
9494
description: |-
9595
line one
9696
line two
97-
command: '<command>'
97+
command: '<left-click command>'
98+
right_click_command: '<right-click command>'
99+
shift_click_command: '<shift+left-click command>'
98100
```
99101
100102
### Panel fields
@@ -115,7 +117,19 @@ panel-list:
115117
| `icon` | BentoBox `ItemParser` string (e.g. `minecraft:diamond`). **Takes priority over `material`.** |
116118
| `itemsadder` | ItemsAdder custom item ID (e.g. `iasurvival:ruby`). Requires the ItemsAdder plugin. |
117119
| `description` | Lore lines shown under the button name. Supports `&` color codes, multi-line `\|`, PlaceholderAPI `%placeholders%`, and `[gamemode]`. |
118-
| `command` | Command run when the button is clicked. Supports placeholders (see below). |
120+
| `command` | Command run on **left-click** (and any click with no specific override). Supports placeholders. |
121+
| `right_click_command` | Command run on **right-click** or **shift+right-click**. Falls back to `command` if omitted. |
122+
| `shift_click_command` | Command run on **shift+left-click**. Falls back to `command` if omitted. |
123+
124+
### Click type summary
125+
126+
| Click | Command used |
127+
|---|---|
128+
| Left click | `command` |
129+
| Right click | `right_click_command` → `command` |
130+
| Shift + Right click | `right_click_command` → `command` |
131+
| Shift + Left click | `shift_click_command` → `command` |
132+
| Any other click | `command` |
119133

120134
### Command placeholders
121135

@@ -160,9 +174,13 @@ panel-list:
160174
name: '&a&l 🏝 Go to Island'
161175
icon: minecraft:grass_block
162176
description: |-
163-
&7 Teleport to your island.
177+
&7 Left-click: teleport to your island.
178+
&7 Right-click: go to your island nether.
179+
&7 Shift+click: set your home here.
164180
&7 Island level: &e%Level_[gamemode]_island_level%
165181
command: '[label] go'
182+
right_click_command: '[label] go nether'
183+
shift_click_command: '[label] sethome'
166184
167185
10:
168186
name: '&e&l 🏠 Set Home'
@@ -369,6 +387,7 @@ panel-list:
369387

370388
## 💡 Tips
371389

390+
- **Alternative clicks** — add `right_click_command` and/or `shift_click_command` to a button to run different commands on right-click and shift+left-click. Omitting them falls back to `command`.
372391
- **Slot layout** — a standard chest row is slots 0–8. A 6-row chest (the max) uses slots 0–53.
373392
- **Slot ranges** — use `"0-8"` (quoted) to place the same button across a range of slots. Great for border decorations.
374393
- **Blank buttons** — set `command: ''` and `name: ' '` to create a visual spacer or border.

0 commit comments

Comments
 (0)