Getting Started

A simple example

The following index.html shows a complete webxdc app, with an input field shown on all peers. Data submitted from the input is delivered to all members of the chat.

<!DOCTYPE html>
    <meta charset="utf-8"/>
    <script src="webxdc.js"></script>
    <input id="input" type="text"/>
    <a href="" onclick="sendMsg(); return false;">Send</a>
    <p id="output"></p>
      function sendMsg() {
        msg = document.getElementById("input").value;
        window.webxdc.sendUpdate({payload: msg}, 'Someone typed "'+msg+'".');
      function receiveUpdate(update) {
        document.getElementById('output').innerHTML += update.payload + "<br>";
      window.webxdc.setUpdateListener(receiveUpdate, 0);

To package the app as a .xdc file, zip the directory containing the index.html:

zip -9 --recurse-paths "myapp.xdc" PATH_TO_DIR

Now it's possible to share the myapp.xdc file in any chat: recipients can hit "Start" to begin using the app to enter text in this input field and send updates to each other.

To simulate multiple chat participants in the browser, try Hello as a minimal example; it includes everything needed to run the app and requires no build systems.

More examples

Source code for apps referenced on the webxdc home page can be found in the Webxdc GitHub organization.

Participating in developments

  • Webxdc GitHub organization: contains many example app repositories. Please tag your own app experiments with "webxdc" so that others can find it via the #webxdc Topic on GitHub.

  • Support Forum: the webxdc category on the DeltaChat forum is a space to ask questions and announce your app projects. Log into the forum via DeltaChat, Github, or by creating a username and password there.

  • Announcements: Delta Chat and Webxdc-related developments can be followed on Fediverse or Twitter.