VaultBBDocs
MyBBAdvanced Dice

Admin UI Guide

A tour of the Advanced Dice admin pages — Overview, Profiles, Rules, and Settings.

Admin UI Guide

Advanced Dice adds four pages under the VaultBB → Advanced Dice tab in the Admin CP.


Overview

URL: index.php?module=vaultbb-advdice

The landing page. Shows aggregate stats (total rolls stored, active profiles, recent activity) and a dashboard widget that is also injected into the main VaultBB Dashboard.


Profiles

URL: index.php?module=vaultbb-advdice_profiles

Profiles are named configurations that users can reference in post tags via a slug. Each profile can optionally override expressions, restrict result ranges, and trigger conditional rendered output through its rules.

Profile Fields

FieldDescription
TitleHuman-readable name shown in the admin list
SlugLowercase URL-safe identifier used in post tags (e.g. attack_roll). Must be unique across all profiles. Slugs are the preferred reference method; numeric IDs are still accepted for backward compatibility
DescriptionAdmin-facing note — not shown to users
Default RenderFallback render type (text, html, image) when no rule matches
Forced ExpressionIf set, the profile always rolls this expression regardless of what the user writes inside the tag. Leave blank to allow user expressions
Min ResultRolls whose total falls below this value are silently discarded — the tag is consumed but no roll record is saved
Max ResultRolls whose total exceeds this value are similarly discarded
EnabledDisabled profiles are ignored at post time — tags referencing them fall back to a standard roll

Actions

From the profile list you can Add, Edit, Enable/Disable, Delete, and open the Rules sub-page for any profile. Deleting a profile also deletes all of its rules.


Rules

URL: index.php?module=vaultbb-advdice_rules&profile_id=N

Rules define what is rendered below a roll result when the total matches a condition. They are evaluated at display time (not stored per roll), top-to-bottom by sort_order — the first matching rule wins.

Rule Fields

FieldDescription
Match ModeHow the total is compared — range (min ≤ total ≤ max), equals (exact), gte (≥ min), lte (≤ max)
Min / Max / Equals valueThe threshold values used depending on match mode
Render Typetext — plain text; html — sanitised HTML via SafeHtml; image — must be an https:// URL
PayloadThe content rendered when the rule matches
Sort OrderLower numbers evaluate first
EnabledDisabled rules are skipped entirely

Rules are evaluated fresh on every page load. Changing a rule's payload immediately affects how all existing rolls with that profile display — no re-roll required.

Render Types in Detail

Text — The payload is HTML-escaped and displayed in a styled box with a blue left border beneath the roll breakdown.

HTML — The payload is passed through SafeHtml, which strips disallowed tags and attributes before rendering. Use for rich formatting like tables or coloured text.

Image — The payload must be a full https:// URL. Displayed as a constrained image (max-height: 240px) beneath the breakdown. An invalid URL shows a warning instead of a broken image.


Settings

URL: index.php?module=vaultbb-advdice_settings

A UI wrapper around the same settings described in the Configuration & Settings page. All changes are saved immediately and logged to VaultBB Core logs under the vaultbb_advdice / settings_updated action.


Help Documents

On install, Advanced Dice creates a VaultBB Advanced Dice section in the forum's built-in Help system (Help → VaultBB Advanced Dice) with four articles for end users:

  • Rolling Dice — basic syntax
  • Advanced Formulas — combining multiple dice and modifiers
  • Hidden Rolls — private rolls for game masters
  • Dice Profiles — using profile slugs, labels, drop/keep notation, and constraints

These articles are removed on uninstall.

On this page