clone info

README.md

@@ -53,23 +53,9 @@ This project provides :
 	
 	- a Playstation®Home scene database ( [google sheets](https://docs.google.com/spreadsheets/d/1acznLvA2k4I7yl56i3pCmAhzxG4pPcrx/edit?usp=sharing&ouid=113258013303427394442&rtpof=true&sd=true) ) 
 	
- - it's own Playstation®Home public server which supports both QA ( Developer ) and Retail ( Consumer ) builds for version 1.86. It is playable on both a Jailbroken PS3 and the RPCS3 emulator. ( [HL Website](https://pshomeologylab.net/) )
+ - it's own Playstation®Home public server which supports both QA ( Developer ) and Retail ( Consumer ) builds for version 1.86. It is playable on both a Jailbroken PS3 and the RPCS3 emulator. ( [pshomeologylab.net](https://pshomeologylab.net/) )
 
- - a Playstation®Home item ( object ) catalogue database and inventory management system for the PS®Homeology Lab online server, along with an external command module for the QA ( Developer ) build. ( [psho](http://psho.me/) )
-
-### ✧ Home Headquarters ✧
-
-[Discord Server](https://discord.com/invite/87W5qaMtgB)
-
-This project provides : 
-
- - a Playstation®Home public server that is running off of Home Laboratory's software. It supports only the Retail ( Consumer ) build for version 1.86. It is playable on both a Jailbroken PS3 and the RPCS3 emulator. ( [HHQ Website](https://homeheadquarters.online/) )
- 
- - a more community-oriented environment with weekly in-game get-togethers ( events ).
- 
- - a larger player base that is primarily made up of past Playstation®Home users.
- 
- - a laughable staff hierarchy alongside moderation that's a bit too self-serious on both its Discord and its Playstation®Home online server.
+ - a Playstation®Home item ( object ) catalogue database and inventory management system for the PS®Homeology Lab online server, along with an external command module for the QA ( Developer ) build. ( [psho.me](http://psho.me/) )
 
 ## ✧ Playstation®Home Cache Information ✧ 
 
@@ -99,9 +85,7 @@ Upon request, a comprehensive analysis of the cache—detailing its contents and
 
 ### ✧ Extraction Guides ✧
 
- - ( [Guide #1](https://pshomeologylab.net/Cache) )
-
- - ( [Guide #2](https://homeheadquarters.online/Cache) )
+ Guide #1 - ( [https://pshomeologylab.net/Cache](https://pshomeologylab.net/Cache) )
  
 ### ✧ Public Archive ✧
 
@@ -109,6 +93,56 @@ A vast majority of Playstation®Home raw caches donated by it's former players a
 
 You can find individual download links here. ( [Google Sheets](https://docs.google.com/spreadsheets/d/1uR7IRGjkl_n5CMBua6zIQV5EKXdSk8_D-sTDoJGMe7c/edit?usp=sharing) ) 
 
+## ✧ How to Clone ✧ 
+
+There are two ways to clone this repository: using Git's API or using Hugging Face's Python based API. To keep things simple, the below methods will be geared toward Windows machines.   
+
+### ✧ Git ✧
+
+With Git, you can the clone entire repository or clone specific folders. This repository is structured in a certian way to make it easier to clone specific folders.
+
+1) Install Git with the stand alone installer ( [git-scm.com](https://git-scm.com/downloads/win) )
+
+2) Download and run the batch script ( [clone_repo.bat](https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot/blob/main/clone_repo.bat) ), located in the root of the repository. You can run the script in any folder of your choice, but ensure you run it as an administrator.
+
+     The script will ...
+     
+     1 ) Set a PATH environment variable for Git using the default install directory <code>C:\Program Files\Git\bin</code>. If that is not where your Git is installed then ensure you change the variables at the top of the script.
+     
+     2 ) Set up Git LFS.
+
+     3 ) Give three options. 
+     
+     Option 1 will clone the entire repository.
+     
+     Option 2 will clone specific folders based on a text file named FOLDER.TXT. The script creates a default FOLDER.TXT before initializing the Git repository—this default file is set to ignore all folders. Let the script finish. Afterwards, remove the "#" from the entries in FOLDER.TXT and rerun it. Initializing the repository will look something like this :
+     
+        Initialized empty Git repository in C:/Repos/PSHomeCacheDepot/.git/
+        Updating origin
+        remote: Enumerating objects: 635590, done.
+        remote: Counting objects: 100% (303481/303481), done.
+        remote: Compressing objects: 100% (284559/284559), done.
+        remote: Total 635590 (delta 11151), reused 51232 (delta 552), pack-reused 332109 (from 1)
+        Receiving objects: 100% (635590/635590), 640.76 MiB | 3.71 MiB/s, done.
+        Resolving deltas: 100% (99978/99978), done.
+        From https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot
+         * [new branch]            main       -> origin/main
+        sparse-checkout IS EMPTY. UNCOMMENT AN ENTRY IN FOLDER.TXT.
+        
+      Option 3 will update your local repo folder using the Git command <code>git pull</code>. If any changes are made to your local repo then you'll need to run <code>git stash</code> before you try to pull. 
+        
+### �� HuggingFace ✧
+
+With the HuggingFace Python based API, only the entire repository can be cloned using the deprecated `Repository` class ( [Repository documentation](https://huggingface.co/docs/huggingface_hub/en/guides/repository#clone) ). The Python script below ( [clone_repo.py](https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot/blob/main/clone_repo.py) ) with utilize this class until HuggingFace removes it. The documentation states to use the `snapshot_download` function ( [snapshot_download documentation](https://huggingface.co/docs/huggingface_hub/v0.29.3/en/package_reference/hf_api#huggingface_hub.HfApi.snapshot_download) ) in lieu of the `Repository` class but unforunately, it consistently errors out when attempting to clone the entire repository. On the bright side, the `Repository` class clones the repository exceptionally fast.
+
+To clone the entire repository, …
+
+1) Install Python's latest Window Installer ( [python.org](https://www.python.org/) )
+
+2) Install the API. Open a command prompt as administrator then run <code>pip install huggingface_hub</code>
+
+3) Download and run the python script ( [clone_repo.py](https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot/blob/main/clone_repo.py) ), located in the root of the repository. You can run the script in any folder of your choice.
+
 ## ✧ Notable Mentions ✧ 
 
 The following individuals are key figures spearheading the revolution of Playstation®Home Online as a fully open-source environment :
@@ -117,8 +151,6 @@ The following individuals are key figures spearheading the revolution of Playsta
 - **Jumpsuit** ( [github](https://github.com/Jump-Suit) )
 - **Devil303** ( [psx-place](https://www.psx-place.com/members/devil303.22544/) )
 - **Rew** ( [twitter](https://x.com/pebxcvi) )
-- **Splicewave** ( [youtube](https://www.youtube.com/channel/UC63x8NBm5NkoKMrTl4zrbIA ) )
-- **Kami 2.0**
 - **Pongo** ( [twitter](https://x.com/Pongo86_) )
 - **Spookysniper**
 - **Cade**

UNZIP.BAT

@@ -0,0 +1,121 @@
+@ECHO OFF
+CHCP 65001
+COLOR 0A
+TITLE UNZIPPER
+SETLOCAL ENABLEEXTENSIONS DISABLEDELAYEDEXPANSION
+SET "SRC1=%~DP0"
+SET BIN=%~DP0BIN\
+
+SET TARGET_FOLDER=MAPPED
+SET OVERRIDE=0
+
+SET "WINRARPTH=C:\Program Files\WinRAR\WinRAR.exe"
+SET "SEVENZIPPTH=C:\Program Files\7-Zip\7z.exe"
+
+IF %OVERRIDE% EQU 1 (
+SET FLAG=WINRAR
+SET "ARCHIVER=%WINRARPTH%"
+GOTO :SKIP
+)
+
+IF EXIST "%WINRARPTH%" (
+	IF EXIST "%SEVENZIPPTH%" (
+		SET FLAG=7ZIP
+		SET "ARCHIVER=%SEVENZIPPTH%"
+	) ELSE (
+		SET FLAG=WINRAR
+		SET "ARCHIVER=%WINRARPTH%"
+	)
+) ELSE (
+	IF EXIST "%SEVENZIPPTH%" (
+		SET FLAG=7ZIP
+		SET "ARCHIVER=%SEVENZIPPTH%"
+	) ELSE (
+		SET "FLAG=7ZIP OR WINRAR"
+		SET "ARCHIVER=NULL"
+	)
+)
+
+:MENU_MAIN
+ECHO.
+ECHO.^|-------------------^|
+ECHO.^|   UNZIP OPTIONS   ^|
+ECHO.^|-------------------^|
+IF NOT EXIST "%ARCHIVER%" (
+	ECHO.
+	ECHO %FLAG% NOT FOUND @ %ARCHIVER%. CANNOT ARCHIVE ANYTHING.
+	ECHO.
+) ELSE (
+	ECHO.
+	ECHO CURRENT ARCHIVER: %FLAG%
+)
+IF NOT EXIST "%SRC1%%TARGET_FOLDER%" (
+	ECHO TARGET FOLDER %TARGET_FOLDER% NOT FOUND
+	ECHO.
+) ELSE (
+	ECHO.
+	ECHO TARGET FOLDER %TARGET_FOLDER% FOUND
+	ECHO.
+)
+ECHO 1. UNZIP
+ECHO.
+ECHO 2. SUSPEND CMD
+ECHO.
+SET /P CHOICE=ENTER A NUMBER TO PERFORM AN ACTION: 
+ECHO.
+IF NOT '%CHOICE%'=='' SET CHOICE=%CHOICE:~0,1%
+IF '%CHOICE%'=='1' GOTO MAIN_CHOICE_ONE
+IF '%CHOICE%'=='2' GOTO MAIN_CHOICE_TWO
+
+ECHO "%CHOICE%" IS NOT VALID, TRY AGAIN
+ECHO.
+GOTO MENU_MAIN
+
+:MAIN_CHOICE_ONE
+CALL :UNZIP
+GOTO MAIN_OPTION_END
+
+:MAIN_CHOICE_TWO
+CMD /K
+GOTO MAIN_OPTION_END
+
+:MAIN_OPTION_END
+CMD /K
+GOTO MENU_MAIN
+
+:SKIP
+
+:UNZIP
+IF NOT EXIST "%ARCHIVER%" ECHO %FLAG% NOT FOUND @ %ARCHIVER%. & GOTO END
+IF NOT EXIST "%SRC1%%TARGET_FOLDER%" ECHO %TARGET_FOLDER% NOT FOUND & GOTO END
+
+SET COUNTFOLDER=0
+FOR /F "TOKENS=*" %%A IN ('DIR /B /S "%SRC1%%TARGET_FOLDER%\*.zip"') DO (
+	SET "A=%%A"
+	SET "B=%%~NXA"
+	SET "C=%%~NA"
+	SET "D=%%~DPNA"
+	SET /A COUNTFOLDER+=1
+	SETLOCAL ENABLEDELAYEDEXPANSION
+	IF "%FLAG%"=="7ZIP" (
+		IF EXIST "!D!" (
+			ECHO !COUNTFOLDER! !C!\ ALREADY EXISTS
+		) ELSE (
+     "%ARCHIVER%" x "!A!" -o"!D!" > NUL
+      ECHO !COUNTFOLDER! UNZIPPED !B! 
+		)
+  ) ELSE IF "%FLAG%"=="WINRAR" (
+		IF EXIST "!D!" (
+			ECHO !COUNTFOLDER! !C!\ ALREADY EXISTS
+		) ELSE (
+      "%ARCHIVER%" x -ibck "!A!" *.* "!D!\"
+       ECHO !COUNTFOLDER! UNZIPPED !B! 
+		)
+  ) ELSE (
+    BREAK
+  )
+  ENDLOCAL
+)
+
+:END
+CMD /K

ZIPPER.BAT

@@ -0,0 +1,163 @@
+@ECHO OFF
+CHCP 65001
+COLOR 0A
+TITLE ZIPPER
+SETLOCAL ENABLEEXTENSIONS DISABLEDELAYEDEXPANSION
+SET "SRC1=%~DP0"
+SET BIN=%~DP0BIN\
+
+SET "WINRARPTH=C:\Program Files\WinRAR\WinRAR.exe"
+SET "SEVENZIPPTH=C:\Program Files\7-Zip\7z.exe"
+
+IF EXIST "%WINRARPTH%" (
+	IF EXIST "%SEVENZIPPTH%" (
+		SET FLAG=7ZIP
+		SET "ARCHIVER=%SEVENZIPPTH%"
+	) ELSE (
+		SET FLAG=WINRAR
+		SET "ARCHIVER=%WINRARPTH%"
+	)
+) ELSE (
+	IF EXIST "%SEVENZIPPTH%" (
+		SET FLAG=7ZIP
+		SET "ARCHIVER=%SEVENZIPPTH%"
+	) ELSE (
+		SET "FLAG=7ZIP OR WINRAR"
+		SET "ARCHIVER=NULL"
+	)
+)
+
+:ZIP
+
+IF EXIST "%SRC1%FOLDERS.TXT" BREAK>"%SRC1%FOLDERS.TXT"
+
+>>"%SRC1%FOLDERS.TXT" (
+	FOR /F "TOKENS=*" %%A IN ('DIR /B /A:D "%SRC1%\*" ^| FINDSTR /V /RC:"\<BIN\>" ^| FINDSTR /V /RC:"\<~ZIPPED_QUERIES\>" 2^>NUL') DO (
+		CALL SET "A=%%A"
+		CALL ECHO %%A%%
+	)
+)
+
+SETLOCAL ENABLEDELAYEDEXPANSION
+
+ECHO.
+
+SET COUNTFOLDER=0
+FOR /F "TOKENS=* USEBACKQ DELIMS=" %%A IN ("%SRC1%FOLDERS.TXT") DO (
+   SET /A COUNTFOLDER+=1
+   SET "LIST[!COUNTFOLDER!].String=%%A"
+   SET "LIST[!COUNTFOLDER!].Count=!COUNTFOLDER!"
+   ECHO !COUNTFOLDER!. %%A
+)
+
+SET LASTOPT=%COUNTFOLDER%
+SET OP=NULL
+:GETOPTIONS
+IF NOT EXIST "%ARCHIVER%" (
+	ECHO.
+	ECHO %FLAG% NOT FOUND @ %ARCHIVER%. CANNOT ARCHIVE ANYTHING.
+	ECHO.
+) ELSE (
+	ECHO.
+	ECHO CURRENT ARCHIVER: %FLAG%
+	ECHO.
+)
+ECHO ENTER 0 TO ZIP ALL FOLDERS UP
+ECHO ENTER X TO SUSPEND CMD
+ECHO.
+SET /P "OP=PICK FOLDERS TO ZIP UP (e.g., 1 2 3) : "
+ECHO.
+
+SETLOCAL ENABLEDELAYEDEXPANSION
+SET "NOSPACES=!OP: =!"
+IF "!NOSPACES!"=="" GOTO GETOPTIONS
+ENDLOCAL
+
+IF !OP! EQU 0 ENDLOCAL & GOTO ZIPALL
+IF /I "%OP%"=="X" GOTO END
+IF /I "%OP%"=="NULL" GOTO GETOPTIONS
+
+IF NOT EXIST "%ARCHIVER%" ECHO %FLAG% NOT FOUND @ %ARCHIVER%. & GOTO END
+
+FOR %%A IN (%OP%) DO (
+	SET B=FALSE
+	IF !LIST[%%A].Count! GTR %LASTOPT% SET B=TRUE
+	IF !LIST[%%A].Count! NEQ +!LIST[%%A].Count! SET B=TRUE
+	IF !LIST[%%A].Count! LSS 0 SET B=TRUE
+	IF !B! == TRUE (
+		ECHO INVALID OPTION "%%A"
+	) ELSE (
+	
+		IF EXIST "%SRC1%~ZIPPED_QUERIES\!LIST[%%A].String!.zip" (
+
+			ECHO ~ZIPPED_QUERIES\!LIST[%%A].String!.zip ALREADY EXISTS. SKIPPING ...
+
+		) ELSE (
+	
+			ECHO ZIPPING !LIST[%%A].Count!-!LIST[%%A].String! ...
+			IF "%FLAG%"=="WINRAR" (
+				PUSHD  "%SRC1%!LIST[%%A].String!"
+				"%ARCHIVER%" A -R -AFZIP "!LIST[%%A].String!.zip"
+				POPD 
+			) ELSE IF "%FLAG%"=="7ZIP" (
+				PUSHD "%SRC1%!LIST[%%A].String!"
+				"%ARCHIVER%" A "!LIST[%%A].String!.zip" "%SRC1%!LIST[%%A].String!\*" >NUL
+				POPD
+			) ELSE (
+				ECHO %FLAG% NOT FOUND
+			)
+			ECHO F|XCOPY "%SRC1%\!LIST[%%A].String!\!LIST[%%A].String!.zip" "%SRC1%~ZIPPED_QUERIES\!LIST[%%A].String!.zip" /Q >NUL 2>NUL
+			IF EXIST "%SRC1%\!LIST[%%A].String!\!LIST[%%A].String!.zip" DEL "%SRC1%\!LIST[%%A].String!\!LIST[%%A].String!.zip" >NUL 2>NUL
+			IF EXIST "%SRC1%~ZIPPED_QUERIES\!LIST[%%A].String!.zip" ECHO !LIST[%%A].String!.zip WAS ZIPPED INTO \~ZIPPED_QUERIES
+		)
+	)
+)
+
+IF EXIST "%SRC1%FOLDERS.TXT" DEL "%SRC1%FOLDERS.TXT"
+
+ENDLOCAL
+ECHO.
+GOTO ZIP
+:END
+CMD /K
+
+:ZIPALL
+
+IF NOT EXIST "%ARCHIVER%" ECHO %FLAG% NOT FOUND @ %ARCHIVER%. & GOTO END
+
+SET COUNTFOLDER=0
+FOR /F "TOKENS=*" %%A IN ('DIR /B /A:D "%SRC1%\*" ^| FINDSTR /V /RC:"\<BIN\>" ^| FINDSTR /V /RC:"\<~ZIPPED_QUERIES\>" 2^>NUL') DO (
+	SET "A=%%A"
+	SET /A COUNTFOLDER+=1
+	SETLOCAL ENABLEDELAYEDEXPANSION
+	IF EXIST "%SRC1%~ZIPPED_QUERIES\!A!.zip" (
+
+		ECHO ~ZIPPED_QUERIES\!A!.zip ALREADY EXISTS. SKIPPING ...
+
+	) ELSE (
+	
+		ECHO ZIPPING !COUNTFOLDER!-!A! ...
+		IF "%FLAG%"=="WINRAR" (
+			PUSHD  "%SRC1%!A!"
+			"%ARCHIVER%" A -R -AFZIP "!A!.zip"
+			POPD 
+		) ELSE IF "%FLAG%"=="7ZIP" (
+			PUSHD "%SRC1%!A!"
+			"%ARCHIVER%" A "!A!.zip" "%SRC1%!A!\*" >NUL
+			POPD
+		) ELSE (
+			ECHO %FLAG% NOT FOUND
+		)
+		ECHO F|XCOPY "%SRC1%\!A!\!A!.zip" "%SRC1%~ZIPPED_QUERIES\!A!.zip" /Q >NUL 2>NUL
+		IF EXIST "%SRC1%\!A!\!A!.zip" DEL "%SRC1%\!A!\!A!.zip" >NUL 2>NUL
+		IF EXIST "%SRC1%~ZIPPED_QUERIES\!A!.zip" ECHO !A!.zip WAS ZIPPED INTO \~ZIPPED_QUERIES
+
+	)
+	ENDLOCAL
+)
+
+ECHO.
+ECHO DONE
+GOTO ZIP
+:END
+CMD /K

clone_repo.bat

@@ -0,0 +1,295 @@
+@ECHO OFF
+CHCP 65001
+COLOR 0A
+TITLE PSHomeCacheDepot Cloner
+SETLOCAL ENABLEEXTENSIONS DISABLEDELAYEDEXPANSION
+SET "SRC1=%~DP0"
+SET "GIT=C:\Program Files\Git\bin"
+SET "GITEXE=%GIT%\git.exe"
+SET "GITLFS1=C:\Program Files\Git\cmd\git-lfs.exe"
+SET "GITLFS2=C:\Program Files\Git LFS\git-lfs.exe"
+SET "REPOPATHS=%SRC1%folders.txt"
+SET "ROOT=Repos"
+SET "REPONAME=PSHomeCacheDepot"
+
+
+:: CHECK IF GIT IS ALREADY IN THE PATH (OPTIONAL)
+ECHO %PATH% | FIND /I "GIT\BIN" >NUL
+IF %ERRORLEVEL%==0 (
+    ECHO GIT IS ALREADY IN THE PATH.
+    GOTO CONT
+)
+
+:: ADD GIT TO THE USER PATH
+:: ADJUST THE PATH BELOW IF YOUR GIT INSTALLATION DIRECTORY IS DIFFERENT
+SETX PATH "%PATH%;%GIT%"
+ECHO GIT HAS BEEN ADDED TO YOUR ENVIRONMENT VARIABLES.
+
+:CONT
+IF NOT EXIST "%GIT%" ECHO GIT NOT FOUND @ END %GIT% & GOTO END
+
+SETLOCAL ENABLEDELAYEDEXPANSION
+SET "GITLFS="
+IF NOT EXIST "%GITLFS1%" SET "GITLFS=!GITLFS!%GITLFS1%"
+IF NOT "!GITLFS!" == "" (
+    ECHO GIT LFS NOT FOUND @ !GITLFS!
+    SET "GITLFSALT="
+    IF NOT EXIST "%GITLFS2%" SET "GITLFSALT=!GITLFSALT!%GITLFS2%"
+    IF NOT "!GITLFSALT!" == "" (
+       ECHO GIT LFS NOT FOUND @ !GITLFS! OR !GITLFSALT!
+    		GOTO END
+    ) ELSE (
+    	"%GITEXE%" lfs install
+       GOTO MENU_MAIN
+    )
+) ELSE (
+    "%GITEXE%" lfs install
+    GOTO MENU_MAIN
+)
+ENDLOCAL
+
+:MENU_MAIN
+CD "%SRC1%"
+ECHO.
+ECHO.^|-------------^|
+ECHO.^| GIT OPTIONS ^|
+ECHO.^|-------------^|
+ECHO.
+ECHO 1. CLONE THE ENTIRE REPO
+ECHO.
+ECHO 2. CLONE SPECIFIC FOLDERS USING FOLDERS.TXT
+ECHO.
+ECHO 3. UPDATE LOCAL REPO USING GIT PULL
+ECHO.
+ECHO 4. SUSPEND CMD
+ECHO.
+SET /P CHOICE=ENTER A NUMBER TO PERFORM AN ACTION: 
+ECHO.
+IF NOT '%CHOICE%'=='' SET CHOICE=%CHOICE:~0,1%
+IF '%CHOICE%'=='1' GOTO MAIN_CHOICE_ONE
+IF '%CHOICE%'=='2' GOTO MAIN_CHOICE_TWO
+IF '%CHOICE%'=='3' GOTO MAIN_CHOICE_THREE
+IF '%CHOICE%'=='4' GOTO MAIN_CHOICE_FOUR
+
+ECHO "%CHOICE%" IS NOT VALID, TRY AGAIN
+ECHO.
+GOTO MENU_MAIN
+
+:MAIN_CHOICE_ONE
+CALL :CLONE_ALL_FOLDERS
+GOTO MAIN_OPTION_END
+
+:MAIN_CHOICE_TWO
+CALL :CLONE_SPECIFIC_FOLDERS
+GOTO MAIN_OPTION_END
+
+:MAIN_CHOICE_THREE
+CALL :UPDATE_REPO
+GOTO MAIN_OPTION_END
+
+:MAIN_CHOICE_FOUR
+IF EXIST "%SRC1%%REPONAME%" CD "%SRC1%%REPONAME%"
+CMD /K
+GOTO MAIN_OPTION_END
+
+:MAIN_OPTION_END
+CMD /K
+GOTO MENU_MAIN
+
+:END
+CMD /K
+
+::SSH- git clone git@hf.co:datasets/pebxcvi/PSHomeCacheDepot
+
+:CLONE_ALL_FOLDERS
+
+ECHO INIT FULL CLONE OF REPO
+
+IF EXIST "%SRC1%%REPONAME%\.git" (
+	CD "%SRC1%%REPONAME%"
+	"%GITEXE%" sparse-checkout disable
+	"%GITEXE%" pull
+ ) ELSE (
+ 	"%GITEXE%" clone https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot
+ )
+
+GOTO MENU_MAIN
+
+:CLONE_SPECIFIC_FOLDERS
+ECHO INIT CUSTOM CLONE OF REPO
+ECHO.
+ECHO NOTE#1) THE INITIAL CREATION OF FOLDERS.TXT IS SET TO IGNORE ALL FOLDERS
+ECHO REMOVE THE "#" FROM THE SELECTED FOLDERS THEN RERUN THE SCRIPT
+ECHO.
+ECHO NOTE#2) DELETING ENTRIES IN YOUR sparse-checkout FILE ...
+ECHO WILL RESULT IN THE CORRESPONDING FOLDERS GETTING REMOVED FROM YOUR LOCAL REPO
+ECHO.
+ECHO NOTE#3) MUST HAVE MORE STORAGE AVAILABLE ON YOUR HDD THAN WHAT THE TOTAL REPO SIZE IS
+ECHO.
+
+IF NOT EXIST "%SRC1%%REPONAME%" (
+	MKDIR "%SRC1%%REPONAME%"
+	CD "%SRC1%%REPONAME%"
+) ELSE (
+	CD "%SRC1%%REPONAME%"
+)
+
+IF NOT EXIST "%SRC1%FOLDERS.TXT" (
+	CALL :CREATE_TXT > "%SRC1%FOLDERS.TXT"
+)
+
+FOR /F "TOKENS=*" %%A IN ('DIR /B /A:-D "%SRC1%\*FOLDERS*.TXT" 2^>NUL') DO SET "INPUT=%%A"
+
+IF NOT EXIST "%SRC1%%REPONAME%\.git" (
+	"%GITEXE%" init
+	"%GITEXE%" remote add -f origin https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot
+	"%GITEXE%" config core.sparseCheckout true
+) ELSE (
+  "%GITEXE%" config core.sparseCheckout true
+   SETLOCAL ENABLEDELAYEDEXPANSION
+   FOR /F "TOKENS=* USEBACKQ DELIMS=" %%A IN ("%SRC1%%INPUT%") DO (
+     SET "A=%%A"
+     SET "1ST=!A:~0,1!"
+     SET "PTH=!A:#=!"
+     SET "ACTPTH=!PTH:/=\!"
+     IF EXIST "%SRC1%%REPONAME%\!ACTPTH!" (
+     		IF /I "!PTH!"=="OBJECTS/" (
+     			IF EXIST "%SRC1%%REPONAME%\OBJECTS\scee-home.playstation.net\c.home\prod2\live2\Objects\" (
+     				IF EXIST "%SRC1%%REPONAME%\OBJECTS\scee-home.playstation.net\c.home\prod\live\Objects\" (
+     					(ECHO !PTH!)>>"%SRC1%%REPONAME%\.git\info\sparse-checkout"
+     				) ELSE (
+     					BREAK
+     				)
+     			)
+     		) ELSE IF /I "!PTH!"=="SCENES/" (
+     			IF EXIST "%SRC1%%REPONAME%\SCENES\scee-home.playstation.net\c.home\prod2\live2\Scenes\" (
+     				IF EXIST "%SRC1%%REPONAME%\SCENES\scee-home.playstation.net\c.home\prod\live\Scenes\" (
+     					(ECHO !PTH!)>>"%SRC1%%REPONAME%\.git\info\sparse-checkout"
+     				) ELSE (
+     					BREAK
+     				)
+     			)
+     		) ELSE (
+     		 (ECHO !PTH!)>>"%SRC1%%REPONAME%\.git\info\sparse-checkout"
+     		)
+     )
+   )
+   ENDLOCAL  
+   ECHO \.git ALREADY SET
+)
+
+SETLOCAL ENABLEDELAYEDEXPANSION
+SET COUNTER=0
+FOR /F "TOKENS=* USEBACKQ DELIMS=" %%A IN ("%SRC1%%INPUT%") DO (
+    SET "A=%%A"
+    SET "1ST=!A:~0,1!"
+    IF NOT "!1ST!"=="#" (
+        SET /A COUNTER+=1
+        (ECHO !A!)>>"%SRC1%%REPONAME%\.git\info\sparse-checkout"
+        ECHO !COUNTER! COPIED !A! TO .git\info\sparse-checkout
+    )
+)
+ENDLOCAL
+
+IF NOT EXIST "%SRC1%%REPONAME%\.git\info\sparse-checkout\" (
+	IF EXIST "%SRC1%%REPONAME%\.git\info\sparse-checkout" (
+		SORT /UNIQUE "%SRC1%%REPONAME%\.git\info\sparse-checkout" /O "%SRC1%%REPONAME%\.git\info\sparse-checkout"
+	) ELSE (
+		TYPE NUL > "%SRC1%%REPONAME%\.git\info\sparse-checkout"
+	)
+)
+
+SETLOCAL ENABLEDELAYEDEXPANSION
+IF EXIST "%SRC1%%REPONAME%\.git\info\sparse-checkout" IF NOT EXIST "%SRC1%%REPONAME%\.git\info\sparse-checkout\" (
+	CALL :SETSIZE "%SRC1%%REPONAME%\.git\info\sparse-checkout"
+	IF !SIZE! GTR 0 (
+		"%GITEXE%" checkout main
+	) ELSE (
+	 	ECHO sparse-checkout IS EMPTY. UNCOMMENT AN ENTRY IN FOLDER.TXT.
+	)
+)
+ENDLOCAL
+
+GOTO MENU_MAIN
+
+:UPDATE_REPO
+
+ECHO INIT UPDATE OF REPO
+ECHO.
+ECHO.NOTE#4) IF ANY CHANGES ARE MADE TO YOUR LOCAL REPO, 
+ECHO.SUSPEND CMD ( OPTION 4 ) THEN RUN "git stash" BEFORE YOU TRY TO PULL
+ECHO. 
+
+IF NOT EXIST "%SRC1%%REPONAME%" (
+	ECHO NO GIT REPO FOUND @ "%SRC1%%REPONAME%"
+) ELSE (
+	CD "%SRC1%%REPONAME%"
+	"%GITEXE%" pull
+)
+
+GOTO MENU_MAIN
+
+:: EXAMPLE
+:: Initialized empty Git repository in C:/Repos/PSHomeCacheDepot/.git/
+:: Updating origin
+:: remote: Enumerating objects: 635590, done.
+:: remote: Counting objects: 100% (303481/303481), done.
+:: remote: Compressing objects: 100% (284570/284570), done.
+:: remote: Total 635590 (delta 11151), reused 30727 (delta 541), pack-reused 332109 (from 1)
+:: Receiving objects: 100% (635590/635590), 640.75 MiB | 5.48 MiB/s, done.
+:: Resolving deltas: 100% (99979/99979), done.
+:: From https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot
+::  * [new branch]            main       -> origin/main
+:: 1 COPIED CONFIG XML/ TO .git\info\sparse-checkout
+:: 2 COPIED MOTD&NEWSVIEWER/ TO .git\info\sparse-checkout
+:: Updating index flags: 100% (579385/579385), done.
+:: Updating files: 100% (516/516), done.
+:: branch 'main' set up to track 'origin/main'.
+:: Switched to a new branch 'main'
+
+:SETSIZE
+SET SIZE=%~z1
+GOTO :EOF
+
+:CREATE_TXT
+@ECHO OFF
+ECHO:# ADD # to ignore folder
+ECHO:# REMOVE # to clone folder
+ECHO:#CLUBHOUSE XML/
+ECHO:#COMMERCE POINTS/
+ECHO:#CONFIG XML/
+ECHO:#CONFIGS/
+ECHO:#DEFAULTINVENTORY/
+ECHO:#DEV/
+ECHO:#HELPTEXT/
+ECHO:#MODDER DUMPS/
+ECHO:#MOTD^&NEWSVIEWER/
+ECHO:#NAVIGATORS/
+ECHO:#OBJECTCATALOGUES/
+ECHO:#OBJECTCATALOGUES/OBJECTCATALOGUES-MIX-BETA/
+ECHO:#OBJECTCATALOGUES/OBJECTCATALOGUES-MIX-DEC/
+ECHO:#OBJECTCATALOGUES/OBJECTCATALOGUES-MIX-DEV/
+ECHO:#OBJECTCATALOGUES/OBJECTCATALOGUES-MIX-ENC/
+ECHO:#OBJECTS/
+ECHO:#OBJECTS/scee-home.playstation.net/c.home/prod2/live2/Objects/
+ECHO:#OBJECTS/scee-home.playstation.net/c.home/prod/live/Objects/
+ECHO:#OBJECTS-MAPPED/
+ECHO:#ODC/
+ECHO:#OTHER XML/
+ECHO:#PROFANITYDICTIONARIES/
+ECHO:#RSS FEEDS/
+ECHO:#SCENELISTS/
+ECHO:#SCENELISTS/SCENELISTS-MIX-BETA/
+ECHO:#SCENELISTS/SCENELISTS-MIX-DEC/
+ECHO:#SCENELISTS/SCENELISTS-MIX-DEV/
+ECHO:#SCENELISTS/SCENELISTS-MIX-ENC/
+ECHO:#SCENES/
+ECHO:#SCENES/scee-home.playstation.net/c.home/prod2/live2/Scenes/
+ECHO:#SCENES/scee-home.playstation.net/c.home/prod/live/Scenes/
+ECHO:#SCENES-MAPPED/
+ECHO:#SCREENS/
+ECHO:#SDC/
+ECHO:#SERVICE IDS/
+ECHO:#TSS/
+ECHO:#WEBSITE DUMPS/
+EXIT /B

clone_repo.py

@@ -0,0 +1,33 @@
+#According to the docs, Repository is deprecated in favor of the http-based alternatives implemented in HfApi. 
+#Given its large adoption in legacy code, the complete removal of Repository will only happen in release v1.0. 
+#For more details, please read this explanation page.
+
+from huggingface_hub import Repository
+
+# Specify your local directory where you want the repository cloned.
+local_dir = "C:/Repos/PSHomeCacheDepot"
+
+# Specify the URL for cloning.
+repo_url = "https://huggingface.co/datasets/pebxcvi/PSHomeCacheDepot"
+
+# This will clone the repository to local_dir.
+repo = Repository(local_dir, clone_from=repo_url)
+
+print(f"Repository cloned to: {local_dir}")
+
+# snapshot_download doesn't seem to work. keeps erroring out.
+
+#from huggingface_hub import snapshot_download
+
+#local_path = snapshot_download(
+#    repo_id="pebxcvi/PSHomeCacheDepot",
+#    repo_type="dataset",
+#    revision="main",
+#    local_dir=r"C:\Repos\PSHomeCacheDepot",
+#    #etag_timeout=60,
+#    #max_workers=
+#)
+
+#print("Files downloaded to:", local_path)
+
+input("Press Enter to exit...")