Skip to content

docs: MiniMessage, message delivery tags, flag placeholders, Island Defaults tab, blueprint format#39

Merged
tastybento merged 4 commits into
masterfrom
copilot/update-docs-mini-message
Apr 6, 2026
Merged

docs: MiniMessage, message delivery tags, flag placeholders, Island Defaults tab, blueprint format#39
tastybento merged 4 commits into
masterfrom
copilot/update-docs-mini-message

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 6, 2026

  • PR #2910 – Document new locale message delivery tags ([actionbar], [title], [subtitle], [sound:...]) in Translate-BentoBox-and-addons.md
  • PR #2903 – Document that MiniMessage is now used for all locale strings in Translate-BentoBox-and-addons.md
  • PR #2913 – Document new flag state placeholders (%[gamemode]_flag_<name>%) in Placeholders.md
  • PR #2912 – Document new "Island Defaults" tab in Admin Settings GUI in Island-Protection,-Flags-&-Ranks.md
  • PR #2911 – Update blueprint file format documentation (.blu.blueprint plain JSON) in Blueprints.md and Blueprint-Specification-v1.md
  • Address review feedback:
    • Removed incorrect island.blueprint filename from "Incomplete bundles" fallback sentence
    • Fixed Island Defaults version tag from "2.x" to "3.14.0"
    • Expanded Island Defaults description to cover settings flags (true/false toggle) alongside protection flags
    • Updated Placeholders.md to say "protection flag and settings flag" (not just protection)
    • Clarified that [subtitle] is not standalone — it only works as a separator inside a [title] message; added empty-title example
    • Added & color codes alongside § in the backwards-compatibility note

Copilot AI linked an issue Apr 6, 2026 that may be closed by this pull request
…ag placeholders, Island Defaults, blueprint format

Agent-Logs-Url: https://github.com/BentoBoxWorld/docs/sessions/93844fe5-42fe-4df2-ba08-2f00867e6bfc

Co-authored-by: tastybento <4407265+tastybento@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation to reflect new features and MiniMessage usage docs: MiniMessage, message delivery tags, flag placeholders, Island Defaults tab, blueprint format Apr 6, 2026
Copilot AI requested a review from tastybento April 6, 2026 23:29
@tastybento tastybento marked this pull request as ready for review April 6, 2026 23:39
Comment thread docs/BentoBox/Blueprints.md Outdated

## Incomplete bundles
Bundles must always have an Overworld/Normal world blueprint. If they do not, then the default island (island.blu) blueprint will be used and an error logged in the console.
Bundles must always have an Overworld/Normal world blueprint. If they do not, then the default island (`island.blueprint`) blueprint will be used and an error logged in the console.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This text is wrong. Remove it. The text below it is correct.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the (island.blueprint) filename reference — the sentence now just says "the default island blueprint will be used". Fixed in ad94d68.


### Island Defaults

!!! new "Added in BentoBox 2.x"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong. It is being added in BentoBox 3.14.0

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed — version updated to 3.14.0 in ad94d68.


Previously, these defaults could only be changed in the gamemode's `config.yml`. Now they can be changed directly in-game by opening `/[admin_command] settings` and navigating to the **Island Defaults** tab (tab 3).

Each protection flag is listed with its current default rank. Clicking on a flag cycles the default rank through the rank ladder. Changes are saved immediately to the world settings and take effect for all **new** islands created after the change. Existing islands are not affected. No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true, but Island Settings flag defaults can also be changed and have a true/false setting.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in ad94d68 — the description now covers both cases: protection flags cycle through rank ladder, and island settings flags toggle true/false.

Comment thread docs/BentoBox/Placeholders.md Outdated

### Flag placeholders

Every protection flag registered in a gamemode also exposes a placeholder. The placeholder name is `flag_` followed by the lower-case flag ID:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not just protection flag, but settings flag too.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in ad94d68 — intro now reads "Every protection flag and settings flag registered in a gamemode also exposes a placeholder."


### `[title]` and `[subtitle]`

Sends the message as a **title** overlay on screen. Use `[title]` for the large text and `[subtitle]` for the smaller text below it. They can be used together in the same string.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[subtitle] is not a standalone delivery type — it only works as a separator inside a [title]...[subtitle]... message. Without [title] it falls through to the chat path.

So your an example could be:

scooping: '[title][subtitle]Changing obsidian back into lava!'
That gives you an empty title and the text as the subtitle.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in ad94d68 — the section now clearly states that [subtitle] is not a standalone delivery type and only works as a separator inside a [title] message. Added the empty-title example you suggested ("[title][subtitle]You scooped the lava!").

… subtitle clarification, settings flag coverage

Agent-Logs-Url: https://github.com/BentoBoxWorld/docs/sessions/be13355d-41ce-4c8f-a275-9bb4f6beebd7

Co-authored-by: tastybento <4407265+tastybento@users.noreply.github.com>
Copilot AI requested a review from tastybento April 6, 2026 23:50
my-message: "<gradient:gold:yellow>Island Name</gradient>"
```

Legacy `§` color codes are still supported for backwards compatibility and will be automatically converted to MiniMessage format when loaded.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to:
Legacy § or & color codes are still supported for backwards compatibility and will be automatically converted to MiniMessage format when loaded.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 809e22f.

Copilot AI requested a review from tastybento April 6, 2026 23:53
@tastybento tastybento merged commit 026b0d5 into master Apr 6, 2026
@tastybento tastybento deleted the copilot/update-docs-mini-message branch April 6, 2026 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs

2 participants