Community.Archives.Apk 1.2.0

dotnet add package Community.Archives.Apk --version 1.2.0                
NuGet\Install-Package Community.Archives.Apk -Version 1.2.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Community.Archives.Apk" Version="1.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Community.Archives.Apk --version 1.2.0                
#r "nuget: Community.Archives.Apk, 1.2.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Community.Archives.Apk as a Cake Addin
#addin nuget:?package=Community.Archives.Apk&version=1.2.0

// Install Community.Archives.Apk as a Cake Tool
#tool nuget:?package=Community.Archives.Apk&version=1.2.0                

Community.Archives.Apk

A fast and efficient forward-only reader for Apk packages (used by Android).

  • 🚀 Fast and efficient: Only extracts matched file. Forward-only access. Uses Task to offload IO to separate threads.
  • 😀 Licensed under MIT. Similar projects are licensed under GPL.
  • 😍 100% test coverage

This package is part of Gitii/Community.Archives: A collection of libraries that support reading various popular archives.

Supported frameworks

  • .Net Standard 2.1
  • .Net 5
  • .Net 6

On any platform that's supported by the above frameworks, including Windows, Linux and MacOS.

Reader specifications

Apk files are normal zip-files with compiled java/kotlin and resource files. ApkArchiveReader will return all files unchanged. For extracted metadata, the files AndroidManifest.xml and resources.arsc are extracted to memory, decompiled and metdata extracted from them.

Getting started

Extract all or specific files

var reader = new ApkArchiveReader();

await foreach (
    var entry in reader
        .GetFileEntriesAsync(stream, IArchiveReader.MATCH_ALL_FILES)
) {
    // entry.Name
    // entry.Content
    Console.WriteLine($"Found file {entry.Name} ({entry.Content.Length} bytes)")
}

Extract specific files only

var reader = new ApkArchiveReader();

// use regular expression to match files (path + file name)
await foreach (
    var entry in reader
        .GetFileEntriesAsync(stream, "[.]png$", "[.]xml$")
) {
    // found a (binary) xml or png file
}

Decompile compiled (binary) xml files like AndroidManifest.xml

Stream stream = ...
IAndroidBinaryXmlReader reader = new AndroidBinaryXmlReader();

XDocument document = reader.Read(stream);

// document represent the raw xml document

! NOTE: To dereference values, you need resources.arsc!

Dereference values from AndroidManifest.xml

Stream stream = ...
IApkResourceDecoder reader = new ApkResourceDecoder();

IDictionary<string, IList<string?>> references = await reader.DecodeAsync(stream);

// Map of references to actual value list
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.0 1,325 3/30/2022
1.1.2 391 3/28/2022