Adding new custom archive path support for muxzip

FAQ User Insights
1

If you tried to use an old muxzip since Canada Goose came out and it failed, or you think the list of supported top level folders in Manually creating installable archives is insufficient, (and you have a bit of linux understanding) this post is for you.

Well, if you had an old backup that isn’t working, you should check here first: Help my backups aren't working

But if you would like to make a custom muxzip file that extracts to a path that is not supported by default, it can be done by creating a small handler script.

Let’s say you want to make an archive to ensure your rgb is off by default because @xonglebongle still has the muOS default them on even though turning them off is his first config step.

The archive handling process takes the top level folder name in the muxzip and looks for a launch script with the same name (see first link for more info).

You will need to first make the rgb file with a single 0 as it’s contents. If you copy it from your device you can open it as a text file and change the 1 to a 0.

Copy this to a folder settings/general/ and zip it. If you open the zip the top folder should be settings.

To make a compatible archive use your favourite ZIP compression method. Then rename the extension from zip to muxzip. You may need to get your OS to show file extensions.

Now for the magic. You will also need to make a new handler on your device or you will get the dreaded “Skipping unsupported archive:” message.

make a script called settings.sh it will look nearly exactly like the other archive extractor scripts, but it will have the correct path for this rgb file:

If you know what you are doing, please replace I KNOW WHAT IM DOING with: /opt/muos/config

#!/bin/sh
# shellcheck disable=SC2034

ARC_DIR="I KNOW WHAT IM DOING"
ARC_LABEL="MustardOS Settings"

ARC_EXTRACT() {
	DEST="$ARC_DIR"
	LABEL="$ARC_LABEL"
}

ARC_CREATE() {
	SRC="$ARC_DIR"
	LABEL="$ARC_LABEL"
	COMP=0
}

Place the file in /opt/muos/script/archive with the other handler files, and make it executable.

1 Like