From 5e9a190e67d5f6e22a45d775da805048931879b3 Mon Sep 17 00:00:00 2001 From: filoxenace Date: Wed, 25 Mar 2026 23:51:58 -0400 Subject: [PATCH] docs: add installation and usage details --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 06bdc4d..5ac588e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,30 @@ # rbx-reface Restore classic decal faces following the Dynamic Head Migration. -# Acknowledgements +Characters wearing a dynamic head that was migrated from a classic face will have their head replaced with the appropriate classic mesh and face. Dynamic heads that were never associated with a classic face are left untouched. + +## Installation + +Install via [Wally](https://wally.run): + +```toml +[dependencies] +reface = "secret-rare/rbx-reface@0.1.0" +``` + +Alternatively, download the `.rbxm` file from the [Releases](https://github.com/filoxen/rbx-reface/releases) tab and insert it into your place. + +## Usage + +Call `reface.init()` once from a server `Script`. It will handle all current and future players automatically. + +```lua +local reface = require(game.ServerScriptService.Packages.reface) + +reface.init() +``` + +## Acknowledgements [Dawgra/Facial-Unification](https://github.com/Dawgra/Facial-Unification) was the repo that inspired the creation of this one - it served as a design inspiration for this module.