🧩 Samples — Shared Support¶
This folder contains shared helper code used by sample scenes.
These scripts exist to support demos (movement, input shortcuts, simple FX, scene notes),
and are not part of the core RevFramework runtime API.
🎯 Purpose¶
- Provide lightweight utilities so sample scenes work out of the box
- Avoid forcing dependencies (for example, Input System)
- Keep demo setup simple and easy to understand
⚠️ Important Notes¶
- These scripts are sample support only
- They are not intended as production-ready systems
- They may use simplified logic (for example
Camera.main, global time changes, or reflection) - They are not part of the supported public API surface
🧪 Samples & Teachables¶
Sample scenes show real, running behaviour of the framework systems.
Many samples are paired with Teachable panels, which explain the same behaviour through UI, validation, and feedback.
- Samples = live demos you can run and inspect
- Teachables = guided explanations of those systems
Teachables are included in a separate assembly and can be used independently of the samples.
🧠 How to Use¶
- Use them as reference or quick helpers if useful (but expect to replace them in production)
- Copy, modify, or delete them as needed
- Replace them with your own systems in real projects
📦 Typical Contents¶
- Simple movement controllers (e.g. pawn-style movement)
- Debug input helpers (no hard dependency on Input System)
- Lightweight FX utilities (camera shake, time slow, billboarding)
- Scene helper components (intentional warning notes)
🧾 Summary¶
This folder exists to make the samples easy to run and understand.
If you're integrating RevFramework into a real project,
focus on the Runtime systems and Public API — not these helpers.