Skip to content

🛠️ Crafting — Samples

This folder contains sample content for the Crafting system, including:

  • Demo scenes
  • Sample scripts
  • Example recipe assets
  • Diagnostics smoke tests

These samples are designed to help you:

  • Understand how Crafting works
  • Explore integration patterns
  • Test behaviour in isolation

They are not production-ready systems and are not part of the supported Crafting Public API.

📂 Folder Structure

Crafting/
  Recipes/      ← sample RecipeCore assets
  Scenes/       ← demo scenes and walkthroughs
  DemoHelpers/      ← sample adapters, panels, and helpers
  Diagnostics/  ← performance smoke tests (profiling + sanity checks)

🎯 How to Use This Folder

  • Start with Scenes/ to see behaviour in action
  • Use panels in each scene to explore runtime behaviour
  • Review Scripts/ to understand integration patterns
  • Use Recipes/ for quick testing and experimentation
  • Use Diagnostics/ to profile and validate core behaviour

Each area focuses on a different part of the system.

🧠 Teachable Panels

💡 Teachable Panels

Teachable panels are provided as debug and learning tools.

  • They are safe to run at runtime (no UnityEditor dependencies)
  • They interact only through the public API
  • They can be used in your own scenes for debugging, inspection, and validation

However:

  • They are not designed for shipping builds
  • They are not optimised UI
  • They are not a supported gameplay layer

Think of them as:

👉 Hostile-consumer debug tools that prove the API works

🧪 Diagnostics

The Diagnostics/ folder contains small performance smoke tests.

These are used to:

  • Profile core Crafting paths (e.g. preflight, rule scaling)
  • Detect obvious allocation or throughput issues
  • Validate behaviour under repeated workloads

They are:

  • Not benchmarks
  • Not guarantees of performance in your project
  • Not gameplay systems

👉 They exist to demonstrate that core framework paths behave correctly in isolation.

If performance issues occur in your project:

  • Profile your usage
  • Inspect custom validators, modifiers, UI, and adapters

⚠️ Important

These samples:

  • May use fake adapters or simplified implementations
  • May include demo-only logic or shortcuts
  • May omit production concerns like persistence, authority, or networking

👉 They exist to demonstrate behaviour, not define supported usage

🧪 Samples vs Teachables

Teachables (/Teaching)

  • Use only public APIs
  • Represent supported behaviour
  • Act as hostile consumers

Samples (/Samples)

  • Show patterns and examples
  • May use shortcuts or demo logic
  • Are not contracts

👉 Use Teachables for correctness 👉 Use Samples for understanding

🌐 Networking Reminder

RevFramework does not implement:

  • Networking
  • Replication
  • Prediction
  • Rollback
  • Reconciliation

These samples demonstrate local behaviour only.

💡 Key Idea

This folder is a learning and validation environment, not a finished system.

Use it to:

  • Explore
  • Test
  • Understand

Then build your own implementation using the public API.

TL;DR

Scenes show behaviour Scripts show patterns Diagnostics prove core behaviour Recipes support testing

Learn here — build your own systems