Lingara Lingara 說明文件 學習指南 API 函式庫 應用程式 起造 嵌入 網頁版
語言: 閩南語

嵌入 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 對話

    你的世界內底的一个角色,用玩家的目標語言、照伊的等級講話,一擺串流一个回合。

  • 練習結果

    佇你的遊戲內底練習一个課程計畫,回報練習的結果,閣佇你的伺服器收著通知。