https://github.com/ReVanced/revanced-library

📚 Library containing common utilities for ReVanced
https://github.com/ReVanced/revanced-library

gradle kotlin library revanced

Last synced: 3 months ago
JSON representation

📚 Library containing common utilities for ReVanced

• Host: GitHub
• URL: https://github.com/ReVanced/revanced-library
• Owner: ReVanced
• License: gpl-3.0
• Created: 2023-09-23T15:24:57.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-16T22:39:28.000Z (4 months ago)
• Last Synced: 2024-08-16T23:38:09.870Z (4 months ago)
• Topics: gradle, kotlin, library, revanced
• Language: Kotlin
• Homepage: https://revanced.app
• Size: 571 KB
• Stars: 34
• Watchers: 5
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-ReVanced - Library

README

        


  

    

    

  

  


  

     

         

         

     

      

   

       

           

           

       

      

   

       

           

           

       

      

   

       

           

           

       

      

   

      

         

         

      

      

   

      

         

         

      

      

   

      

         

         

     

   

   


   


   Continuing the legacy of Vanced



# 📚 ReVanced Library

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-library/release.yml)

![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)

Library containing common utilities for ReVanced.

## ❓ About

ReVanced Library powers projects such as [ReVanced Manager](https://github.com/ReVanced/revanced-manager),

[ReVanced CLI](https://github.com/ReVanced/revanced-cli) with common utilities and functionalities

by providing shared code.

## 💪 Features

Some of the features the ReVanced Library provides are:

- 📝 **Signing APKs**: Read and write keystores, and sign APK files

- 🧩 **Common utility functions**: Various APIs for ReVanced patches such as JSON serialization,

  reading and setting patch options, calculating the most common compatible version for a set of patches and more

- 💾 **Install and uninstall APKs**: Install and uninstall APK files via ADB or locally,

  the Android package manager, or by mounting using root permissions

- 📦 **Repackage patched files to an APK**: Apply patched files from

  [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to an APK file, and align & sign the APK file automatically

## 🚀 How to get started

To use ReVanced Library in your project, follow these steps:

1. [Add the repository](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package)

   to your project

2. Add the dependency to your project:

   ```kt

    dependencies {

        implementation("app.revanced:revanced-library:{$version}")

    }

   ```

## 📚 Everything else

### 📙 Contributing

Thank you for considering contributing to ReVanced Library.

You can find the contribution guidelines [here](CONTRIBUTING.md).

### 🛠️ Building

To build ReVanced Library,

you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).

## 📜 Licence

ReVanced Library is licensed under the GPLv3 license. Please see the [licence file](LICENSE) for more information.

[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Library as long as you track changes/dates in source files.

Any modifications to ReVanced Library must also be made available under the GPL,

along with build & install instructions.