feat(Custom branding): Add in-app settings to change icon and name

[MarcaDian]

For YouTube and YT Music.

Adds in app settings to pick the custom branding icon and the custom name to use.

Found in:

• ReVanced Settings > General > App icon
• ReVanced Settings > General > App name

Additionally, custom icons now use SVG icons instead of PNG for a crisper look.

Icon styles

ReVanced

Adaptive icon

Monochrome icon

ReVanced minimal

Adaptive icon

Monochrome icon

ReVanced scaled

Adaptive icon

Monochrome icon

Custom

You can provide your own icon during patching. An example using an 'expanded' gradient:

revanced_gradient.zip

Adaptive icon square

Adaptive icon circle

Adaptive teardrop

Monochrome icon

 

Root installations

This feature does not work with mount (rooted) installation, because root ignores manifest changes. If you are rooted and want the ReVanced icon, then download it from here and use it as a custom icon in your launcher.

[MarcaDian]

Maybe this can still be optimized (file names) to avoid duplication.

[LisoUseInAIKyrios]

Can the bundled ReVanced mipmap png's be deleted? No point adding them if the svg is used.

[MarcaDian]

That's what I meant, how to remove them without disrupting the work with custom icons?

[LisoUseInAIKyrios]

Maybe don't allow custom SVG resources if the user specifies a folder?

It would make the patch and patch option a lot simpler. SVG has limited use cases, while png works for any kind of icon and it's the most likely file a user will pick.

[LisoUseInAIKyrios]

I tried removing the mipmap icons, but then the svg isn't used and the app has the original unmodified icon/launch graphics as unpatched. This is the same issue I ran into before when I tried using svg's.

Are we sure the SVG's are being used?

[LisoUseInAIKyrios]

The SVG icon is not being used for the launcher icon. At least it's not on my launcher (Lawnchair 15).

I modified the bundled png a little (did not modify the svg), and the modified png is what shows in the launcher.

[MarcaDian]

I need to double check, I just modified the code to remove the png and I don't have xml copied to mipmap-anydpi

[MarcaDian]

Just checked again, everything is fine.

[LisoUseInAIKyrios]

Checking what you have and I'll try

[MarcaDian]

Oh, I tested Music, and now I tried YouTube and it doesn't work for me either, need to take a closer look.

Edit: I must have mistyped the file names from the unpatched app.

[MarcaDian]

I don't know if it's normal for many XML files in custom branding resources to have the same content but differ only by name.

Is it possible, for example, to use one file as a template and just copy it with a different name?

[MarcaDian]

Surely this code can already be deleted?
Edit: Probably not, because it is still used for custom icons.

private val youtubeIconResourceFileNames_19_34 = mapOf(
    "adaptiveproduct_youtube_foreground_color_108" to "adaptiveproduct_youtube_2024_q4_foreground_color_108",
    "adaptiveproduct_youtube_background_color_108" to "adaptiveproduct_youtube_2024_q4_background_color_108",
)

[oSumAtrIX]

Was the scaling of the shape fixed in the other PR? If not please fix this in the SVG files before merging this PR

[LisoUseInAIKyrios]

I believe the scaling here is correct for Android guidelines.

[MarcaDian]

I also do this optimization every time, I wonder why yours is better.
Maybe you set a larger iteration step.
-m --iterations=50 --filters=0meb

[LisoUseInAIKyrios]

I use an open source tool that runs the images thru multiple re-compressors and picks the most efficient compressor. Zopfli usually wins but sometimes PNGOUT is better.

https://imageoptim.com

Closes windows tool is https://css-ig.net/pinga but I don't think it's free.

[kitadai31]

If template png's are not bundled, then the user must provide png's for all dpis. That's less convenient than providing a single pair of background/foreground icons for just their device.

Regarding this, I gave it a try.

To cut to the chase, this was my mistake, and ChatGPT was not lying.
Only one dpi is required at least.
The template PNGs are not necessary.

I once said "If the only available resources are larger than the current screen, the system doesn't use them and your app crashes." above.
However, this explanation was about the Screen size qualifier (small, normal, ...), not the Screen pixel density (dpi) qualifier (ldpi, mdpi, hdpi, ...).

For the density qualifiers, the crash doesn't occur.
https://developer.android.com/guide/topics/resources/providing-resources#DensityQualifier
This says that the system scales drawable resources as needed, based on the current screen density.

I had actually given it a try.
Using an Android 8.0 xhdpi (320 DPI) AVD.
I created two test apps, one has only mdpi foreground and background PNGs, the other has only xxxhdpi fg and bg PNGs.
Both of these were displayed correctly in the launcher.
I also checked to see if the app would crash if the resource is a drawable instead of a mipmap and displayed in the app, and there were no problems.

After this test, I wondered why the documentation said it would crash, and then I realized it was referring to the screen size qualifier, not the dpi qualifier.

Therefore, the template PNG was unnecessary after all.
By removing it, a lazy user can provide only one dpi, and it will be displayed for devices have other densities.

[LisoUseInAIKyrios]

Using a single dpi file does seem to work and whatever dpi is used is scaled up/down to the actual device dpi.

So if no template is included and the user provides xxxhdpi, then it will be scaled down to whatever dpi they actually have.

But, from my experience Android does a poor job scaling down these resources at runtime. I think these days it's bi-cubic which is good, but it's still worse quality than if the original svg or higher resolution image is scaled down to the exact dpi of the users device.

Before this PR the user had to provide icons for every dpi, and with this change the user only needs to provide one dpi if they want. So it's still an improvement.

[LisoUseInAIKyrios]

A white logo looks great.

Since there's now an in-app setting we could add all kinds of logo variations, if the branding permits them.

For now if you want this icon, don't include a custom icon during patching then edit your settings data to include:
"custom_branding_icon": "custom",

[kitadai31]

Oops, I posted a comment just before this was merged
My bad
I always have bad timing :(

Before this PR the user had to provide icons for every dpi, and with this change the user only needs to provide one dpi if they want. So it's still an improvement.

That's true. This PR made it really convenient.

By the way, can't we use vector drawables also for Change header patch?
If it will be just converting this to a vector XML, it will easy.
https://github.com/ReVanced/revanced-branding/blob/main/assets/revanced-headline/revanced-headline-horizontal-light.svg

(I was about to ask this before merged because this PR also fixes the V shape scale of the minimal header. But since this PR has been merged, this refactoring isprobably not needed right now.)

[LisoUseInAIKyrios]

Yes it's easy to add support for user provided vector drawables.

The only issue is the added complexity of explaining the patch option.

But maybe it's not that complicated because it's:

Provide a path to both files of:

• mipmap-anydpi/revanced_background_custom.xml
• mipmap-anydpi/revanced_foreground_custom.xml

Or provide png files of your dpi:

• dpi/revanced_background_custom.png
• dpi/revanced_foreground_custom.png

[LisoUseInAIKyrios]

I just re-read what you said.

Change header can use vector drawables. Both for the built-in options (revanced, minimal), and for user provided drawables (but I'm not sure how useful vector drawables would be for custom user input).

[lowendgamer]

How to enable now the the custom icon on rooted? It was working on the previous patch.

[LisoUseInAIKyrios]

Changing the icon for root does not work well and for many devices it doesn't work or the icon glitches out and it's sometimes the stock icon and other times it's the ReVanced icon.

#6059 (comment)

It's best to change the icon in your launcher. The old icon can be downloaded here to use with your launcher.

[sm455]

@LisoUseInAIKyrios hii.sorry to disturb.whats the command to use custom icon.its not showing in settings in default .i patched through cli

[LisoUseInAIKyrios]

Use the with-options argument for it to print instructions. See https://github.com/ReVanced/revanced-cli/blob/main/docs/1_usage.md#-list-patches

But if all you want is the ReVanced logo, you don't use any patch options and the logo is now selectable in YouTube Settings > ReVanced > General > App icon

[MarcaDian]

@oSumAtrIX Can we create a thread somewhere, maybe in the branding repo, so that users can post their custom icons for the branding patch? I think this would help the ReVanced repository gain some popularity. Or is that a bad idea?

For example, I adapted these icons from Reddit and would like to share them.

[LisoUseInAIKyrios]

Could make a thread on Reddit, where users can post links to icon zips they made and post screenshots. If someone keeps up with the thread they can edit the first post to show popular icons (or don't curate, and let reddit voting push the popular comments with icons up higher).

I think posting icons to a repo isn't a great idea since it can include questionable icons ("heres my custom icon of the copyrighted YouTube logo but with a poop emoji added").