updated readme.md

Author: HashEdits

README.md

@@ -1,23 +1,28 @@
 
 
 
+
 # EditDistributor 🗳️
 
 This is a tool to automate and the ease the distribution of modifications of Unity 3D moddels
 
 ![ ](https://raw.githubusercontent.com/HashEdits/EditDistributionTools/main/ReadMeFiles/header.png)
 
-Due to how curent 3D model files are set up there isn't a way to share shape-keys without being tied to a mesh. Making the process of sharing such files rather tedious or to be left to the context of a commision where sharing mesh data is in general allowed between the commisioner and the artist.
+This set of tools enable you to distribute your modifications to any 3D moddels with ease.
+
+It's main usecase is to generate a difference between your moddifications on a 3D moddel and an original 3D moddel created by a third party, which you don't have the rights to distribute the original data
+
+
+My set of tools let's you build a patcher and maintain it with ease, saving you time and letting your customers have a reliable way to install your modifications. Building a reliable way for them to interact with your products.
 
+The updater tool let's you maintain your modifications if the original creator updates their moddel.
 
-After being involved in the scene it was clear that the previous mainstream methods were sub optimal: overwriting the original model and requiering the user to navigate to a subfolder unknown in advanced.
+An option is also avaliable to automate the generation of localized descriptions for your storefronts
 
-My piece of software let's you build a patcher with ease, saving you time and letting your customers have a reliable path to navigate to. Building a reliable way for them to interact with your products.
-It also now supports adding a directory with your different localized descriptions and readme to make the process of putting the avatar on the storefront much less painfull
 
-I am going to be using my tool from now on to build my Face Tracking Add-ons avaliable on my [Booth](https://hashedits.booth.pm/) and [Ko-Fi](https://ko-fi.com/hashedits/shop) shops
+Tool used mainly by the avatar creators from [VRCFT](https://github.com/benaclejames/VRCFaceTracking) to distribute face tracking add-ons/DLC
 
-If you end up using the tools please credit my socials and this GitHub Page
+⚠️**If you end up using the tools please credit my socials and this GitHub Page**⚠️
 
 ## Pre-requisites 🤓
 
@@ -53,20 +58,56 @@ A modification of that 3D moddel
 
 - Hit the `Build` button
 
-## description generator 📑
-You'll find an exemple readme in **Description&ReadMeExemples** that you can bundle with your avatar's package to let the customer know what to do with it.
-There's also an exemple description there.
-in summary any of the following:
-
-`/*AVATAR NAME*/`,`/*AVATAR AUTHOR*/`, `/*StoreLink*/`, `/*PACKAGE NAME*/`, `/*DIR PATCHER*/`, `/*DIR PREFAB*/`, `/*DIR PATCHER*/`
+## Builder🔧
+![da tutorial](https://raw.githubusercontent.com/HashEdits/EditDistributionTools/main/ReadMeFiles/Builderwindowindexwithnumbers.png)
+Number| Name| Description
+-------- | -----| -----
+1| Original model slot| A slot to drag and drop a prefab of the original moddel into (requires the moddel to have an avatar component for now) |
+2| Modified moddel slot |  A slot to drag and drop a prefab of your modified moddel into (requires the moddel to have an avatar component for now) |
+3|Owerwrite Checkbox  | Will use the name of your modified moddel to created the patcher script and your menu bar if left unckecked. Will use the OverwriteName if checked
+4| OverwriteName  | Name that will be used for the patcher script and hotbar menu if the overwrite checkbox is ticked
+5| Your Name | Will be used to organize your patchers in the menu bar
+6| Original package name | Will be used to let your user know which version of the original moddel they're expected to import. very crutial to give them some sort of version number here that will resonate with your user.
+7| Generate descriptions checkbox | (`Optional`) Will enable the description generator feature
+8| desctiption folder selection button | This button will prompt you to select a desctiption folder. All txt files will be scanned and copied in the destination folder after hitting patch if the Generate descriptions checkbox is checked
+9| destination folder selection button | This button will prompt you to select a desctiption folder. all files found in the description folder will be coppied in this directory with the tags changed
+10| Creator name | All `/*AVATAR AUTHOR*/` tags will be remplaced by what you put in there 
+11| Store page | All `/*StoreLink*/`  tags will be remplaced by what you put in there
+12| Build button | Will generate a patcher script, the diff files and the descriptions (if you've checked the option)
+
+
+## Description generator tags 📑
+You'll find an exemple readme in [here](https://github.com/HashEdits/EditDistributionTools/tree/main/demo%20packages/SampleDescriptions) to show you how to write your descriptions
+And another one [there](https://github.com/HashEdits/EditDistributionTools/tree/main/demo%20packages/MyCubeDescriptions) to show you how they look like after everything's remplaced 
+
+Tag| Signification|
+-------- | -----
+`/*AVATAR NAME*/`|Will be remplaced by the name of your custom avatar or the OverwriteName if the coresponding checkbox is checked
+`/*AVATAR AUTHOR*/`|Will be remplaced by the name of creator
+ `/*StoreLink*/` |Will be remplaced by a link to where the user can buy the original moddel [^(pro-tip for booth users, if you naviagte to the creator page first, it'll translate in the user's prefered language)]
+ `/*PACKAGE NAME*/` |Will be remplaced by the name of the package the user is expected to have on hand when using your patcher
+ `/*DIR PREFAB*/` |Will be remplaced by where your user will be able to find a working prefab of your moddel
+ `/*DIR PATCHER*/` |Will be remplaced by where your user will be able to find your menu bar menu
 
 will be remplaced by something that makes sense in for your project
 
 ## Updater 🔧
 
-You may want to update your creation in the future, instead of having to create a whole new patcher everytime I created an Updater tool
-
-
+You may want to update and maintain your modifications in the future, instead of having to create a whole new patcher everytime. I created an Updater tool to make the process of porting to a newer version easier
+
+![da tutorial](https://raw.githubusercontent.com/HashEdits/EditDistributionTools/main/ReadMeFiles/Updaterwindowindexwithnumbers.png)
+
+Number| Name| Description
+-------- | -----| -----
+1| Updated original model slot| A slot to drag and drop a prefab of the updated original moddel into (requires the moddel to have an avatar component for now) |
+2| Updated Modified moddel slot |  A slot to drag and drop a prefab of your updated modified moddel into (requires the moddel to have an avatar component for now) |
+3| Updated original package name | Will be used to let your user know which version of the original moddel they're expected to import. very crutial to give them some sort of version number here that will resonate with your user.
+4| Generate descriptions checkbox | (`Optional`) Will enable the description generator feature
+5| desctiption folder selection button | This button will prompt you to select a desctiption folder. All txt files will be scanned and copied in the destination folder after hitting patch if the Generate descriptions checkbox is checked
+6| destination folder selection button | This button will prompt you to select a desctiption folder. all files found in the description folder will be coppied in this directory with the tags changed
+7| Creator name | All `/*AVATAR AUTHOR*/` tags will be remplaced by what you put in there 
+8| Store page | All `/*StoreLink*/`  tags will be remplaced by what you put in there
+9| Update button | Will update the patcher script, the diff files and the descriptions (if you've checked the option)
 
 ## Upcoming features