📦 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 prefab dependency or magic; everything is wired like a real project.
Every system ships with:
- 00 • Quickstart scene — the smallest possible configuration.
- Feature-focused scenes — showing specific subsystems (policies, routing, rules, modifiers…).
- Optional Netcode samples — where the system supports multiplayer patterns.
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:
- Inventory
- Pickups
- Crafting
- Health
- Status Effects
- Currency
- Economy
Each set includes Scenes/, Prefabs/ (where required), and NetcodeSamples/ folders.
🧪 How to Use the Samples¶
- Use the Quickstart scenes for reference when integrating into your own project.
- Compare scenes with the matching Teachable Panels to see the runtime state behind the UI.
- 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 left navigation under:
Samples/
Inventory/
Pickups/
Crafting/
Health/
Status Effects/
Currency/
Economy/
You can open any page and jump straight into the corresponding .unity scene.