Skip to content

Editor › Welcome

The Welcome folder contains RevFramework’s editor-only onboarding windows.

These windows provide a short, one-time introduction when a developer imports a RevFramework SKU, helping them understand what was added and where to start — without nagging or blocking workflow.

Purpose

Welcome windows exist to:

  • Confirm what was imported
  • Explain what the system is (and is not)
  • Point to the correct Quickstart demos, docs, and playlists
  • Reduce first-use confusion without forcing reading

They are intentionally minimal and respectful of developer autonomy.

Behaviour

  • Welcome windows appear once per SKU, on first import only
  • They never repeat automatically
  • They do not appear on every editor launch or domain reload
  • No runtime code is involved — these are editor-only

If a developer dismisses the window immediately, it will not reappear.

Reopening Welcome Windows

All welcome windows can be reopened manually from the editor menu:

Tools → RevGaming → RevFramework → Help

Only welcome windows for installed SKUs are shown in the menu. Unavailable SKUs are hidden to avoid confusion.

SKU Awareness & Gating

Welcome windows are SKU-aware:

  • Individual SKUs (e.g. Inventory, Health, Currency) each have their own welcome
  • The Complete bundle shows a single high-level welcome instead of multiple popups
  • Menu entries are gated by installed runtime systems or SKU markers

This ensures: - No duplicate windows - No misleading menu options - No onboarding spam

Implementation Notes

  • All welcome windows live under Editor/Welcome
  • A single coordinator determines which welcome window to show
  • First-launch state is tracked using editor preferences
  • Windows can always be reopened manually via the Help menu

This design prevents collisions when multiple SKUs are installed and keeps onboarding predictable and deterministic.

Design Philosophy

Welcome windows follow the same principle as the rest of RevFramework:

Offer guidance once. Never nag. Never hide behaviour.

They exist to orient developers, not to teach the entire framework upfront.