Cleanup & description support

better handling of user input (might wana add error messages down the line)

added support for remplacing place holder text in a folder containing readme&descriptions. Making it less and less painfull to propare a page for the public

Author: HashEdits

Description&ReadMeExemples/MyCoolDescription.txt

@@ -0,0 +1,16 @@
+Here's a cool description for my face tracking add-on for /*AVATAR AUTHOR*/'s /*AVATAR NAME*/
+much swag, very bussin!
+
+for this add-on to work you need to own /*AVATAR NAME*/ by /*AVATAR AUTHOR*/, avaliable @:
+/*StoreLink*/
+
+this DLC will only work if you use the package /*PACKAGE NAME*/ and have the model that comes with it in your unity project
+
+after buying you'll get a program stored in
+/*DIR PATCHER*/
+
+after running it you should have a working prefab in:
+
+/*DIR PREFAB*/
+
+Import it into your scene, and voila!

Description&ReadMeExemples/MyCoolReadMe.txt

@@ -0,0 +1,15 @@
+thanks for buying my Add-on for /*AVATAR NAME*/. it means a lot to me
+
+After importing the package in your unity project that has the model in it. please run the program in 
+/*DIR PATCHER*/
+
+after running it you should have a working prefab in:
+/*DIR PREFAB*/
+
+
+
+Import it into your scene, and voila!
+
+
+
+Enjoy!

FT_Builder.py

@@ -1,9 +1,12 @@
 import os
+from pickle import TRUE
 import sys
 import shutil
 import subprocess
 import PyInstaller.__main__
 
+
+#prints my cool ascii art
 def print_ascii_art():
     ascii_art = r"""
  ____  ____    ____  _  _  __  __    ____  ____  ____ 
@@ -19,14 +22,51 @@ def print_ascii_art():
     print(ascii_art)
     print(credits)
 
+
+#remplaces the sick descriptions you've made for your product with what you input if you so please
+def replace_placeholders_in_files_in_directory(directory, AvatarName, AvatarCreatorName, BoothLink, PackageName, DirPatcher, DirPrefab):
+    replacements = {
+        '/*AVATAR NAME*/': AvatarName,
+        '/*AVATAR AUTHOR*/': AvatarCreatorName,
+        '/*StoreLink*/': BoothLink,
+        '/*PACKAGE NAME*/': PackageName,
+        '/*DIR PATCHER*/': DirPatcher,
+        '/*DIR PREFAB*/': DirPrefab
+    }
+
+    current_directory = os.getcwd()
+    retail_folder = os.path.join(current_directory, 'Retail Descriptions ' + AvatarName)
+    os.makedirs(retail_folder, exist_ok=True)
+
+    for root, _, files in os.walk(directory):
+        for file_name in files:
+            file_path = os.path.join(root, file_name)
+            with open(file_path, 'r', encoding='utf-8') as file:
+                file_content = file.read()
+
+            for placeholder, value in replacements.items():
+                file_content = file_content.replace(placeholder, value)
+
+            relative_path = os.path.relpath(file_path, directory)
+            new_file_path = os.path.join(retail_folder, relative_path)
+            os.makedirs(os.path.dirname(new_file_path), exist_ok=True)
+            with open(new_file_path, 'w', encoding='utf-8') as file:
+                file.write(file_content)
+
+    print(f"Modified files saved in '{retail_folder}' folder.")
+
+
+
+#fonction that gives the relative path from the Assets folder
 def get_assets_relative_path(file_path):
     asset_folder = "Assets"
     index = file_path.rfind(asset_folder)
     if index != -1:
         return file_path[index + len(asset_folder) + 1:]
     else:
         return None
-
+    
+#fonction that will take care of modifying the right lines of code in the patcher
 def modify_python_patcher_script(original_model_path, original_meta_file_path, diff_file_name, meta_diff_file_name, output_name, NameCustomScript):
     with open('PythonPatcher.py', 'r') as file:
         script_content = file.read()
@@ -63,27 +103,47 @@ def main():
 
     print_ascii_art()
 
-    # Get the dropped file path as input
-    OriginalFBX = input("Drag and drop the original FBX here (make sure it's in between quotation marks): ")
-    OriginalFBX = OriginalFBX.strip('"')
-    FaceTrackedFBX = input("Drag and drop the face tracked FBX here (make sure it's in between quotation marks): ")
-    FaceTrackedFBX = FaceTrackedFBX.strip('"')
+    # Get the required info to proceed
+
+    OriginalFBX = input("Drag and drop the original FBX here: ")
+    if OriginalFBX.startswith('"') and OriginalFBX.endswith('"'):
+        OriginalFBX = OriginalFBX.strip('"')
+
+
+    FaceTrackedFBX = input("Drag and drop the face tracked FBX here: ")
+    if FaceTrackedFBX.startswith('"') and FaceTrackedFBX.endswith('"'):
+        FaceTrackedFBX = FaceTrackedFBX.strip('"')
+
+
     NameCustomDir = input("Please input the name of your custom directory: ")
     NameCustomAvatarDir = input("Please input the name of the avatar's custom directory: ")
-    NameFBXDiffFile = input("Please input the name of your FBX Diff file: ")
-    NameMetaDiffFile = input("Please input the name of your import settings Diff file: ")
+    NameFBXDiffFile = NameCustomAvatarDir + 'Diff'
+    NameMetaDiffFile = NameCustomAvatarDir + 'Meta' + 'Diff'
+    DescriptionDir = input("Please input the directory of your descriptions and readme files (will skip if left empty): ")
+    
+    
+    if DescriptionDir.startswith('"') and DescriptionDir.endswith('"'):
+        DescriptionDir = DescriptionDir.strip('"')
+    if DescriptionDir != '':
+        CreatorName = input("Please input the name of the creator: ")
+        BoothPage = input("Please input the page of the avatar: ")
+        PackageName = input("Please input the name of the package that users will have: ")
+
 
 
 
 
+
+    #creates the funky subfolders
     target_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), NameCustomDir, NameCustomAvatarDir, 'patcher', 'data', 'DiffFiles'))
     os.makedirs(target_dir, exist_ok=True)
 
 
+    #location of the hdiff builds
+    hdiffz = os.path.join(os.path.dirname(__file__), 'hdiff', 'hdiffz.exe')
+    hpatchz = os.path.join(os.path.dirname(__file__), 'hdiff', 'hpatchz.exe')
 
-    hdiffz = os.path.join(os.path.dirname(__file__),  'hdiff', 'hdiffz.exe')
-    hpatchz = os.path.join(os.path.dirname(__file__),  'hdiff', 'hpatchz.exe')
-
+    #location of the diff files
     FBXDiffFile = os.path.abspath(os.path.join(os.path.dirname(__file__), NameCustomDir, NameCustomAvatarDir, 'patcher', 'data', 'DiffFiles', NameFBXDiffFile+".hdiff"))
     MetaDiffFile = os.path.abspath(os.path.join(os.path.dirname(__file__), NameCustomDir, NameCustomAvatarDir, 'patcher', 'data', 'DiffFiles', NameMetaDiffFile+".hdiff"))
 
@@ -97,6 +157,7 @@ def main():
         print("Error occurred during creation of the meta diff file.")
         input("Press Enter to continue...")
 
+    #location of the og script and the destination script
     OriginalScript = os.path.abspath(os.path.join(__file__, '..', 'PythonPatcher.py'))
     destination_path = os.path.abspath(os.path.join(os.path.dirname(__file__),"! "+ NameCustomAvatarDir + "Patcher.py"))
 
@@ -116,7 +177,7 @@ def main():
     )
 
 
-    #build
+    #build the patcher
     buildDestination = os.path.abspath(os.path.join(os.path.dirname(__file__), NameCustomDir, NameCustomAvatarDir, 'patcher'))
     PyInstaller.__main__.run([
     "! "+NameCustomAvatarDir+"Patcher.py",
@@ -127,27 +188,55 @@ def main():
     ])
 
 
-    #moving files over
+    #moving patcher files over
     source_dir = os.path.join(buildDestination, "! "+NameCustomAvatarDir+"Patcher")
     file_names = os.listdir(source_dir)
 
     for file_name in file_names:
         shutil.move(os.path.join(source_dir, file_name), buildDestination)
 
-    #moving evrything under the data folder
-    shutil.move(os.path.join(buildDestination, '_bz2.pyd'), os.path.join(buildDestination, 'data', '_bz2.pyd'))
-    shutil.move(os.path.join(buildDestination, '_hashlib.pyd'), os.path.join(buildDestination, 'data', '_hashlib.pyd'))
-    shutil.move(os.path.join(buildDestination, '_lzma.pyd'), os.path.join(buildDestination, 'data', '_lzma.pyd'))
-    shutil.move(os.path.join(buildDestination, '_socket.pyd'), os.path.join(buildDestination, 'data', '_socket.pyd'))
-    shutil.move(os.path.join(buildDestination, '_ssl.pyd'), os.path.join(buildDestination, 'data', '_ssl.pyd'))
-    shutil.move(os.path.join(buildDestination, 'libcrypto-1_1-x64.dll'), os.path.join(buildDestination, 'data', 'libcrypto-1_1-x64.dll'))
-    shutil.move(os.path.join(buildDestination, 'libssl-1_1-x64.dll'), os.path.join(buildDestination, 'data', 'libssl-1_1-x64.dll'))
-    shutil.move(os.path.join(buildDestination, 'select.pyd'), os.path.join(buildDestination, 'data', 'select.pyd'))
-    shutil.move(os.path.join(buildDestination, 'unicodedata.pyd'), os.path.join(buildDestination, 'data', 'unicodedata.pyd'))
-    shutil.move(os.path.join(buildDestination, 'VCRUNTIME140.dll'), os.path.join(buildDestination, 'data', 'VCRUNTIME140.dll'))
+    #moving evrything that can be under the data folder
+
+    files_to_exclude = [
+        "! "+NameCustomAvatarDir+"Patcher.exe",
+        "base_library.zip",
+        NameFBXDiffFile+".hdiff",
+        NameMetaDiffFile+".hdiff"
+    ]
+
+    dll_names_to_exclude = ["python"]
+
+    for root, _, files in os.walk(buildDestination):
+        for file_name in files:
+            source_path = os.path.join(root, file_name)
+            destination_path = ""
+
+            if file_name in files_to_exclude:
+                continue
+            
+            is_dll_with_python = any(name in file_name.lower() for name in dll_names_to_exclude)
+            if is_dll_with_python:
+                continue
+            else:
+                destination_path = os.path.join(buildDestination, 'data', file_name)
+
+            shutil.move(source_path, destination_path)
+
     shutil.copy(hpatchz, os.path.join(buildDestination, 'data', 'hpatchz.exe'))
     shutil.copy(os.path.join(hpatchz, '..', 'License.txt'), os.path.join(buildDestination, 'data', 'License.txt'))
     os.rmdir(source_dir)
+    print("Files moved to the 'data' folder.")
+
+    #remplacing descriptions and readme placeholders
+    replace_placeholders_in_files_in_directory(
+        DescriptionDir,
+        NameCustomAvatarDir,
+        CreatorName,
+        BoothPage,
+        PackageName,
+        'Assets' + NameCustomDir + NameCustomAvatarDir + 'patcher',
+        'Assets' + NameCustomDir + NameCustomAvatarDir + 'prefab',
+    )
 
 
 if __name__ == "__main__":

README.md

@@ -11,49 +11,63 @@ Due to how curent 3D model files are set up there isn't a way to share shape-key
 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.
 
 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
 
 If used please credit my socials and this GitHub Page
 
-# Pre-requisites 🤓
+## Pre-requisites 🤓
 
 [Python](https://www.python.org/downloads/)
 
+> pip install auto-py-to-exe
+
 [Py Intsaller](https://pypi.org/project/auto-py-to-exe/)
 
 
 
 >pip install pyinstaller
 
-# How to use 😎
+## How to use 😎
+  
+  - Make sure both your model and your face tracked model are set up in a unity project
+  - (optional) put all of your descriptions and readme in a folder to ease the creation of pages
 
 - Open your python IDLE
 
 - Click File -> Open
 
-- Navigate to where you have downloaded the latest release -> FT_Builder
+- Navigate to where you have downloaded the repo -> FT_Builder
 
 - Press F5
 
 - Follow the instructions
 
-# Exemple 📑
-There is an extra theorical directory to show you what to expect from the builder if you input
+## Exemple 📑
+There is an extra theorical directory to show you what to expect from the builder if you input:
+
+- WhereverOnYourProjectIsLocatedOnYourDrive\ProjectName\Assets\CreatorName\AvatarName\fbx\MyCoolAvatar.fbx
+
+- WhereverOnYourProjectIsLocatedOnYourDrive\ProjectName\Assets\YourCustomDir\NameOfTheModel\fbx\MyCoolAvatar_FT.fbx
+
+- YourCustomDir
+
+- NameOfTheModel
 
-"WhereverOnYourProjectIsLocatedOnYourDrive\ProjectName\Assets\CreatorName\AvatarName\fbx\MyCoolAvatar.fbx"
+- Path\To\My\Cool\Descriptions&ReadMe
 
-"WhereverOnYourProjectIsLocatedOnYourDrive\ProjectName\Assets\YourCustomDir\NameOfTheModel\fbx\MyCoolAvatar_FT.fbx"
+- AvatarCreatorName
 
-YourCustomDir
+- Creator.CoolStoreFront.com/item/MyCoolAvatar
 
-NameOfTheModel
+- NameOfThePackageCustomersOwn
 
-MyModelDiff
+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.
 
-MyModelMetaDiff
 
-# Distribute a face tracked avatar 👨‍🏫
+## Distribute a face tracked avatar 👨‍🏫
 - Copy your custom generated directory earlier and drag and drop it in the Assets folder of your unity project
 
 - Make sure that your avatar has the required parameters, FX and additive controllers set up for VRCFaceTracking.
@@ -82,21 +96,18 @@ MyModelMetaDiff
 
 - You're ready to sell your custom face tracked avatar!
 (make sure to always check the creator's licence agreement on attachements)
+
 
 
-# Build FT_Builder
+## Build FT_Builder
 
 Somehow running into issues with that, it ends up restarting the script uppon wanting to run pyinstaller from the script (line 121), if any of you have an idea how to build the daim thing I'd be glad to merge it to the main branch 🤗
 
 
 
 
-# Credits 📕
+## Credits 📕
 
 **[HDiffPatch](https://github.com/sisong/HDiffPatch)**
-
-
 **[Nimble Design System Icons](https://iconduck.com/sets/nimble-design-system-icons)**
-
-
-**[Auto py to exe](https://pypi.org/project/auto-py-to-exe/)**
+**[Auto py to exe](https://pypi.org/project/auto-py-to-exe/)**