From 8c00eba3a2b2fe3ea610280fc9af83898b32580d Mon Sep 17 00:00:00 2001
From: ZeroGravitas <70643459+ZeroGravitasIndeed@users.noreply.github.com>
Date: Sun, 28 May 2023 01:37:31 +0200
Subject: [PATCH] Update readme.md

---
 readme.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/readme.md b/readme.md
index e69de29..a9b7b28 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,12 @@
+This Blender Addon reproduces the function of Slicers GUI's Locate button, filling the Player Characters and NPCs' folders exported by TORCommunity.com's Character Designer and NPC database with all the game assets required for the .gr2 Importer Addon's Character Import feature to reconstruct them.
+
+It adds a few features:
+* Progress and error reporting through Blender's Console. It is recommended to keep it open to check for any error message, as it lists all the files it detects and copies, showing if any entry is malformed or leads to an inexistent file.
+* It gathers a few extra texturemap types:
+  * **DirectionMaps**, that can be used by the Creature, SkinB, and HairC Shaders.
+  * **WrinklesMaps**, meant to be used in heads' SkinB Shaders (they don't support them yet, but some experiments are being carried in order to take advantage of them).
+* It gathers too the character's **skeleton rig**, saving it inside a "skeleton" folder next to "models" and "materials".
+
+The installation process is as any other standard Blender addon. In order to work, it requires us to set the path to a "resources" folder resulted from a game assets extraction through Slicers GUI (with presets "All" or "Dynamic") or EasyMYP. We do that in its Preferences panel.
+
+The Addon appears in the 3D Viewport's Sidebar as a "SWTOR Char Locator" tab containing a single button. Instead of selecting a character's whole folder, it needs us to select the "path.json" file inside. Processing the file is nearly instantaneous. Once done, the character ought to be ready for import.