Skip to Content
defold-typescript libraries

Libraries

Library API blocks, and libraries that have no typed API.
The TypeScript definitions behind each API block are maintained in the library data repo — generated from the upstream sources that ship machine-readable types, and hand-forked where upstream ships none — and pinned to an upstream commit or tag.
A card marked with the no-typed-API icon links to a page describing what the library ships and how to use it, but it has no typed API.
269 namespaces documented.

defold (official)

asset-pbr

A base metallic-roughness PBR material with vertex and fragment shaders under /defold-pbr. No Lua API — content, shaders, build-time tooling or engine-side native code only.

assets-defold

Defold logos to use on splash screens or other kinds of in-game promotions for Defold No Lua API — content, shaders, build-time tooling or engine-side native code only.

codepad

Online Defold compiler/interpreter Lua API not typed — upstream ships no .script_api, so resolve skips it.

defold-pbr

A work-in-progress PBR core with shaders, a material, a reference render script and the defold-pbr/core Lua module. Lua API not typed — upstream ships no .script_api, so resolve skips it.

defwarez-shared

Shared DEFWAREZ files: the defwarez-shared/defwarez Lua module, a render script, a font, an atlas, input bindings and a mock collection for local testing. Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-adinfo/adinfo

Provides functionality to get the advertising id and tracking status. Supported on iOS and Android.

extension-admob/admob

Functions and constants for interacting with [Google AdMob APIs](https://developers.google.com/admob)

extension-adpf/adpf

Functions and constants for interacting with the Android Device Performance Framework

extension-android

Example of a native extension for Android Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-automation-bridge

Debug-only native extension for inspecting a running Defold game and sending input from local automation clients such as Codex Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-camera

Provides functionality to capture images using the camera. Supported on macOS, iOS and Android.

extension-crazygames/crazygames

Functions and constants for interacting with the CrazyGames SDK APIs

extension-crypt/crypt

Functions and constants for interacting with various hash and encode/decode algorithms

extension-energy-saver

Extension to help reduce power consumption in your Defold game No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-eos

A native extension wrapping the Epic Online Services SDK, bundling SDK libraries for Windows, Linux and macOS. Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-facebook/facebook

Functions and constants for interacting with Facebook APIs

extension-fbinstant

Facebook Instant Games extension for the Defold game engine Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-firebase/firebase

Functions and constants for interacting with Firebase

extension-firebase-analytics/firebase-analytics

Functions and constants for interacting with Firebase

extension-firebase-crashlytics/firebase-crashlytics

Functions and constants for interacting with Firebase

extension-firebase-remoteconfig/firebase-remoteconfig

Functions and constants for interacting with Firebase

extension-fontgen/fontgen

Functions to generate glyphs for fonts at runtime.

extension-gamelift

Amazon Gamelift extension for the Defold game engine Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-gpgs/gpgs

Functions and constants for interacting with Google Play Games Services (GPGS) APIs

extension-html5

Example showing how to create a native extension for HTML5 Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-iac/iac

Functions and constants for doing inter-app communication. Supported on iOS and Android.

extension-iap/iap

Functions and constants for doing in-app purchases. Supported on iOS, Android (Google Play and Amazon) and Facebook Canvas platforms.

extension-imgui/imgui

Functions and constants for interacting with Dear ImGUI

extension-inappupdate

A placeholder for an Android in-app update extension built on the Play Core in-app updates feature. Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-kaiads/kaiads

Functions and constants for interacting with the KaiAds SDK.

extension-kaios

Defold native extension for use with KaiOS Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-levelplay/levelplay

Functions and constants for Unity LevelPlay mediation on Android and iOS.

extension-lua-preprocessor

Small and simple Lua preprocessor for Defold No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-network-info/networkinfo

Functions to get information about the network configuration of the device.

extension-odin/odin

Functions and constants for interacting with ODIN Voice

extension-onetrust

A work-in-progress native extension for the OneTrust SDK that upstream describes as not working. Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-onion-runtime/onion

Functions and constants for interacting with Onion APIs.

extension-pad/pad

Functionality to work with Play Asset Delivery and the AssetPackManager

extension-permissions/permissions

Functions and constants for interacting with permissions related APIs

extension-photon-fusion/fusion

Functions and constants for interacting with Photon Fusion

extension-photon-realtime/realtime

Functions and constants for interacting with Photon Realtime

extension-playables/playables

Functions for interacting with the YouTube Playables SDK.

extension-playintegrity

Defold extension to integrate Google Play Integrity API No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-poco

Test automation from a computer to a test device using the Poco APO Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-poki-sdk/poki_sdk

Functions and constants for interacting with Poki SDK APIs

extension-profile-counters

Provides the profile counters in release mode via a Lua interface Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-prometheus

Lua obfuscation using Prometheus No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-proto

Compile and use protobuf messages from Lua

extension-push/push

Functions and constants for interacting with local, as well as Apple''s and Google''s push notification services. These API's only exist on mobile platforms.

extension-qrcode

A small extension to encode and decode QR codes. Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-resource-encryption

Example of how to create a resource encryption plugin for Defold assets No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-review/review

Functions and constants for interacting with review APIs

extension-rive/rive

Rive animation helpers exposed to Lua scripts

extension-rive/rive.cmd

Command queue helpers for interacting with the Rive runtime

extension-safearea/safearea

Defold native extension that will change the view/render of a game to fit into the safe area on iPhones and Android(API 28+) with notch.

extension-simpledata

Example how to bring custom data to a game object Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-siwa/siwa

Functions and constants for interacting Sign in with Apple.

extension-spine/spine

Functions and constants for interacting with Spine models

extension-spine/spine.gui

Functions and constants for interacting with Spine models in GUI

extension-spine/spine.resource

Functions for creating Spine resources dynamically

extension-steam/steam

Functions and constants for interacting with Steamworks.

extension-teal

Defold transpilation support for Teal No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-texturepacker

Adds support for the TexturePacker atlas format No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-videoplayer

Videoplayer for the Defold engine Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-videoplayer-mpeg/mpeg

Functions to play MPEG1 videos

extension-videoplayer-native/videoplayer

Fullscreen video playback using native/HTML5 backends.

extension-vulkan

Enables support for Vulkan graphics No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-webmonetization

Defold integration to the Web Monetization API Lua API not typed — upstream ships no .script_api, so resolve skips it.

extension-websocket/websocket

Functions and constants for using websockets. Supported on all platforms.

extension-webtransport

WebTransport implementation for Defold No Lua API — content, shaders, build-time tooling or engine-side native code only.

extension-webview/webview

Functions and constants for interacting with webview APIs

extension-xsolla/shop

Functions to use the Xsolla Shop Builder API.

extension-zendesk/zendesk

Defold native extension to interact with the Zendesk SDK.

8bitskull

abadonna

AGulev

alchimystic

alfowler1976

AppLovin

astrochili

Balkan-Ram-Games

baochungit

britzl

boom

Boom is a game framework built on top of Defold.

defcon

Defold console helpers for in-game debugging and developer overlays.

defold-clipboard/clipboard

Defold native extension to access the clipboard

defold-gyro/gyro

Gyroscope rotation for Defold on iOS and Android, delivered as a quaternion every frame.

defold-imp/imp

Image processing on Defold buffers: 3x3 convolution kernels for blur, sharpen and edge detection.

defold-input/in.accelerometer

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.button

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.cursor

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.gesture

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.keyboard

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.mapper

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.onscreen

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.state

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.textbox

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-input/in.triggers

Cross-platform input handling for Defold: keyboard, mouse, gamepad, touch, and on-screen controls.

defold-lfs/lfs

File system manipulation library

defold-metrics/metrics.fps

Calculate and display performance metrics in Defold games

defold-metrics/metrics.mem

Calculate and display performance metrics in Defold games

defold-orthographic/orthographic.camera

Orthographic camera functionality for the Defold game engine

defold-png/png

Encode raw pixels into PNG bytes and decode PNG bytes into a Defold buffer, powered by LodePNG.

defold-richtext/richtext.color

Rich-text rendering for Defold: styled spans, embedded tags, and per-color text runs.

defold-richtext/richtext.richtext

Rich-text rendering for Defold: styled spans, embedded tags, and per-color text runs.

defold-richtext/richtext.tags

Rich-text rendering for Defold: styled spans, embedded tags, and per-color text runs.

defold-screenshot/screenshot

Functions for capturing full-screen or partial screenshots.

defold-sharing/share

Defold native extension to share data from a Defold application using native dialogs

deftest

Unit testing in Defold

gooey

Defold GUI system

monarch/monarch.monarch

Monarch is a screen manager for the Defold game engine.

monarch/monarch.transitions.easings

Screen manager for Defold with stacked, modal, and transition-aware navigation flows.

monarch/monarch.transitions.gui

Monarch comes with a system for setting up transitions easily

platypus

Defold platformer engine

colyseus

d954mas

dev-masih

dlannan

Dragosha

elefant-ai

GameAnalytics

glorius-silver

HalfstarDev

heroiclabs

HGPoint

indiesoftby

Insality

itzmiadm

jbp4444

JCash

Jerakin

Klaleus

Lerg

MaratGilyazov

megalanthus

defold-gamepush/gamepush

GamePush (previously GameScore) is the GamePush SDK implementation for the Defold game engine.

defold-gamepush/gamepush.core.achievements

GamePush achievements: lists, unlocking, progress, the achievements overlay and their events.

defold-gamepush/gamepush.core.ads

GamePush advertising: fullscreen, preloader, rewarded and sticky banner ads, their availability and their events.

defold-gamepush/gamepush.core.analytics

GamePush analytics: record page visits and reached goals.

defold-gamepush/gamepush.core.app

GamePush application details: title, description, image and URL, review requests and shortcuts.

defold-gamepush/gamepush.core.channels

GamePush channels: chats, members, invites, join requests, messages and channel state, with their events.

defold-gamepush/gamepush.core.documents

GamePush documents: open and fetch the privacy policy, with their events.

defold-gamepush/gamepush.core.events

GamePush events: list them, join one and check whether it is active, with their events.

defold-gamepush/gamepush.core.experiments

GamePush experiments: the player's experiments and cohort checks.

defold-gamepush/gamepush.core.feedbacks

GamePush player feedback: send feedback, open and fetch the list, and chat about a feedback, with their events.

defold-gamepush/gamepush.core.files

GamePush files: upload, choose, load and fetch player files, with their events.

defold-gamepush/gamepush.core.fullscreen

GamePush fullscreen: enter, leave and toggle it, with their events.

defold-gamepush/gamepush.core.games_collections

GamePush games collections: open the games overlay and fetch a collection, with their events.

defold-gamepush/gamepush.core.images

GamePush images: upload, choose, fetch and resize player images, with their events.

defold-gamepush/gamepush.core.leaderboard

GamePush leaderboards: the leaderboard overlay, fetching leaders and ratings, and scoped records.

defold-gamepush/gamepush.core.logger

GamePush logs: info, warning and error toasts and console logs.

defold-gamepush/gamepush.core.multiplayer

GamePush multiplayer rooms: connect, sync player and global state, send messages and follow the host, with their events.

defold-gamepush/gamepush.core.payments

GamePush in-game purchases and subscriptions: products, purchase, consume and their events.

defold-gamepush/gamepush.core.platform

GamePush platform: which platform the game runs on, its capabilities and calls into its native SDK.

defold-gamepush/gamepush.core.player

GamePush player: login, sync, fields and state, with the player events.

defold-gamepush/gamepush.core.player_stats

GamePush player statistics: days played and time in game.

defold-gamepush/gamepush.core.players

GamePush other players: fetch their data by id.

defold-gamepush/gamepush.core.reactions

GamePush reactions: set and remove a player reaction, with their events.

defold-gamepush/gamepush.core.rewards

GamePush rewards: giving, accepting and checking rewards, with their events.

defold-gamepush/gamepush.core.schedulers

GamePush reward schedulers: daily rewards, extra-activity rewards and their claim checks, with their events.

defold-gamepush/gamepush.core.segments

GamePush player segments: list them and check membership, with their events.

defold-gamepush/gamepush.core.socials

GamePush social actions: share, post, invite friends, join the community and share links, with their events.

defold-gamepush/gamepush.core.sounds

GamePush sounds: mute and unmute all sounds, effects or music, with their events.

defold-gamepush/gamepush.core.storage

GamePush key-value storage: context and global values, with their events.

defold-gamepush/gamepush.core.triggers

GamePush triggers: list them, check activation and claim their rewards, with their events.

defold-gamepush/gamepush.core.uniques

GamePush unique values: register, check, read and delete values unique across players.

defold-gamepush/gamepush.core.variables

GamePush game variables: fetch them and read their values and types.

defold-gamepush/gamepush.core.windows

GamePush overlay windows: the confirmation window and its event.

Minit-Games

Morgerion

myopic-design

Pause-Games

paweljarosz

Playgama

potatojam

defold-ads-wrapper/ads_wrapper.ads_networks.admob

Ads Wrapper network for AdMob on Android and iOS, through the defold/extension-admob extension, using test ad units in debug mode.

defold-ads-wrapper/ads_wrapper.ads_networks.admob_legacy

Ads Wrapper legacy network for AdMob on Android and iOS, through the defold/extension-admob extension.

defold-ads-wrapper/ads_wrapper.ads_networks.applovin_max

Ads Wrapper network for AppLovin MAX on Android, through the defold-maxsdk extension, with its banner position and size constants.

defold-ads-wrapper/ads_wrapper.ads_networks.game_distribution

Ads Wrapper network for GameDistribution on HTML5, through the gd-defold extension, with its banner sizes and message listener key.

defold-ads-wrapper/ads_wrapper.ads_networks.ironsource

Ads Wrapper network for ironSource on Android and iOS, through the defold/extension-ironsource extension.

defold-ads-wrapper/ads_wrapper.ads_networks.poki

Ads Wrapper network for Poki on HTML5, through the defold/extension-poki-sdk extension; Poki serves no banners.

defold-ads-wrapper/ads_wrapper.ads_networks.poki_legacy

Ads Wrapper legacy network for Poki on HTML5, through the AGulev/defold-poki-sdk extension.

defold-ads-wrapper/ads_wrapper.ads_networks.portalsdk

Ads Wrapper network for rewarded and interstitial ads on HTML5, through PortalSDK for Defold.

defold-ads-wrapper/ads_wrapper.ads_networks.test

Two test networks for Ads Wrapper that log each call and succeed without showing an ad.

defold-ads-wrapper/ads_wrapper.ads_networks.unity

Ads Wrapper network for Unity Ads on Android and iOS, through the DefVideoAds extension.

defold-ads-wrapper/ads_wrapper.ads_networks.vk

Ads Wrapper network for VK Games on HTML5, through the defold-vkbridge extension.

defold-ads-wrapper/ads_wrapper.ads_networks.yandex

Ads Wrapper network for Yandex Games on HTML5, through the defold-yagames extension.

defold-ads-wrapper/ads_wrapper.ads_networks.yandex_mobile

Ads Wrapper network for Yandex Mobile Ads on Android and iOS, through the defold-yandex-sdk-ads extension.

defold-ads-wrapper/ads_wrapper.ads_wrapper

Ads Wrapper is a wrapper for advertising services. It allows you to use one interface for different services and show ads from different sources. Supports various services such as Admob, Unity Ads, Poki, Yandex, Vk Bridge, Applovin Max

defold-ads-wrapper/ads_wrapper.events

Ads Wrapper response results, response codes and debug verbosity levels, as hashes.

defold-ads-wrapper/ads_wrapper.platform

Platform constants and a check for the running platform, for Ads Wrapper network settings.

defold-ads-wrapper/ads_wrapper.queue

The Ads Wrapper call queue, including the switch for its debug output.

s-kania

selimanac

defold-3D-outline-shader/outline

3D model outline shader for Defold: stencil or inverted-hull outlines drawn from a render script, with settable color, thickness and predicate tag.

defold-astar/astar

A* Path Finding

defold-biplanar-mapping

World-space biplanar texture mapping shader for Defold. Applies textures based on world position and surface normals — no UV unwrapping required. Ideal for terrain, rocks, and organic geometry. No Lua API — content, shaders, build-time tooling or engine-side native code only.

defold-daabbcc/daabbcc

Dynamic Tree (aka AABB Tree) native extension for Defold Engine

defold-daabbcc3d/daabbcc3d

Dynamic AABB trees in 3D for overlap queries and ray casts without a physics engine.

defold-pixelart-shader/pixelart.scripts.pixelart

Pixelart shader

defold-pixelart-shader/pixelart.scripts.pixelart_render

Render-script half of the pixel-art shader: creates its render targets and predicates, then draws the shadow, depth and pixelate passes each frame.

defold-random/random

PCG Random Number Generator Native Extension for the Defold Game Engine

defold-stylized-water-shader/water

A stylized water shader: animated wave surfaces, foam, sparkles, refraction and

defold-tile-raycast/tile_raycast

Ray Casting in tiled worlds using DDA algorithm.

defold-toon-shader

Toon shader for 3D models. No Lua API — content, shaders, build-time tooling or engine-side native code only.

defold-uuid4/uuid4

Defold uuid4 generator native extension

defold-wave/wave

Wave simulation that floats, pitches and rolls game objects on a water surface.

sergeysinyavsky

subsoap

thejustinwalsh

TheKing0x9

tocaRepo

ufgo

VitusVeit

whiteboxdev

widgrensit

asobi-defold/asobi.api.auth

asobi sign-in over REST: accounts, OAuth, guest devices, linked providers and the token

asobi-defold/asobi.api.dm

asobi direct messages over REST. A project reaches it as `client.dm`.

asobi-defold/asobi.api.economy

asobi wallets and the store over REST. A project reaches it as `client.economy`.

asobi-defold/asobi.api.iap

asobi in-app purchase verification over REST. A project reaches it as `client.iap`.

asobi-defold/asobi.api.inventory

The asobi inventory over REST. A project reaches it as `client.inventory`.

asobi-defold/asobi.api.leaderboards

asobi leaderboards over REST. A project reaches it as `client.leaderboards`.

asobi-defold/asobi.api.matches

asobi matches over REST. A project reaches it as `client.matches`.

asobi-defold/asobi.api.matchmaker

The asobi matchmaker over REST. A project reaches it as `client.matchmaker`.

asobi-defold/asobi.api.notifications

asobi notifications over REST. A project reaches it as `client.notifications`.

asobi-defold/asobi.api.players

asobi player profiles over REST. A project reaches it as `client.players`.

asobi-defold/asobi.api.social

asobi friends, groups and chat history over REST. A project reaches it as `client.social`.

asobi-defold/asobi.api.storage

asobi cloud saves and key-value storage over REST. A project reaches it as

asobi-defold/asobi.api.tournaments

asobi tournaments over REST. A project reaches it as `client.tournaments`.

asobi-defold/asobi.api.votes

asobi match votes over REST. A project reaches it as `client.votes`.

asobi-defold/asobi.api.worlds

asobi worlds over REST. A project reaches it as `client.worlds`.

asobi-defold/asobi.client

The asobi client. `create` builds a client for one asobi server, carrying its tokens and

asobi-defold/asobi.device

Guest device credentials: a stable device id and secret that a game generates once, saves,

asobi-defold/asobi.http

The asobi REST transport. Each verb sends a JSON request to the client's server with its

asobi-defold/asobi.realtime

The realtime connection a client creates as `client.realtime`: one websocket that

Wolfe2x7

wraplord

wvdsh

On this page