https://github.com/defold/extension-kaios
Defold native extension for use with KaiOS
https://github.com/defold/extension-kaios
Last synced: 4 months ago
JSON representation
Defold native extension for use with KaiOS
- Host: GitHub
- URL: https://github.com/defold/extension-kaios
- Owner: defold
- License: mit
- Created: 2021-02-16T23:40:42.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T07:15:48.000Z (over 1 year ago)
- Last Synced: 2025-01-30T15:25:12.783Z (12 months ago)
- Language: C++
- Homepage:
- Size: 128 KB
- Stars: 3
- Watchers: 4
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KaiOS extension
Defold native extension for use with KaiOS. See also [extension-kaiads](https://github.com/defold/extension-kaiads) for KaiAds integration.
## KaiOS HTML template
The extension provides a [modified version](/kaios/engine_template.html) of the default `engine_template.html` from builtins. The modifications are:
* Removed "Made with Defold" and Fullscreen" `
`
* Hardcoded `Module['isWASMSupported']` to false (WASM is not supported on current KaiOS devices)
* Load `Defold.js` (see below)
* Canvas always resized to `fit`.
## KaiOS key support
The extension adds support for KaiOS specific keys:
* Left Softkey - Mapped to KEY_F1
* Right Softkey - Mapped to KEY_F2
* Call - Mapped to KEY_MENU
## API functions
The extension adds the following API functions:
### kaios.exit()
Close a KaiOS application (will call window.close()).
TODO: Should we instead use sys.exit() and hook into the application lifecycle somehow through the extension and do a `window.close()`?
### kaios.play_sound(sound, options)
Play a sound using JavaScript AudioContext. Sounds must be bundled using the "bundle resources" setting in game.project. Functionality for setting up an AudioContext and keeping track of audio buffers can be found in [`Defold.js`](https://github.com/defold/extension-kaios/blob/main/kaios/res/web/Defold.js) which is included with the extension.
```
-- play and loop sound
kaios.play_sound("sound.wav", { loop = true })
```
### kaios.stop_sound(sound)
Stop a sound played using `kaios.play_sound()`. Note: Sounds are of a "fire and forget" nature. If the same sound is played multiple times this function will only ever stop the most recently played instance of the sound.
```
kaios.stop_sound("sound.wav")
```