Skip to content

🧩 Samples Shared — Common

This folder contains small shared helper code used by RevFramework sample scenes.

These helpers exist to support:

  • demo scene behaviour
  • debug shortcuts
  • lightweight sample UX

They are not part of the runtime framework and are not intended as production architecture.

📦 What Lives Here

Typical contents include small utilities that are reused across multiple sample scenes.

Example:

  • Input/DebugKeys — sample/debug keyboard helper with Input System reflection and legacy input fallback

⚠️ Not a Runtime Surface

This folder is sample support code, not a supported gameplay API.

Do not treat these helpers as:

  • your game’s primary input layer
  • a formal abstraction surface
  • a recommended production architecture
  • a replacement for your own project-level systems

These scripts are intentionally lightweight and designed to keep sample scenes easy to run in different Unity setups.

🎮 Input Helper Notes

Some sample helpers avoid hard dependencies on optional packages.

For example, DebugKeys:

  • checks the Input System through reflection
  • falls back to legacy Unity input when available
  • supports only the limited key mappings needed by demos
  • exists so sample scenes can remain usable without forcing a package dependency

That makes it useful for samples, but it is not intended to be a project's long-term input solution.

For real projects, use your own proper input layer (for example Unity Input System, Rewired, or your own abstraction).

✅ Intended Usage

Use this folder when you want to:

  • understand how sample scenes are wired together
  • inspect lightweight demo support code
  • copy small ideas for debugging or throwaway prototype helpers

🚫 Not Intended For

This folder is not designed for:

  • production gameplay systems
  • long-term input architecture
  • package-level extension points
  • framework integration contracts

🧹 Safe to Remove

If you are not using the sample scenes, this folder can be removed safely.

Removing it does not affect:

  • RevFramework runtime systems
  • supported public APIs
  • production integrations