xpenatan/gdx-teavm

Run LibGDX in a web browser with TeaVM

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.xpenatan:gdx-dragome-backend:1.1.0'
	}

	dependencies {
		implementation("com.github.xpenatan:gdx-dragome-backend:1.1.0")
	}

	<dependency>
	    <groupId>com.github.xpenatan</groupId>
	    <artifactId>gdx-dragome-backend</artifactId>
	    <version>1.1.0</version>
	</dependency>


                            
    libraryDependencies += "com.github.xpenatan" % "gdx-dragome-backend" % "1.1.0"


                            
    :dependencies [[com.github.xpenatan/gdx-dragome-backend "1.1.0"]]

Readme

gdx-teavm

gdx-teavm is a TeaVM backend set for running libGDX applications outside the JVM. It can generate browser builds with JavaScript or Wasm, native C projects for GLFW, experimental PSP and iOS native payloads, and Android native app builds through an Android application module.

The project provides two build styles:

Gradle plugin: the recommended workflow for application projects. It applies TeaVM, configures the selected backend, copies assets, prepares generated output, and creates gdx_teavm_* tasks.
Manual builder API: a Java launcher API for advanced builds and custom tooling. It directly uses TeaBuilder with WebBackend, TeaGLFWBackend, or TeaPSPBackend.

Status

| gdx-teavm | libGDX | TeaVM | |:---------:|:------:|:------:| | -SNAPSHOT | 1.14.2 | 0.15.0 | | 1.5.5 | 1.14.0 | 0.14.0 | | 1.5.4 | 1.14.0 | 0.13.1 |

Modules

| Module | Purpose | | --- | --- | | backend-shared | Shared compiler, asset, resource, and reflection support | | backend-web | libGDX web runtime plus JavaScript and Wasm build support | | backend-glfw | TeaVM C output for desktop GLFW native builds | | backend-psp | Experimental TeaVM C output for PSP builds | | backend-ios | Experimental TeaVM C output and runtime support for iOS builds | | backend-android | TeaVM C output and runtime support for Android app modules | | gdx-freetype-web | FreeType support for TeaVM web builds | | gdx-controllers-web | Controller support for TeaVM web builds | | tools/gdx-teavm-plugin | Gradle plugin implementation |

Documentation

Usage guide: setup, plugin examples, builder examples, tasks, and publishing notes.
Plugin property reference: every gdxTeaVM property, grouped by shared, web, JS, Wasm, GLFW, and Android settings.
Backend architecture: how the builder, Gradle plugin, TeaVM plugins, assets, and reflection work together.
GLFW native build guide: native toolchain requirements and manual CMake workflow.

Repositories

Release artifacts are published to Maven Central. Snapshots are published to Central Portal snapshots.

repositories {
    mavenCentral()
    maven("https://central.sonatype.com/repository/maven-snapshots/")

    // TeaVM artifacts may be needed while using TeaVM snapshots or non-central builds.
    maven("https://teavm.org/maven/repository/")
}

When using the Gradle plugin from Maven, add the same repositories to pluginManagement in settings.gradle.kts.

pluginManagement {
    repositories {
        mavenCentral()
        maven("https://central.sonatype.com/repository/maven-snapshots/")
    }
}

The gdx-teavm plugin marker is published to Maven with the rest of the artifacts, so Gradle Plugin Portal is not required for this plugin.

Gradle Plugin Quick Start

Apply the plugin in the TeaVM target module:

plugins {
    id("com.github.xpenatan.gdx-teavm") version "-SNAPSHOT"
}

dependencies {
    implementation("com.badlogicgames.gdx:gdx:1.14.2")
    implementation(project(":core"))
}

gdxTeaVM {
    assets("assets")
    reflection("com.example.game.save**")

    js {
        mainClass.set("com.example.game.teavm.WebLauncher")
    }

    wasm {
        mainClass.set("com.example.game.teavm.WebLauncher")
    }
}

Run:

./gradlew gdx_teavm_web_js_run
./gradlew gdx_teavm_web_wasm_run

The web run tasks build the app, copy assets, generate the web app files, and serve the output with the backend Jetty server. The plugin adds the required gdx-teavm backend dependencies automatically for each declared target.

For native targets and every available property, see the usage guide and plugin property reference. The plugin creates tasks only for the target blocks you declare.

Manual Builder Quick Start

Use the builder API when you need full programmatic control or a custom build launcher. See the usage guide for complete builder examples.

dependencies {
    implementation("com.github.xpenatan.gdx-teavm:backend-web:-SNAPSHOT")
    implementation(project(":core"))
}

Run the Java launcher from Gradle or your IDE. Builder projects add the concrete backend dependency they use, such as backend-web, backend-glfw, or backend-psp.

Examples In This Repository

# Plugin workflow
./gradlew :examples:basic:plugin:gdx_teavm_web_js_run
./gradlew :examples:basic:plugin:gdx_teavm_web_wasm_run
./gradlew :examples:basic:plugin:gdx_teavm_glfw_generate
./gradlew :examples:basic:plugin:gdx_teavm_psp_generate
./gradlew :examples:basic:ios:gdx_teavm_ios_generate
./gradlew :examples:basic:ios:gdx_teavm_ios_init_xcode

# Android workflow
./gradlew :examples:basic:android:assembleDebug
./gradlew :examples:basic:android:installDebug

# FreeType plugin workflow
./gradlew :examples:freetype:web:gdx_teavm_web_js_run
./gradlew :examples:freetype:web:gdx_teavm_web_wasm_run

# Manual builder workflow
./gradlew :examples:basic:web:basic_run_web
./gradlew :examples:basic:glfw:basic_build_teavm_glfw_debug
./gradlew :examples:basic:psp:basic_build_teavm_psp

Support

If this project is useful to you, consider sponsoring its development.

License

gdx-teavm is licensed under the Apache License 2.0.