📚 Extensions-lib

Extensions library used in Aniyomi.

📦 Usage

Add jitpack.io repository to your root build.gradle.kts file:

dependencyResolutionManagement {
    repositories {
        maven(url = "https://www.jitpack.io")
    }
}

Then add the dependency:

dependencies {
    compileOnly("com.github.aniyomiorg:extensions-lib:v16")
}

Note

compileOnly is used because extensions-lib provides stub interfaces only. The actual implementations are included in the host app.

📜 Extension Manifest Requirements

Extensions are required to declare the following features and metadata to be correctly recognized and loaded in the app.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-feature android:name="tachiyomi.animeextension" />
    <application>
        <!-- The display name of the extension -->
        <meta-data android:name="aniyomix.name" android:value="Aniyomi Anime" />

        <!-- Content Rating: 0 = Safe, 1 = Mixed, 2 = NSFW -->
        <meta-data android:name="aniyomix.contentWarning" android:value="0" />

        <!-- Torrent extension -->
        <meta-data android:name="aniyomix.torrent" android:value="false" />
        
        <!-- Target library version -->
        <meta-data android:name="aniyomix.extensionLib" android:value="17" />

        <!-- The fully qualified (or relative to package name) class name of the extension -->
        <meta-data android:name="tachiyomi.animeextension.class" android:value=".Aniyomi" />
    </application>
</manifest>

🔧 App Dependency Requirements

Host apps using extensions-lib must include the following dependencies (or newer compatible versions) to ensure compatibility with version 17:

Dependency	Artifact(s)	Version
Kotlin	org.jetbrains.kotlin:kotlin-stdlib	2.4.0
kotlinx.coroutines	org.jetbrains.kotlinx:kotlinx-coroutines-core	1.10.2
kotlinx.serialization	org.jetbrains.kotlinx:kotlinx-serialization-json org.jetbrains.kotlinx:kotlinx-serialization-json-okio org.jetbrains.kotlinx:kotlinx-serialization-protobuf	1.9.0
OkHttp	com.squareup.okhttp3:okhttp com.squareup.okhttp3:okhttp-brotli com.squareup.okhttp3:okhttp-zstd	5.4.0
jsoup	org.jsoup:jsoup	1.22.2
Injekt	com.github.mihonapp:injekt	91edab2317
Nanohttpd	org.nanohttpd:nanohttpd	2.3.1

📖 Documentation

Documentation for the last released version can be found at https://extension-docs.aniyomi.org/.
Documentation for the next version (generated from the current main branch) can be found here: https://unstable-extension-docs.aniyomi.org/.

📄 License

Extensions-lib is distributed under the Apache License 2.0.