Get started

NOTE:

This part may have some broken English language. For additional assistant, reach out to Telegram

Also, before using this, try to make a patched recovery with fastboot on your own and try that. If all else fails, use this as a last resort

Getting Started

So, you wanted this one heck of a tool because? Let's see...

• Only has working download mode

I see, then let's get started!

Prerequisites

• A GSI that you want, Check the PHH GSI Wiki as a starting point, you can check relevant Telegram Groups for more GSIs
• A brain
• Knowledge on Linux, just in case if the builder fails
• A stock super.img file, uploaded on Archive.org (is actually a good enough hosting service), You can also use file.io but there are tendencies that the downloader can't get the file.
• An SFTP Provider like SourceForge
• Good Knowledge on GitHub
• Github PAT Keys (Personal Access Token)

To acquire PAT keys: check your personal account settings > Developer Options > Tokens, then create one. Make sure that the PAT keys have these permissions repo, enabled and grab and save the keys. (Don't share or lose the key).

• Telegram Bot, consult the Telegram BotFather to continue (For notifying you or your groups)

Getting started - First Phase

1. Fork the repo.

   Name it whatever you want. I don't care.

2. Acquire the PAT Keys as mentioned in the prerequisites, do not get the fine-grained ones, get the classic one (Necessary)

• Note: Make sure that you are the only one that only knows the key, or else if leaked, your account could be in jeopardy.

Also, the shorter the expiration, the more secure, but the more annoying that you have to do some PAT refresh, time to time

3. Create a Sourceforge Account (Necessary)

   Note:

   The reason i told you to create a sourceforge Account, is that because, GitHub Releases has a 2GB limit on the releases, so a mirror is best to have

3.1. Go to your Sourceforge profile, create a project with proper URL and name.

Note:

If you call your Project name: Asuper Build with the url: asuper-build, then the SFTP Project directory would be like this:

/home/pfs/project/asuper-build/

4. Now, go to the repo you cloned, then settings

5. Check Secrets & Variables, Actions

6. Add new Repository Secret

For Legacy Builders (v1 to v5 (or Builder v4)) (build-v01.yml to builder-v05.yml)

Note:

Old Builders will soon be deleted, please transition to the v06 or later

The secret variables will be deprecated: SOURCEFORGE* variables

SFTP_REPO_LINK = A weblink to redirect to mirror

SOURCEFORGE_PASSWORD = Password of the SFTP account

SOURCEFORGE_REPO_TARGET = Basically what the project is called on the Sourceforge SFTP, the structure is like this:

/home/pfs/project/${{secrets.SOURCEFORGE_REPO_TARGET}}/

SOURCEFORGE_USERNAME = Self explainatory

GITHUB_TOKEN = the PAT token that you created

TELEGRAM_TO = Basically the CHAT ID of where it should head, you can enter the user id too, to send a message via PM, or a group.

Note:

To know what's the ID of your Group, invite: @JsonDumpCUBot from Telegram to any Group Chat and grab an ID that has : -100 in the string

TELEGRAM_TOKEN = A Bot Token of yours, make sure you first create a bot from Telegram

For Latest Builders: v4/builder-v06.yml or later

SFTP_REPO_LINK = A weblink to redirect to mirror

SFTP_HOSTS = the hostname of the sftp target

SFTP_PORT = the port of the sftp target, usually its 22

SFTP_USERNAME = the username of the sftp account

SFTP_PASSWORD = the password of the sftp account

GITHUB_TOKEN = the PAT token that you created

TELEGRAM_TO = Basically the CHAT ID of where it should head, you can enter the user id too, to send a message via PM, or a group.

Note:

To know what's the ID of your Group, invite: @JsonDumpCUBot from Telegram to any Group Chat and grab an ID that has : -100 in the string

TELEGRAM_TOKEN = A Bot Token of yours, make sure you first create a bot from Telegram

7. Upload a super.img

Grab the super.img that's available on the tarfile from stock or by using dd if=/dev/block/by-name/super of=/sdcard/super.img on your rooted device

8. Upload the file, Archive.org is a good place to start, create an account, upload the image as community software

It's patching time

Note:

As per deprecation of old builder scripts, the old instructions will not be provided, only builder-v06.yaml instructions will be provided

1. It's a header usually for the completed build

2. Enter the link to where the actions can grab the super.img

3. The "Is the super img sparse" selection is there, because there are tendencies that simg2img could not unsparse the super.img, if you have any issues having it enabled, please disable it and vice versa

4. This is to tell the actions that the super.img that you provided comes in compressed or not

5. Basically what you name on the finish product

6. What compression types do you want it packaged? (note that most of them are set to ultra compression to try shrinking the file size)

7. Enter the link from the GSI that you choose, make sure that link is a direct download of the file and not only an HTML page

8. Select what file type of GSI its currently compressed in? like img.gz, tar.xz

9. The "Is the GSI sparse" is there because could be GSIs that are sparsed and required to be unsparsed. Although if you have errors on either enabling it, that means that the system.img is unsparsed already

10. The SFTP landing path, where the files be put after building