touch-coop 1.0.0

package/dist/match.d.ts

@@ -0,0 +1,31 @@
+export interface BasePlayerEvent {
+    playerId: string;
+    timestamp: number;
+}
+export interface JoinLeaveEvent {
+    action: "JOIN" | "LEAVE";
+}
+export interface MoveEvent {
+    action: "MOVE";
+    button: string;
+}
+export type PlayerEvent = (JoinLeaveEvent | MoveEvent) & BasePlayerEvent;
+type OnPlayerEventHandler = (data: PlayerEvent) => void;
+export declare class Match {
+    private _playerConnections;
+    private _playerChannels;
+    private _invitationAccepted;
+    private _onPlayerEvent;
+    private _gamepadUiUrl;
+    constructor(gamepadUiUrl: string, onPlayerEvent: OnPlayerEventHandler);
+    private _UUIID;
+    requestNewPlayerToJoin(): Promise<{
+        dataUrl: string;
+        playerId: string;
+        shareURL: string;
+    }>;
+    getInvitationStatus(playerId: string): boolean | undefined;
+    acceptPlayerAnswer(playerId: string, base64Answer: string): Promise<void>;
+}
+export {};
+//# sourceMappingURL=match.d.ts.map

package/dist/match.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"match.d.ts","sourceRoot":"","sources":["../src/match.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,cAAc,GAAG,SAAS,CAAC,GAAG,eAAe,CAAC;AAEzE,KAAK,oBAAoB,GAAG,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;AAExD,qBAAa,KAAK;IAChB,OAAO,CAAC,kBAAkB,CAA6C;IACvE,OAAO,CAAC,eAAe,CAA0C;IACjE,OAAO,CAAC,mBAAmB,CAAmC;IAC9D,OAAO,CAAC,cAAc,CAAqC;IAC3D,OAAO,CAAC,aAAa,CAAS;gBAClB,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,oBAAoB;IAyBrE,OAAO,CAAC,MAAM;IAOR,sBAAsB;iBACI,MAAM;kBAAY,MAAM;kBAAY,MAAM;;IAqD1E,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAGpD,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAChE"}

package/dist/player.d.ts

@@ -0,0 +1,9 @@
+export declare class Player {
+    private _pc;
+    private _playerId;
+    private _dataChannel;
+    constructor();
+    joinMatch(): Promise<void>;
+    sendMove(button: string): Promise<void>;
+}
+//# sourceMappingURL=player.d.ts.map

package/dist/player.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"player.d.ts","sourceRoot":"","sources":["../src/player.ts"],"names":[],"mappings":"AAGA,qBAAa,MAAM;IACjB,OAAO,CAAC,GAAG,CAAoB;IAC/B,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,YAAY,CAA+B;;IAkC7C,SAAS;IAqCT,QAAQ,CAAC,MAAM,EAAE,MAAM;CAiB9B"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "touch-coop",
+  "version": "1.0.0",
+  "description": "Allow players to play couch co-op in your game using their mobile devices as controllers.",
+  "main": "dist/index.cjs",
+  "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "start": "vite",
+    "lint": "npx @biomejs/biome check",
+    "lint-and-format": "npx @biomejs/biome check --write --unsafe",
+    "build": "vite build && tsc --emitDeclarationOnly"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/qrcode": "^1.5.6",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1"
+  },
+  "dependencies": {
+    "qrcode": "^1.5.4"
+  }
+}

package/src/encoding.ts

@@ -0,0 +1,42 @@
+export async function compressOfferData(originalText: string) {
+  const encoder = new TextEncoder();
+  const stream = new CompressionStream("gzip");
+  const writer = stream.writable.getWriter();
+  writer.write(encoder.encode(originalText));
+  writer.close();
+  const reader = stream.readable.getReader();
+  const chunks = [];
+  while (true) {
+    const { done, value } = await reader.read();
+    if (done) break;
+    chunks.push(value);
+  }
+  const compressed = new Uint8Array(await new Blob(chunks).arrayBuffer());
+  const base64 = btoa(String.fromCharCode(...compressed));
+  const safeBase64 = base64
+    .replace(/\+/g, "-")
+    .replace(/\//g, "_")
+    .replace(/=+$/, "");
+  return safeBase64;
+}
+
+export async function decompressOfferData(
+  base64Input: string,
+): Promise<string> {
+  let base64 = (base64Input || "").trim();
+  base64 = base64.replace(/\s+/g, "");
+  base64 = base64.replace(/-/g, "+").replace(/_/g, "/");
+  const mod = base64.length % 4;
+  if (mod === 2) {
+    base64 += "==";
+  } else if (mod === 3) {
+    base64 += "=";
+  }
+  const binaryString = atob(base64);
+  const bytes = Uint8Array.from(binaryString, (c) => c.charCodeAt(0));
+  const decompressedStream = new Blob([bytes])
+    .stream()
+    .pipeThrough(new DecompressionStream("gzip"));
+  const text = await new Response(decompressedStream).text();
+  return text;
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./player";
+export * from "./match";

package/src/match.ts

@@ -0,0 +1,118 @@
+import QRCode from "qrcode";
+import { compressOfferData } from "./encoding";
+
+export interface BasePlayerEvent {
+  playerId: string;
+  timestamp: number;
+}
+
+export interface JoinLeaveEvent {
+  action: "JOIN" | "LEAVE";
+}
+
+export interface MoveEvent {
+  action: "MOVE";
+  button: string;
+}
+
+export type PlayerEvent = (JoinLeaveEvent | MoveEvent) & BasePlayerEvent;
+
+type OnPlayerEventHandler = (data: PlayerEvent) => void;
+
+export class Match {
+  private _playerConnections: Map<string, RTCPeerConnection> = new Map();
+  private _playerChannels: Map<string, RTCDataChannel> = new Map();
+  private _invitationAccepted: Map<string, boolean> = new Map();
+  private _onPlayerEvent: OnPlayerEventHandler | null = null;
+  private _gamepadUiUrl: string;
+  constructor(gamepadUiUrl: string, onPlayerEvent: OnPlayerEventHandler) {
+    this._onPlayerEvent = onPlayerEvent;
+    this._gamepadUiUrl = gamepadUiUrl;
+    const channel = new BroadcastChannel("touch-coop-signaling");
+    channel.onmessage = async (event) => {
+      const data = event.data;
+      if (
+        data &&
+        data.type === "answer" &&
+        data.playerId &&
+        data.base64Answer
+      ) {
+        try {
+          const pc = this._playerConnections.get(data.playerId);
+          if (!pc) {
+            throw new Error(`No peer connection for player: ${data.playerId}`);
+          }
+          const answerObject = JSON.parse(atob(data.base64Answer));
+          await pc.setRemoteDescription(answerObject.sdp);
+          // Mark invitation as accepted
+          this._invitationAccepted.set(data.playerId, true);
+        } catch (err) {}
+      }
+    };
+  }
+  private _UUIID() {
+    return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
+      const r = (Math.random() * 16) | 0;
+      const v = c === "x" ? r : (r & 0x3) | 0x8;
+      return v.toString(16);
+    });
+  }
+  async requestNewPlayerToJoin() {
+    return new Promise<{ dataUrl: string; playerId: string; shareURL: string }>(
+      (resolve, reject) => {
+        (async () => {
+          const newPlayer = this._UUIID();
+          const pc = new RTCPeerConnection();
+          const dataChannel = pc.createDataChannel("player");
+          this._playerConnections.set(newPlayer, pc);
+          this._playerChannels.set(newPlayer, dataChannel);
+          this._invitationAccepted.set(newPlayer, false);
+          dataChannel.onmessage = (msg) => {
+            if (this._onPlayerEvent) {
+              let eventData = msg.data;
+              eventData = JSON.parse(msg.data);
+              this._onPlayerEvent(eventData);
+            }
+          };
+          const offer = await pc.createOffer();
+          await pc.setLocalDescription(offer);
+          await new Promise((resolveIce) => {
+            pc.onicecandidate = (event) => {
+              if (!event.candidate) {
+                resolveIce(void 0);
+              }
+            };
+          });
+          const offerObject = {
+            playerId: newPlayer,
+            sdp: pc.localDescription,
+          };
+          const offerJSON = JSON.stringify(offerObject);
+          const compressedBase64OfferObject =
+            await compressOfferData(offerJSON);
+          const shareURL = `${this._gamepadUiUrl}?remoteSDP=${compressedBase64OfferObject}`;
+          QRCode.toDataURL(
+            shareURL,
+            { errorCorrectionLevel: "M" },
+            (err, dataUrl) => {
+              if (err) {
+                return reject(err);
+              }
+              resolve({
+                dataUrl: dataUrl,
+                shareURL: shareURL,
+                playerId: newPlayer,
+              });
+            },
+          );
+        })();
+      },
+    );
+  }
+
+  // Returns true if invitation was accepted, false if still pending, undefined if not found
+  getInvitationStatus(playerId: string): boolean | undefined {
+    return this._invitationAccepted.get(playerId);
+  }
+  async acceptPlayerAnswer(playerId: string, base64Answer: string) {}
+}

package/src/player.ts

@@ -0,0 +1,95 @@
+import { decompressOfferData } from "./encoding";
+import type { PlayerEvent } from "./match";
+
+export class Player {
+  private _pc: RTCPeerConnection;
+  private _playerId: string | null = null;
+  private _dataChannel: RTCDataChannel | null = null;
+  constructor() {
+    this._pc = new RTCPeerConnection();
+    this._pc.ondatachannel = (event) => {
+      this._dataChannel = event.channel;
+      this._dataChannel.onopen = () => {
+        if (this._playerId && this._dataChannel) {
+          const joinEvent = {
+            playerId: this._playerId,
+            action: "JOIN",
+            timestamp: Date.now(),
+          };
+          this._dataChannel.send(JSON.stringify(joinEvent));
+        }
+      };
+    };
+    window.addEventListener("beforeunload", () => {
+      if (
+        this._dataChannel &&
+        this._dataChannel.readyState === "open" &&
+        this._playerId
+      ) {
+        const leaveEvent = {
+          playerId: this._playerId,
+          action: "LEAVE",
+          button: "",
+          timestamp: Date.now(),
+        };
+        try {
+          this._dataChannel.send(JSON.stringify(leaveEvent));
+        } catch {}
+      }
+    });
+  }
+  async joinMatch() {
+    const params = new URLSearchParams(window.location.search);
+    const remoteBase64 = params.get("remoteSDP");
+    if (!remoteBase64) {
+      throw new Error("No remoteSDP found in URL parameters.");
+    }
+    const decodedURL = await decompressOfferData(remoteBase64);
+    const remoteObject = JSON.parse(decodedURL);
+    this._playerId = remoteObject.playerId;
+    const remoteSDP = remoteObject.sdp;
+    await this._pc.setRemoteDescription(remoteSDP);
+    if (remoteSDP.type === "offer") {
+      const answer = await this._pc.createAnswer();
+      await this._pc.setLocalDescription(answer);
+      await new Promise((resolve) => {
+        this._pc.onicecandidate = (event) => {
+          if (!event.candidate) {
+            resolve(void 0);
+          }
+        };
+      });
+      const answerObject = {
+        playerId: this._playerId,
+        sdp: this._pc.localDescription,
+      };
+      const answerJSON = JSON.stringify(answerObject);
+      const base64AnswerObject = btoa(answerJSON);
+      const channel = new BroadcastChannel("touch-coop-signaling");
+      const msg = {
+        type: "answer",
+        playerId: this._playerId,
+        base64Answer: base64AnswerObject,
+      };
+      channel.postMessage(msg);
+      channel.close();
+    }
+  }
+  async sendMove(button: string) {
+    if (this._dataChannel && this._dataChannel.readyState === "open") {
+      if (!this._playerId) {
+        throw new Error("Player ID is not set. Cannot send data.");
+      }
+      const playerEvent: PlayerEvent = {
+        playerId: this._playerId,
+        action: "MOVE",
+        button: button,
+        timestamp: Date.now(),
+      };
+      const playerEventJSON = JSON.stringify(playerEvent);
+      this._dataChannel.send(playerEventJSON);
+    } else {
+      console.warn("Data channel is not open. Cannot send data.");
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,98 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "libReplacement": true,                           /* Enable lib replacement. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "erasableSyntaxOnly": true,                       /* Do not allow runtime constructs that are not part of ECMAScript. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist", "node_modules", "vite.config.ts"]
+}

package/vite.config.ts

@@ -0,0 +1,36 @@
+import { resolve } from "node:path";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: resolve(__dirname, "src/index.ts"),
+      name: "TouchCoop",
+      fileName: (format) => {
+        if (format === "es") return "index.mjs";
+        if (format === "cjs") return "index.cjs";
+        if (format === "iife") return "index.global.js";
+        return `index.${format}.js`;
+      },
+      formats: ["es", "cjs", "iife"],
+    },
+    outDir: "dist",
+    emptyOutDir: true,
+    rollupOptions: {
+      external: (id) => {
+        // For IIFE (browser), bundle all dependencies (including qrcode)
+        if (/qrcode/.test(id)) {
+          // Only externalize for es/cjs
+          const format = process.env.BUILD_FORMAT;
+          return format === "es" || format === "cjs";
+        }
+        return false;
+      },
+      output: {
+        globals: {
+          // No external globals needed for IIFE
+        },
+      },
+    },
+  },
+});