# zig-android-sdk

**Repository Path**: wujilingfeng/zig-android-sdk

## Basic Information

- **Project Name**: zig-android-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-15
- **Last Updated**: 2026-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <img src="examples/minimal/android/res/mipmap/ic_launcher.png" width="32" height="32"> Zig Android SDK

![Continuous integration](https://github.com/silbinarywolf/zig-android-sdk/actions/workflows/ci.yml/badge.svg)

This library allows you to setup and build an APK for your Android devices. This project was mostly based off the work of [ikskuh](https://github.com/ikskuh) and wouldn't exist without the work they did on the [ZigAndroidTemplate](https://github.com/ikskuh/ZigAndroidTemplate) project.

```sh
# Target one Android architecture
zig build -Dtarget=x86_64-linux-android

# Target all Android architectures
zig build -Dandroid=true
```

```zig
// This is an overly simplified example to give you the gist
// of how this library works, see: examples/minimal/build.zig
const android = @import("android");

pub fn build(b: *std.Build) !void {
    const android_sdk = android.Sdk.create(b, .{});
    const apk = android_sdk.createApk(.{
        .api_level = .android15,
        .build_tools_version = "35.0.1",
        .ndk_version = "29.0.13113456",
    });
    apk.setAndroidManifest(b.path("android/AndroidManifest.xml"));
    apk.addResourceDirectory(b.path("android/res"));
    apk.addJavaSourceFile(.{ .file = b.path("android/src/NativeInvocationHandler.java") });
    for (android.standardTargets(b, b.standardTargetOptions(.{}))) |target| {
        apk.addArtifact(b.addSharedLibrary(.{
            .name = exe_name,
            .root_source_file = b.path("src/main.zig"),
            .target = target,
            .optimize = optimize,
        }))
    }
}
```

## Requirements

* [Zig](https://ziglang.org/download)
* Android Tools
    * Option A: [Android Studio](https://developer.android.com/studio)
    * Option B: [Android Command Line Tools](https://developer.android.com/studio#command-line-tools-only)
* [Java Development Kit](https://www.oracle.com/au/java/technologies/downloads/)

## Installation

Option A. Install with package manager
```sh
zig fetch --save https://github.com/silbinarywolf/zig-android-sdk/archive/REPLACE_WITH_WANTED_COMMIT.tar.gz"
```

Option B. Copy-paste the dependency into your project directly and put in a `third-party` folder. This is recommended if you want to easily hack on it or tweak it.
```zig
.{
    .name = .yourzigproject,
    .dependencies = .{
        .android = .{
            .path = "third-party/zig-android-sdk",
        },
    },
}
```

## Examples

* [minimal](examples/minimal): This is based off ZigAndroidTemplate's minimal example.
* [SDL2](examples/sdl2): This is based off Andrew Kelly's SDL Zig Demo but modified to run on Android, Windows, Mac and Linux.

## Native library naming

Your shared library is packed into the APK under the name you give it in `b.addLibrary(.{ .name = ... })`, i.e. `lib/arm64-v8a/lib<name>.so`.

The `NativeActivity` (or SDL activity) in your `AndroidManifest.xml` must load that same name via the `android.app.lib_name` meta-data (without the `lib` prefix and `.so` suffix):

```xml
<activity android:name="android.app.NativeActivity" ...>
    <meta-data android:name="android.app.lib_name" android:value="minimal"/>
    ...
</activity>
```

> **Note**: this was previously hardcoded to `libmain.so`. If you upgrade and your app fails to launch with `dlopen failed: library "libmain.so" not found`, add the `android.app.lib_name` meta-data shown above with your library name.

Packing multiple program libraries into one APK is now possible as well: call `apk.addArtifact(...)` once per library and declare one activity per library with its own `android.app.lib_name`.

## Workarounds

- Patch any artifacts that called `linkLibCpp()` to disable linking C++ and instead manually link `c++abi` and `unwind`. This at least allows the SDL2 example to work for now.

## Credits

- [ikskuh](https://github.com/ikskuh) This would not exist without their [ZigAndroidTemplate](https://github.com/ikskuh/ZigAndroidTemplate) repository to use as a baseline for figuring this all out and also being able to use their logic for the custom panic / logging functions.
    - ikskuh gave a huge thanks to [@cnlohr](https://github.com/cnlohr) for [rawdrawandroid](https://github.com/cnlohr/rawdrawandroid)