Overview

(Additional deep-dive or internal notes may exist elsewhere in the asset, but these three define the supported surface.)

🧭 Where should I start?¶

🔹 New to the Currency system?¶

Start with:

👉 This page (Overview)

It explains: - what the Currency system is responsible for, - how it is composed and extended, - how it integrates with other RevFramework systems, - and where to go next depending on your goal.

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

Read:

👉 PublicAPI/

This document defines: - the supported runtime surface, - stable interfaces, methods, and events, - guarantees around behaviour and ordering, - and what is explicitly not supported.

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

This is the contract.

🔹 Deciding how to integrate or extend Currency?¶

Check:

👉 FAQ/

The FAQ answers decision questions, such as: - Which extension point should I use? - Should this logic live in a decorator, adapter, or UI? - How do I do this safely in multiplayer? - What assumptions are incorrect or discouraged?

It does not repeat the README or Public API content.

🧠 How these documents work together¶

Document	Purpose
README (this page)	System overview and orientation
Public API	Supported, stable runtime contract
FAQ	Correct integration and decision guidance

They are designed to complement each other without overlap.

🛑 Important support note¶

RevFramework Currency is designed to be: - service-first, - composable via factories, - authority-aware, - transaction-safe, - and netcode-agnostic.

Support is provided for: - behaviour documented in PublicAPI, - usage patterns described in README and FAQ.

Support is not provided for: - modifying internal services or decorators, - depending on undocumented behaviour, - bypassing factories or resolvers, - treating public classes as supported by default.

Teaching Panels
Add any Currency*Panel component to a scene to visualize behaviour live.
Samples
See /Samples/Currency/ for runnable, editable examples covering: caps, exchange, escrow, persistence, idempotency, and transactions.
MkDocs site
Mirrors this documentation for web browsing.

✅ TL;DR¶

Want to understand Currency → README
Want to build safely → Public API
Want to choose correctly → FAQ

If you stick to those boundaries, the Currency system will remain predictable, extensible, and future-proof.