Overview

🧭 Where should I start?¶

🔹 New to Crafting?¶

Start with:

👉 Overview/

This explains: - What the Crafting system is - How jobs, recipes, adapters, validators, and modifiers fit together - How it integrates with Inventory, Currency, and other RevFramework systems - Typical setup and usage patterns

🔹 Want to know what you can safely depend on?¶

Read:

👉 PublicAPI/

This document defines: - The supported runtime surface - Stable classes, methods, and events - Guaranteed behaviour and lifecycle ordering - Explicitly unsupported usage

If something is not listed there, it is not supported — even if it appears public in code.

This is the contract.

🔹 Deciding how to integrate or extend?¶

Check:

👉 FAQ/

The FAQ answers questions like: - Is this the right extension point? - Should I use a validator or a modifier? - Can I do X? - What should I avoid? - How does this behave in multiplayer?

It focuses on decision-making, not API reference.

🧠 How these documents work together¶

Document	Purpose
Overview	Explains the system
Public API	Defines what is supported
FAQ	Guides correct usage choices

They are designed to be read together, but serve different needs.

🛑 Important support note¶

RevFramework Crafting is: - Deterministic - Adapter-driven - Authority-aware - UI-agnostic - Netcode-agnostic

Support is provided for: - Behaviour described in PublicAPI - Usage patterns described in Overview and FAQ

Support is not provided for: - Modifying internal services - Depending on undocumented behaviour - Reflecting into runtime internals - Treating public classes as supported by default

Teaching Panels:
Add any Crafting*Panel component to a scene to visualize behaviour live.
Samples:
See /Samples/Crafting/ for runnable, editable examples.
MkDocs site:
Mirrors this documentation for web browsing.

✅ TL;DR¶

Want to understand Crafting → Overview
Want to build safely → Public API
Want to choose correctly → FAQ

If you stick to those boundaries, Crafting will behave predictably and remain future-proof.