Samples — Overview¶

The Samples folder contains a set of runnable Unity scenes for RevFramework systems.

Note (SKUs): This package includes samples only for the systems you own.
For example, Currency & Economy ships Currency/Economy samples only.
The Complete package includes samples for every system.

• Minimal — each one teaches one concept clearly.
• Copy-pasteable — safe to drop into your own project as a reference.
• Consistent — same labels, same flow, same behaviour as the Teachable Panels and MkDocs pages.
• Framework-first — no magic, and no system wiring buried in a prefab; everything is set up on the scene's own objects, like a real project.

Every sample set ships with:

• 00 • Quickstart scene — the smallest possible configuration.

Most sets then add feature-focused scenes showing specific subsystems (policies, routing, rules, modifiers…). Three do not: Economy, Loot and Save each ship a single quickstart scene and nothing else, because each one has a single lesson to teach.

If you're following along with the docs or teachable panels, each sample scene mirrors the exact APIs, results, and patterns shown there.

Sample Categories¶

RevFramework provides sample sets per system.
In SKU packages, you’ll only see the systems included in your purchase:

Save is the exception to the SKU note above — it ships in every package, because the save coordinator it demonstrates lives in Runtime/Core and ships in every package too. Everything else in this list appears only if you own that system.

Each set includes a Scenes/ folder. Two also carry prefabs: Samples/Systems/Inventory/Prefabs holds the authored item prefabs, and the shared props and VFX live in Samples/Shared/SharedAssets/Prefabs.

How to Use the Samples¶

1. Use the Quickstart scenes for reference when integrating into your own project.
2. Compare scenes with the matching Teachable Panels to see the runtime state behind the UI.
3. Consult the matching MkDocs pages for the underlying code and patterns.

Everything behaves exactly like shown in the videos, docs, and teachable panels — that’s the whole design philosophy.

ℹ️ Some sample scenes use small Teaching support helpers that live under
Teaching → Status Effects → Support.
These helpers exist to support the teachable panels and are safe to delete along with the Teaching folder before shipping.

Navigation¶

All sample pages are listed individually in the documentation site's left navigation, under Tools & Learning → Samples, with one entry per system and one page per scene. Save sits under Systems → Save → Samples instead, because on the site it is grouped with the rest of the save documentation rather than with the SKU systems.

That is the site's page tree, not the folder layout on disk. In the project the scenes live under:

Samples/Systems/<System>/Scenes/

The entry scene for each set is the one numbered 00_, and its name varies — 00_Quickstart_Minimal for Inventory, 00_Currency_Basics for Currency, 00_GettingStarted for Health, 00_StatusBasics for Status Effects, 00_Loot_Quickstart for Loot, 00_Save_Quickstart for Save, and so on.

You can open any page and jump straight into the corresponding .unity scene.