HMRT.sh

#!/bin/bash
pause(){
   echo -n "$*"
   read useless #POSIX eventually https://stackoverflow.com/a/54082655/7031100 but after switching to dialog we can remove this
}

#Windows batch variables:
# Overview: https://ss64.com/nt/syntax-args.html

# %~dp0 will expand to the path to the directory where the file is in
# https://www.reddit.com/r/linuxquestions/comments/1jlgsw/can_someone_explain_this_bash_string_for_me/
# https://stackoverflow.com/questions/207959/equivalent-of-dp0-in-sh
# http://openbook.rheinwerk-verlag.de/shell_programmierung/shell_011_002.htm
# Kind of equivalent?: $(dirname "$(readlink -fn "$0")")

# Or better just to use dirname $0?

# if NOT [%1]==[] () checks wether parameter is NOT empty
# https://www.ibm.com/support/knowledgecenter/de/ssw_aix_72/osmanagement/korn_shell_conditional_exp.htexitml
# https://www.cyberciti.biz/faq/unix-linux-bash-script-check-if-variable-is-empty/
# https://developer.ibm.com/tutorials/l-bash-parameters/
# Kind of equivalent?: if [ -n "$1" ] then fi

# %~x1 extends to the extension e.g. .txt
# https://stackoverflow.com/questions/965053/extract-filename-and-extension-in-bashexit
# Kind pf equivalent?: $(echo  $1  | sed 's/.*\././')


# %~dpn1 means drive e.g. C: + path e.g. /something/ + name e.g. HomeMenu without extension and bracketing quotes
# https://www.imagemagick.org/Usage/windows/
# Kind pf equivalent?: basename /path/to/dir/filename.txt .txt
# Yes this doesn't give the path but this may be not needed..

# %%~dpnxF expands to d‎rive, p‎ath, base‎n‎ame and e‎x‎tension of the current file (full path).
# https://stackoverflow.com/questions/5642021/batch-process-all-files-in-directory
# Equivalent: readlink -f "$F"

# !variable!
# https://stackoverflow.com/questions/14354502/difference-between-variable-and-variable-in-batch-file
# https://stackoverflow.com/questions/10558316/example-of-delayed-expansion-in-batch-file
# https://www.unix.com/shell-programming-and-scripting/101380-bash-delay-expansion-variable.html
# https://stackoverflow.com/questions/40345543/bash-delayed-expansion-and-nested-variables
# https://stackoverflow.com/questions/26929684/delayed-variable-expansion-in-bash
# Kind of equivalent?: Is there really a equivalent needed?

# goto
# https://stackoverflow.com/questions/9639103/is-there-a-goto-statement-in-bash
# Kind of equivalent?: https://bobcopeland.com/blog/2012/10/goto-in-bash/

# for
# https://ss64.com/nt/for_f.html
# tokens=1,2 causes first and second item on each line to be proceed
# delims=# # acts as delimiter
# prompt 
# https://de.wikibooks.org/wiki/Batch-Programmierung:_Batch-Befehle#!_(Ausrufezeichen)
# https://ss64.com/nt/prompt.html

# if NOT exist
# https://stackoverflow.com/questions/638975/how-do-i-tell-if-a-regular-file-does-not-exist-in-bash
# https://stackoverflow.com/questions/59838/check-if-a-directory-exists-in-a-shell-script
# Kind of equivalent?: 
# FILES: if ! [ -e "$file" ]; then fi 
# DIRECTORIES: if [ ! -d "$DIRECTORY" ]; then fi

# if exist *.extension"
# https://stackoverflow.com/a/3856879
# count=`ls -1 *.flac 2>/dev/null | wc -l`
# if [ $count != 0 ]; then fi

# set /p variablename="TEXT"
# https://ryanstutorials.net/bash-scripting-tutorial/bash-input.php
# https://stackoverflow.com/questions/226703/how-do-i-prompt-for-yes-no-cancel-input-in-a-linux-shell-script
# Kind of equivalent?: read -p "TEXT" variablename

# ============ FUNCTIONS =============================

step_extract(){
#title Home Menu Rebuilding Tool [Extracting]
backup_ciaName=$ciaName
[ ! -e "$(basename $ciaName .cia).cia" ] && {
    echo "$(tput setaf 9)Couldn't find $(tput setaf 1)$(basename $ciaName .cia)$(tput setaf 9) CIA file.$(tput sgr0)"
	echo "$(tput setaf 99)You can specify a default CIA name"
	echo "in the USER VARIABLES $(tput setaf 93)(e.g. ciaName="$dp0/HomeMenu")$(tput setaf 99)."
	echo "Alternatively drag a CIA to extract onto the $(tput setaf 93)Drop CIA here $(tput setaf 99)file (starts step 8)."
	echo
	echo -n "$(tput setaf 11)Enter filename (no extension):$(tput sgr0) " #WIP: make a menu to choose from
	read ciaName
	ciaName="$dp0/$ciaName"
}
cd $HMRTdir #cases didn't work.. this is why we change dir now..
rm -f *.0000.*
./ctrtool "$ciaName.cia" --contents=Content >/dev/null || {
    cd "$dp0"
    echo "$(tput setaf 1)$ciaName.cia $(tput setaf 9)may not exist. Can't continue."
    echo "$(tput setaf 99)Files in this folder:$(tput setaf 93)"
    ls
    pause "$(tput setaf 11)Press Enter to return to the main menu$(tput sgr0)"
    ciaName=$backup_ciaName
    return
}
for S in *.0000.*
do
    [ -f "$S" ] || break #https://stackoverflow.com/a/14505622 
    echo "Saved cxi0: $S within $HMRTdir"
    cxi0=$S #WIP: What if we have more than one file?
done
[ -z $cxi0 ] && {
    echo "$(tput setaf 9)This should never happen. Were files matching to *.0000.* removed? Contact @derberg:matrix.org$(tput sgr0)" 
    cd "$dp0"
    pause "$(tput setaf 11)Press Enter to return to the main menu$(tput sgr0)"
    return
}
./3dstool -xvtf cxi $cxi0 --header NCCH.Header --exh DecryptedExHeader.bin --exefs DecryptedExeFS.bin --romfs DecryptedRomFS.bin --logo Logo.bcma.lz --plain PlainRGN.bin | sed "s/INFO: logoregion is not exists, Logo.bcma.lz will not be create/$(tput setaf 99)INFO: Some CXI doesn't have a logoregion; Logo.bcma.lz won't be created. This is not an error.$(tput sgr0)/"
./3dstool -xuvtf exefs DecryptedExeFS.bin --exefs-dir ../ExtractedExeFS --header ExeFS.Header
rm -rf ../ExtractedRomFS
./3dstool -xvtf romfs DecryptedRomFS.bin --romfs-dir ../ExtractedRomFS
[ ! -d "../ExtractedRomFS" ] && {
    echo "$(tput setaf 9)Missing ExtractedRomFS directory. Contact @derberg:matrix.org$(tput sgr0)"
    #WIP: What about multiple files? Does this part even work?
	for F in "../xorpads/*romfs.xorpad"; do [ -f "$F" ] || break; rfsxor=$(readlink -f $F); done
	for F in "../xorpads/*exefs_norm.xorpad"; do [ -f "$F" ] || break; efsxor=$(readlink -f $F); done
	for F in "../xorpads/*exheader.xorpad"; do [ -f "$F" ] || break; exhxor=$(readlink -f $F); done
	./3dstool -xvtf cxi "$cxi0" --header NCCH.Header --exh DecryptedExHeader.bin --exh-xor "$exhxor" --exefs DecryptedExeFS.bin --exefs-xor "$efsxor" --romfs DecryptedRomFS.bin --romfs-xor "$rfsxor" --plain PlainRGN.bin
	./3dstool -xuvtf exefs DecryptedExeFS.bin --exefs-dir ../ExtractedExeFS --header ExeFS.Header
	./3dstool -xvtf romfs DecryptedRomFS.bin --romfs-dir ../ExtractedRomFS
	[ ! -e "$encheader" ] && cp NCCH.Header $encheader
	encheader=NCCH.Header
}
echo "$(tput setaf 10)Finished step $REPLY $(tput setaf 40)EXTRACT $(tput sgr0)"
[ "$usrchoice" != "${choice[7]}" ] && {
    cd "$dp0"
    pause "$(tput setaf 11)Press Enter to return to the main menu$(tput sgr0)"
}
}

step_decompress(){
cd $dp0
echo "LZ Decompressionlog [$dp0]" >> $LogFile
echo =====================================================>> $LogFile
cntT=0
cntS=0
#title Home Menu Rebuilding Tool [Decompressor]
echo "Decompressing files in sub folders within ${PWD}"
for F in $(find ./Extracted[RE][ox][me]FS -name '*LZ.bin') #recursive within Extracted folders (R or E, o or x, m or e; not a perfect solution tho)
do  
    d=$(dirname -- "$F")
	cntT=$(($cntT+1))
    fn=$(basename $F .bin) #E.g. miiverse_intro_LZ
    file="$(basename $(echo $fn | sed 's/\(.*\)_/\1./') .LZ).lz" #E.g. miiverse_intro.lz
    printf '%s\t→ %s\n' "$(basename $F)" "$d/$file" | expand -t 35
	"$HMRTdir/3dstool" -uvf "$F" --compress-type lzex --compress-out "$fn.lz"
	[ -e "$fn.lz" ] && {
		rm $F
		mv "$fn.lz" "$d/$file"
		printf '%s\t→ %s\n' "$(date +%s) $(basename $F)" "$d/$file" | expand -t 45 >> $LogFile #unixtime
		cntS=$(($cntS+1))
    } || echo "$(date +%s) $F couldn't be decompressed" >> $LogFile #unixtime
done
echo $(date +%s) "Finished $cntS/$cntT decompressed" >> $LogFile #unixtime
echo =====================================================>> $LogFile

[ "$cntT" = 0 ] && echo "$(tput setaf 1)There were no LZ .bin files to decompress. 
$([ $(find . -name "*.lz" | wc -l) != 0 ] && echo "$(tput setaf 99)However, I found $(find . -name "*.lz" | wc -l) .lz files that may have been decompressed before.
Try to edit them." || echo "$(tput setaf 99)Forgot to extract the CIA?")" || echo "$(tput setaf 99)All extracted LZ .bin files have been decompressed.
Do your edits now."
cd $HMRTdir

echo "$(tput setaf 10)Finished step $REPLY $(tput setaf 40)DECOMPRESS $(tput sgr0)"
[ "$usrchoice" != "${choice[7]}" ] && {
    cd "$dp0"
    pause "$(tput setaf 11)Press Enter to return to the main menu$(tput sgr0)"
}
}

step_recompress() {
cd "$dp0"
echo LZ Recompressionlog [$dp0] >> $LogFile
echo =====================================================>> $LogFile
cntT=0
cntS=0
#title Home Menu Rebuilding Tool [Compressor]
echo "Compressing files in sub folders within ${PWD}"
for F in $(find ./Extracted[RE][ox][me]FS -iname '*lz') #recursive within Extracted folders (R or E, o or x, m or e; not a perfect solution tho)
do
    d=$(dirname -- "$F")
	cntT=$(($cntT+1))
	[ "$d/$(basename $F .lz).lz" = "$F" ] && fn=$(basename $F .lz) || fn=$(basename $F .LZ) #Linux || Windows; E.g. miiverse_intro
	file=$(echo "$fn+LZ.bin" | sed 's/\(.*\)+/\1_/') #E.g. miiverse_intro_LZ.bin ; $fn_LZ.bin is not possible in shell script.
	printf '%s\t→ %s\n' "$(basename $F)" "$d/$file" | expand -t 35
	"$HMRTdir/3dstool" -zvf "$F" --compress-type lzex --compress-out "$file"
	[ -e "$file" ] && {
		rm $F
		mv "$file" "$d/$file"
		printf '%s\t→ %s\n' "$(date +%s) $(basename $F)" "$d/$file" | expand -t 45 >> $LogFile #unixtime
		cntS=$(($cntS+1))
    } || echo "$(date +%s) $F couldn't be (re)compressed" >> $LogFile #unixtime
done
echo $(date +%s) Finished $cntS/$cntT compressed >> $LogFile
echo =====================================================>> $LogFile
[ "$cntT" = 0 ] && echo "$(tput setaf 1)There were no .lz files to (re)compress. 
$([ $(find . -name "*.bin" -not -path "./HMRT/*" | wc -l) != 0 ] && echo "$(tput setaf 99)However, I found $(find . -name "*.bin" -not -path "./HMRT/*" | wc -l) .bin files that may have been compressed before.
Try to decompress them and then do your edits...
...or move on and build a encrypted CIA now." || echo "$(tput setaf 99)Either you are not following a valid order or something is wrong.
$([ $(find . -name "*.bin" | wc -l) != 0 ] && echo "You have some leftover files in ./HMRT. Maybe clear Content* and newer files: 
$(tput setaf 93)$(find ./HMRT/Content*)
$(find ./HMRT -type f -newer ./HMRT/Content*)$(tput setaf 99)
You may also continue without doing this since I don't think that leaving them breaks anything.")
Extract the CIA to get the directories 'ExtractedRomFS' and 'ExtractedExeFS'.
Those should either contain .bin or .lz files (could also be uppercase extensions).
If you need help or you found an error, contact @derberg:matrix.org.")" || echo "$(tput setaf 99)All .lz files have been (re)compressed.
Move on by e.g. building a encrypted CIA now."
cd $HMRTdir

echo "$(tput setaf 10)Finished step $REPLY $(tput setaf 40)COMPRESS $(tput sgr0)"
[ "$usrchoice" == "${choice[1]}" ] && { #TODO: Maybe RECOMP should not be called in BUILD?
    return
}
[ "$usrchoice" != "${choice[7]}" ] && {
    cd "$dp0"
    pause "$(tput setaf 11)Press Enter to return to the main menu$(tput sgr0)"
}
}

step_build(){
#title Home Menu Rebuilding Tool [Building]
if [ -z "$expName" ]; 
then
    echo "No name specified for the CIA file."
	echo "You can specify a default name"
	echo "in the USER VARIABLES.(example ciaName=HomeMenu^)"
	echo
	read -p "Enter filename (no extension): " expName
	echo $expName
fi
cd $HMRTdir
#rm ../ExtractedRomFS/*.bak #I guess files created by some hex editor. But why only in that folder?
pause "Press enter once  {WIP: Move to BUILD maybe?}"
count=`find ../ExtractedRomFS -maxdepth 1 -type f -name "*.lz" | wc -l`
if [ "$count" -ne 0 ]
then
    echo "Calling RECOMP"
    pause "Enter"
    step_recompress #Sub routine; call recomp function. Dunno wether there is a way with labels without additional if statements..
fi
pause "Press enter once again {WIP: REPLACE maybe?}"
wine 3dstool.exe -cvtf romfs CustomRomFS.bin --romfs-dir ../ExtractedRomFS
wine 3dstool.exe -czvtf exefs CustomExeFS.bin --exefs-dir ../ExtractedExeFS --header ExeFS.Header
for S in *.0000.* #set ~nxS name and extension of S
do
 echo "cxi0: $S"
    cxi0=$S
done

echo "$expName.cia will be the path to your new cia."
count=`ls -1 ../xorpads/*.xorpad 2>/dev/null | wc -l`
if [ $count != 0 ]
then 
    echo "Contact me @derberg:matrix.org :)"
	for F in "../xorpads/*romfs.xorpad"; do rfsxor=$(readlink -f $F); done
	for F in "../xorpads/*exefs_norm.xorpad"; do efsxor=$(readlink -f $F); done
	for F in "../xorpads/*exheader.xorpad"; do exhxor=$(readlink -f $F); done	
	wine 3dstool.exe -cvtf cxi "$cxi0" --header "$encheader" --exh DecryptedExHeader.bin --plain PlainRGN.bin --exefs CustomExeFS.bin --romfs CustomRomFS.bin --exh-xor "$exhxor" --exefs-xor "$efsxor" --romfs-xor "$rfsxor"
	if [ "$usrchoice" == "${choice[7]}" ]; then
        fbiblock=""
    fi
else
    wine 3dstool.exe -cvtf cxi "$cxi0" --header NCCH.Header --exh DecryptedExHeader.bin --plain PlainRGN.bin --exefs CustomExeFS.bin --romfs CustomRomFS.bin
	echo
	echo Missing XORpads to build encrypted CIA.
	echo CIA will not be encrypted.
	echo You need to use Decrypt9 or GodMode9 to encrypt CIA.
	echo -e "\033[1;31mIf you do not encrypt it before installing your 3DS will softbrick. \033[0m"
	echo "(Read https://3ds.codeberg.page/homemenu/ Section VI)"
	echo This CIA is only for the firmware version your device is on.
    echo -e "\033[1;31mIf the 3DS version changes or the region is different it will softbrick. \033[0m"
	echo Reinstall the original HomeMenu before updating your device.
	echo -e "If you seek for help: \033[1;34mhttps://discord.gg/0z7IGZ5Sv3D0mEN0\033[0m"
	echo -e "(or \033[1;37mhttps://matrix.to/#/+custom-3ds-assets:matrix.org\033[0m)"
	
	pause 'Press Enter to finish & to return to the menu' #>nul
    if [ "$usrchoice" == "${choice[7]}" ]; then
        fbiblock="ON"
    fi
fi
wine makerom.exe -f cia -content "$cxi0":0:$RANDOM -o "$expName.cia" #%cxi0%:0:%RANDOM% WTF? RANDOM?!
if [ "$usrchoice" != "${choice[7]}" ]; then
    cd "$dp0"
fi
}

step_continue(){
    step_extract && return
    step_decompress && return
    echo
    pause 'Press Enter to continue with recompressing and rebuilding.'
    step_recompress && return
    step_build && return
    echo . #Note: This is from line 189 of the BAT
}

# ============ FUNCTIONS END =============================

#folder script is in
dp0=$(dirname $(readlink /proc/$$/fd/255))
#echo $dp0

echo "Home Menu Rebuilding Tool [By TheDeKay & schrmh]"
HMRTver=0.8-L1
HMRTch="[Dev]"  

#switch to shell script file's drive:
cd "$dp0"
#if [ -n "$1" ]; #if parameter not empty
#then
#    ext=$(echo  $1  | sed 's/.*\././')
#
#    if [ $ext = ".cia" ]; then
#        ciaName=$dp0/$(basename $1 .cia) #@reader: remove $dp0/ if it doesn't work..
#        expName="$ciaName"_edited
#    elif [ $ext = ".bin" ]; then
#        jumpto LZDECOMPRESSOR
#    fi
#fi

#for /F "tokens=1,2 delims=#" %%a in ('"prompt #$H#$E# & echo on & for %%b in (1) do rem"') do ( #sets the colours for the block above the options in the main menu; may be hard to do..
#  set "DEL=%%a"
#)


# ============ USER VARIABLES =============================
# ciaName: Input File (HomeMenu) NO EXTENSION
# expName: Output File (HomeMenu_edited) NO EXTENSION
# SDDrive: Letter for the SD Drive

encheader=NCCH.encheader
HMRTdir=$dp0/HMRT
xordir=$dp0/xorpads
LogFile="$dp0/LZ.log"
ciaName="$dp0/HomeMenu" #doesn't work always..
expName="$ciaName"_edited
defIP=192.168.178.16

# ========================================================
[ -n "$1" ] && ciaName=$dp0/$(basename $1 .cia) && REPLY="8 (drag&drop)" && choice[7]=7 && usrchoice=7 && step_continue

#echo $HMRTdir
#cd $HMRTdir
usrchoice=0
# title Home Menu Rebuilding Tool [By TheDeKay] #do later. Open new shell and set title
clear
#call :cPrint 7C #do later; may be hard
echo "                                                                    Home Menu Rebuilding Tool v$HMRTver $HMRTch"
#call :cPrint 79 "                                 
echo "by TheDeKay & schrmh "
#call :cPrint 71 
echo "                                                                                                Thanks to Asia81 and Zan'"
#call :cPrint 78 "     y
echo "http://axities.github.io                     _________________________________________________________"
echo
echo   "[1] Extract CIA"
echo   "[2] Build encrypted CIA"
echo   "[3] Clean Folder"
echo   "[4] Install via FBI (Network Install)"
echo   "[5] Decompress all LZ files"
echo   "[6] Recompress all LZ files"
echo   "[7] Copy to SD (Auto-detect)"
echo   "[8] Full Rebuild (Steps: 1, 5, Edit, 6, 2, 3, 4)"
echo   "[9] Generate ncchinfo.bin"
echo   "[Q] Exit program"
echo
echo ">      Press your choice [Number]: "
clear
# https://askubuntu.com/questions/1705/how-can-i-create-a-select-menu-in-a-shell-script
choice=("Extract CIA" "Build encrypted CIA" "Clean Folder {WIP}" "Install via FBI (Network Install) {WIP}" "Decompress all LZ files" "Recompress all LZ files" "Copy to SD (Auto-detect) {WIP}" "Full Rebuild (Steps: 1, 5, Edit, 6, 2, 3, 4) {3&4 WIP}" "Generate ncchinfo.bin {WIP}" "Exit program")
select usrchoice in "${choice[@]}"
do
    case $usrchoice in
        "Extract CIA") #0
            step_extract
            ;;
        "Build encrypted CIA") #1
            step_build
            ;;
        "Clean Folder {WIP}") #2
            CLEAN
            ;;
        "Install via FBI (Network Install) {WIP}") #3
            FBI
            ;;
        "Decompress all LZ files") #4
            step_decompress
            ;;
        "Recompress all LZ files") #5
            step_recompress
            ;;
        "Copy to SD (Auto-detect) {WIP}") #6
            COPYSD
            ;;
        "Full Rebuild (Steps: 1, 5, Edit, 6, 2, 3, 4) {3&4 WIP}") #7
            #Continue
            step_continue
            ;;
        "Generate ncchinfo.bin {WIP}") #8
            NCCHINFO
            ;;
        "Exit program") #9
            exit
            ;;
        *) pause "Invalid option $REPLY. Press CTRL+C or write Q to break/quit.";; 
    esac
    clear
    [ -z "$(command -v git)" ] && {
    echo "$(tput setaf 99)INFO: $(tput setaf 93)git$(tput setaf 99) is not installed on your system.
Without $(tput setaf 93)git$(tput setaf 99) HMRT can't check whether there is a new HMRT version.
This doesn't affect the functionality of this HMRT version.$(tput sgr0)"
    } || { 
        git fetch 2>/dev/null && {
            HEADHASH=$(git rev-parse HEAD)
            UPSTREAMHASH=$(git rev-parse master@{upstream})
            [ -z "$UPSTREAMHASH" ] && { 
                echo "$(tput setaf 99)INFO: HMRT might not be downloadable anymore from where you got it from. 
This info might also pop up if you have no internet connection.
This doesn't affect the functionality of this HMRT version.$(tput sgr0)" 
            } || { 
                [ "$HEADHASH" != "$UPSTREAMHASH" ] && {
                    echo "$(tput setaf 99)INFO: Your HMRT version might not be up to date. Try $(tput setaf 93)git pull$(tput setaf 99) to update.$(tput sgr0)"
                }
            } || clear
        } || {
        echo "$(tput setaf 99)INFO: You won't get update notifications. 
If you want them, get HMRT via $(tput setaf 93)git clone https://github.com/schrmh/HMRT$(tput sgr0)"
        }
    }
    REPLY=
done