Quick Start
Installing Zernikalos
How to install Zernikalos for Android, iOS, and Web
Prerequisites
- Java (JDK 17 recommended)
- A Git client
- For Web: Node.js (LTS) and a bundler (Vite recommended)
- For iOS: Xcode and CocoaPods
Installation by Platform
Option A: GitHub Packages (Recommended)
Add the repository to your settings.gradle.kts:
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven(url = "https://maven.pkg.github.com/Zernikalos/Zernikalos") {
// Note: might not be necessary for public packages, but GPR often requires it
credentials {
username = providers.gradleProperty("gpr.user").orNull
password = providers.gradleProperty("gpr.key").orNull
}
}
}
}Then add the dependency in your build.gradle.kts:
implementation("dev.zernikalos:zernikalos:0.7.0")Option B: Local Build
If you want to use the source code:
git clone https://github.com/Zernikalos/Zernikalos.git
cd Zernikalos
./gradlew publishToMavenLocalIntegrate using CocoaPods by pointing to the engine repository:
- Add to your
Podfile:
pod 'Zernikalos', :path => '../Zernikalos'- Generate the framework and install:
cd ../Zernikalos
./gradlew :generateDummyFramework
cd -
pod installInstall the package from npm:
npm install @zernikalos/zernikalos@0.7.0If you use GitHub Packages for npm and get a 401, ensure your .npmrc is configured or force npmjs:
@zernikalos:registry=https://registry.npmjs.org/