Lingara Lingara 說明文件 學習指南 API 函式庫 App 建立 嵌入 網頁版
語言: 客家話

嵌入 Lingara

這頁係對英文翻譯過來个。若係兩片無共樣,以英文頁為準。 看英文頁

Lingara 做得住在你个遊戲抑係網站肚。你世界肚个角色做得照玩家个等級摎佢對話,你个玩家完成个練習也會算做 Lingara 練習。嵌入分做兩半,第一件愛決定个事情,就係哪一半在哪位行。

麼人保管麼个

你个伺服器保管你 OAuth 用戶端个密鑰,摎你个 webhook 簽名密鑰。這兩隻永遠毋會離開佢。

玩家个裝置淨保管一樣東西:一隻嵌入權杖,開頭係 lgr_et_。你放在遊戲執行檔抑係網頁肚發布出去个任何東西都係公開个,所以裝置永遠毋會保管用戶端密鑰、webhook 密鑰,抑係你自家用戶端个存取權杖。一隻嵌入權杖淨代表一隻玩家,有效時間係幾分鐘,毋係幾點鐘,再淨有你个伺服器分佢个權限範圍。

玩家毋使 Lingara 帳戶。你个伺服器第一擺為一隻玩家簽發个權杖,會為佢建立一隻訪客學習者,以後个每隻權杖都會對到同一隻學習者。已經有 Lingara 帳戶个玩家做得帶佢來:伺服器套件頁面有說明你个伺服器仰般將兩隻連結起來。

權杖仰般到玩家該位

  1. 你遊戲抑係網頁肚个玩家套件需要權杖,就透過佢个權杖來源去問你个伺服器。
  2. 你个伺服器檢查佢自家對該隻玩家个工作階段,再用伺服器套件為佢簽發一隻權杖。
  3. 你个伺服器用兩隻欄位將權杖交轉去,就係權杖摎佢个到期時間,透過你自家个工作階段,永遠毋係放在 URL 肚。
  4. 玩家套件會一直用這隻權杖,到佢快到期,正再去問你个伺服器。Lingara 永遠毋會更新權杖。
 player's device                your server                    Lingara
 ───────────────                ───────────                    ───────
 player kit ── needs a token ──▶ your token route
                                 server kit ── mint ─────────▶ token for one player
 player kit ◀── token, expiry ── your token route ◀──────────
 player kit ── API calls with the token ─────────────────────▶

網站用个權杖會綁在一隻來源:網頁自家个協定、主機摎連接埠。你个小工具行个每隻來源,都愛在為佢簽發權杖以前先註冊,照伺服器套件頁面个說明。遊戲用个權杖無來源。

權杖做得做麼个

你个伺服器簽發權杖个時節,從這五隻肚揀佢个權限範圍:events:read、events:write、lesson_plans:read、lesson_plans:write 摎 embed:play。權杖淨做得有你自家个用戶端已經有个權限範圍。embed:play 分玩家做得摎你个角色對話,再回報佢完成个練習。

麼人付錢

淨有計量方案个用戶端做得簽發權杖。玩家用權杖做个所有事情,都算做你用戶端个用量,算在你个帳,毋係玩家个。

刪除玩家

玩家在你个遊戲肚刪除佢个帳戶个時節,你个伺服器也會在 Lingara 將佢刪除。這會移除佢个學習者,摎 Lingara 為佢保管个所有東西,再撤銷佢所有个權杖。

你需要哪一隻套件

每隻整合都用兩隻套件:一隻伺服器套件在你个伺服器,一隻玩家套件在玩家在該搞个位所。

你在該開發个你个伺服器玩家在該搞个位所
Bevy 遊戲伺服器套件Bevy
Unity 遊戲伺服器套件Unity
Godot 遊戲伺服器套件Godot
Unreal 遊戲伺服器套件Unreal
JVM 抑係 Android 个遊戲伺服器套件JVM 摎 Android
網站伺服器套件網站小工具

過後請讀 NPC 對話摎練習結果,這兩項在每隻套件肚都共樣運作。

開始

  • 伺服器套件

    從你自家个伺服器為你个玩家簽發權杖、轉送佢兜个事件,再將佢兜刪除。

在哪位運行

  • Bevy

    將 Lingara 外掛程式加入一隻 Bevy 遊戲,回應佢个權杖請求,再將佢个事件當做 Message 來讀。

  • Unity

    透過 NuGetForUnity 安裝 Lingara.Embed,從你个伺服器拿權杖,再在 Update 肚清事件。

  • Godot

    在 Godot 4 遊戲肚用 Lingara,用 GDScript 抑係 C#,權杖從你自家个伺服器來。

  • Unreal

    Unreal Engine 5 个 Lingara 外掛程式,建立在玩家核心个 C 介面頂高。

  • JVM 摎 Android

    Kotlin 玩家套件摎佢个 Java 門面,在桌面摎 Android 頂高,用 libGDX 做例。

  • 網站小工具

    將 lingara-embed 元素掛在你个網頁頂高,再從你自家个伺服器分佢權杖。

在你个世界學習

  • NPC 對話

    你个世界肚个一隻角色,用玩家个目標語言、照佢个等級講話,一擺串流一隻回合。

  • 練習結果

    在你个遊戲肚練習一隻課程計畫,回報練習个結果,再在你个伺服器收到通知。