Skip to content

miniapp.yaml Yapilandirmasi

Her mini-app, ZIP paketinin kokunde bir miniapp.yaml dosyasi icerebilir. Bu dosya, platformun mini-app'inizi nasil yukleyecegini ve goruntuleyecegini kontrol eder.

miniapp.yaml dosyasi yoksa varsayilan degerler kullanilir.

Tam Ornek

yaml
menuButton:
  enabled: true
  opacity: 1.0
  color: "#6200EE"
  position: "top-right"

externalRuntime:
  name: "godot"
  version: "4.2"
  fileName: "godot.js"

Mini-app'inizin uzerinde gorunen kayan menu butonunu kontrol eder. Bu buton, kullanicilarin ana uygulamaya donmesini veya diger platform ozelliklerine erismesini saglar.

AlanTipVarsayilanAciklama
enabledbooleantrueMenu butonunu goster veya gizle
opacitynumber1.0Buton seffafligi (0.0 - 1.0)
colorstringplatform defaultHex renk kodu (orn. "#6200EE")
positionstring"top-right"Butonun ekrandaki konumu

Konum Degerleri

DegerAciklama
"top-right"Sag ust kose
"top-left"Sol ust kose
"bottom-right"Sag alt kose
"bottom-left"Sol alt kose

Ornekler

Menu butonunu gizle:

yaml
menuButton:
  enabled: false

Yari seffaf, sol altta buton:

yaml
menuButton:
  enabled: true
  opacity: 0.5
  color: "#FF5722"
  position: "bottom-left"

TIP

Menu butonunu gizlerseniz (enabled: false), mini-app'inizin kullanicilarin cikis yapabilecegi kendi yontemini sagladigindan emin olun. Aksi halde kullanicilar mini-app'inizde takilabilir.


externalRuntime

Mini-app'iniz paylasilmis bir external runtime kullaniyorsa (ornegin bir oyun motoru), bunu burada tanimlayabilirsiniz. Platform, runtime JS dosyasini ZIP'inizin icerisinden degil, paylasilmis bir cache'den saglar.

Bu, mini-app'inizin indirme boyutunu onemli olcude azaltir. Ornegin Godot'nun runtime JS'i (godot.js) ~30MB'dir — bunu external runtime olarak tanimladiginizda, dosya bir kez indirilir ve ayni motoru kullanan tum mini-app'ler arasinda paylasilir.

AlanTipZorunluVarsayilanAciklama
namestringevetRuntime tanimlayicisi
versionstringhayirmotorun varsayilaniRuntime versiyonu
fileNamestringhayirmotorun varsayilaniRuntime JS dosya adi

Desteklenen Runtime'lar

AdVarsayilan VersiyonVarsayilan Dosya Adi
godot4.2godot.js
threejsr158three.min.js

Nasil Calisir

  1. Yukleme: Mini-app ZIP'inizi externalRuntime tanimli olarak yuklerseniz, platform otomatik olarak runtime JS dosyasini ZIP'ten cikarir ve boyutu azaltir.

  2. Indirme: Bir kullanici mini-app'inizi actiginda, platform runtime JS'i yerel cache'den enjekte eder. Cache'de dosya yoksa, ZIP'teki orijinal JS yedek olarak kullanilir.

  3. Paylasilmis cache: Runtime JS cihaz basina bir kez indirilir ve ayni runtime ve versiyonu kullanan tum mini-app'ler arasinda paylasilir.

Ornekler

Varsayilanlarla Godot oyunu:

yaml
externalRuntime:
  name: "godot"

Godot v4.2 ve godot.js kullanir — tum varsayilanlar.

Belirli versiyonlu Godot oyunu:

yaml
externalRuntime:
  name: "godot"
  version: "4.3"
  fileName: "godot.js"

Three.js mini-app:

yaml
externalRuntime:
  name: "threejs"

WARNING

version ve fileName degerlerinin mini-app'inizin derlendigi gercek runtime dosyalariyla eslestirdiginizden emin olun. Versiyon uyumsuzlugu calisma zamani hatalarina neden olabilir.

INFO

externalRuntime tanimlamazsaniz, platform runtime JS'in ZIP'inizde pakete dahil oldugunu varsayar ve optimizasyon uygulanmaz. Mini-app'iniz her iki durumda da calisir.


Dosya Konumu

miniapp.yaml dosyasi ZIP paketinizin kokune yerlestirilmelidir:

your-miniapp.zip
├── index.html
├── miniapp.yaml      ← burada
├── game.js
├── assets/
│   └── ...
└── ...