From 0eb0169ad9f41af2d0daaf648c2c0a2c9ca1d847 Mon Sep 17 00:00:00 2001 From: Timo K Date: Fri, 9 Jan 2026 16:00:02 +0100 Subject: [PATCH 1/4] update example --- sdk/index.html | 25 +++---------------------- 1 file changed, 3 insertions(+), 22 deletions(-) diff --git a/sdk/index.html b/sdk/index.html index 1420c3ea..8883b9a3 100644 --- a/sdk/index.html +++ b/sdk/index.html @@ -1,7 +1,7 @@ - Godot MatrixRTC Widget + MatrixRTC Widget - - -
From b7838e43533ee2af50472cdf9ec2ff1326670c08 Mon Sep 17 00:00:00 2001 From: Timo K Date: Fri, 9 Jan 2026 16:25:06 +0100 Subject: [PATCH 2/4] Update README.md --- sdk/README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/sdk/README.md b/sdk/README.md index 03801b83..27d2de6d 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -6,15 +6,35 @@ It allows to use matrixRTC in combination with livekit without relying on elemen This is done by instantiating the call view model and exposing some useful behaviors (observables) and methods. -This folder contains an example index.html file that showcases the sdk in use (hosted on localhost:8123 with a webserver ellowing cors (for example `npx serve -l 81234 --cors`)) as a godot engine HTML export template. +This folder contains an example index.html file that showcases the sdk in use (hosted on localhost:8123 with a webserver allowing cors (for example `npx serve -l 81234 --cors`)) as a godot engine HTML export template. + +## Getting started + +To get started run +``` +yarn +yarn build:sdk +``` +in the repository root. + +It will create a `dist` folder containing the compiled js file. + +This file needs to be hosted. Locally (via `npx serve -l 81234 --cors`) or on a remote server. + +Now you just need to add the widget to element web via: +``` +/addwidget http://localhost:3000?widgetId=$matrix_widget_id&perParticipantE2EE=true&userId=$matrix_user_id&deviceId=$org.matrix.msc3819.matrix_device_id&baseUrl=$org.matrix.msc4039.matrix_base_url&roomId=$matrix_room_id +``` ## Widgets -The sdk mode is particularly interesting to be used in widgets where you do not need to pay attention to matrix login/cs api ... -To create a widget see the example index.html file in this folder. And add it to EW via: +The sdk mode is particularly interesting to be used in widgets. In widgets you do not need to pay attention to matrix login/cs api ... +To create a widget see the example `index.html` file in this folder. And add it to EW via: `/addwidget ` (see **url parameters** for more details on ``) ### url parameters +The url parameters are needed to pass initial data to the widget. They will automatically be used +but the matrixRTCSdk to start the postmessage widget api (communication between the client (e.g. Element Web) and the widget) ``` widgetId = $matrix_widget_id From 70b7ebff80cfd83e5b45eda0350b17d2f992b3a8 Mon Sep 17 00:00:00 2001 From: Timo K Date: Fri, 9 Jan 2026 16:32:14 +0100 Subject: [PATCH 3/4] prettier --- sdk/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sdk/README.md b/sdk/README.md index 27d2de6d..9282fc1f 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -11,10 +11,12 @@ This folder contains an example index.html file that showcases the sdk in use (h ## Getting started To get started run + ``` yarn yarn build:sdk ``` + in the repository root. It will create a `dist` folder containing the compiled js file. @@ -22,6 +24,7 @@ It will create a `dist` folder containing the compiled js file. This file needs to be hosted. Locally (via `npx serve -l 81234 --cors`) or on a remote server. Now you just need to add the widget to element web via: + ``` /addwidget http://localhost:3000?widgetId=$matrix_widget_id&perParticipantE2EE=true&userId=$matrix_user_id&deviceId=$org.matrix.msc3819.matrix_device_id&baseUrl=$org.matrix.msc4039.matrix_base_url&roomId=$matrix_room_id ``` @@ -33,6 +36,7 @@ To create a widget see the example `index.html` file in this folder. And add it `/addwidget ` (see **url parameters** for more details on ``) ### url parameters + The url parameters are needed to pass initial data to the widget. They will automatically be used but the matrixRTCSdk to start the postmessage widget api (communication between the client (e.g. Element Web) and the widget) From 0b766472ed7017ba04395dc21f6047796354cd44 Mon Sep 17 00:00:00 2001 From: Timo <16718859+toger5@users.noreply.github.com> Date: Fri, 9 Jan 2026 17:30:02 +0100 Subject: [PATCH 4/4] Update sdk/README.md Co-authored-by: Robin --- sdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/README.md b/sdk/README.md index 9282fc1f..91337f10 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -38,7 +38,7 @@ To create a widget see the example `index.html` file in this folder. And add it ### url parameters The url parameters are needed to pass initial data to the widget. They will automatically be used -but the matrixRTCSdk to start the postmessage widget api (communication between the client (e.g. Element Web) and the widget) +by the matrixRTCSdk to start the postmessage widget api (communication between the client (e.g. Element Web) and the widget) ``` widgetId = $matrix_widget_id