dewdrop-sdk 0.5.3 → 0.5.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dewdrop-sdk",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "description": "Build a three.js game for Dewdrop: the Vite plugin, model calls, multiplayer, saves and voice.",
   "license": "MIT",
   "type": "module",

package/src/backend.js

@@ -7,7 +7,7 @@
 // past its cap. The page's URL says which room the tab joins and under
 // what name; on Dewdrop the game's page says which room, and the name is
 // the player's username.
-import { MAX_NET_CLIENTS, MAX_NET_CLIENT_FRAME_BYTES, createInbox, createOutbox, defineHandlers, label, side, unpack } from './net.js';
+import { DEFAULT_ROOM_PLAYERS, MAX_NET_CLIENTS, MAX_NET_CLIENT_FRAME_BYTES, createInbox, createOutbox, defineHandlers, label, side, unpack } from './net.js';
 import { NO_CHANNEL } from './route.js';
 
 let channel = null;
@@ -59,9 +59,9 @@ function name(text) {
 }
 
 // The players a room seats as `?players=` names them: a whole number from
-// 1 to MAX_NET_CLIENTS, or the most without one or with any other.
+// 1 to MAX_NET_CLIENTS, or DEFAULT_ROOM_PLAYERS without one or with any other.
 function players(text) {
-  return /^[0-9]{1,3}$/.test(text) && Number(text) >= 1 && Number(text) <= MAX_NET_CLIENTS ? Number(text) : MAX_NET_CLIENTS;
+  return /^[0-9]{1,3}$/.test(text) && Number(text) >= 1 && Number(text) <= MAX_NET_CLIENTS ? Number(text) : DEFAULT_ROOM_PLAYERS;
 }
 
 // Where a page's URL joins its tab: the room `?room=` names, the name
@@ -86,7 +86,7 @@ export function gameHasBackend() {
 // function at the next animation frame. Without a plugin there is no
 // channel, and `send` says so. A room that seats no more says so in the
 // console, as Dewdrop refuses the connect, and the tab's sends reach no one.
-export function attachBackend(hot, { channel: routed, hasBackend: present, frame: schedule, room = '', player = '', players = MAX_NET_CLIENTS }) {
+export function attachBackend(hot, { channel: routed, hasBackend: present, frame: schedule, room = '', player = '', players = DEFAULT_ROOM_PLAYERS }) {
   if (!routed) return;
   channel = hot;
   hasBackend = present;

package/src/index.js

@@ -5,8 +5,9 @@
 // runs, `clients`, in that backend, over its port back, and `saves` into
 // the browser's own storage, which the plugin's script empties as each
 // page loads; `session` says when a session ends ahead of time, which here
-// none does, and lets a game end its player's session, which here ends
-// nothing; and `voice` reads the microphone through the browser's own
+// none does, lets a game end its player's session, which here ends
+// nothing, and lets a game allow portrait views, which here the browser's
+// window already gives; and `voice` reads the microphone through the browser's own
 // audio worklet, into the chunks a game gets on Dewdrop.
 export { llm } from './llm.js';
 export { backend } from './backend.js';

package/src/net.js

@@ -18,6 +18,9 @@ export const MAX_NET_PLAYER_BYTES = 64;
 // The most players a room seats, and the most clients it holds: a room's
 // size is 1 to this.
 export const MAX_NET_CLIENTS = 100;
+// The players a room seats when its page names no size: the most a game's
+// room seats on Dewdrop until its developer says otherwise.
+export const DEFAULT_ROOM_PLAYERS = 8;
 // How often the local backend ticks: sixty times a second.
 export const NET_TICK_MS = 1000 / 60;
 

package/src/serve.js

@@ -17,7 +17,7 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { dirname, resolve } from 'node:path';
 import { Worker } from 'node:worker_threads';
-import { MAX_NET_CLIENTS, label } from './net.js';
+import { DEFAULT_ROOM_PLAYERS, MAX_NET_CLIENTS, label } from './net.js';
 
 // How long a room's backend runs on after its last tab's leave, as on
 // Dewdrop.
@@ -174,13 +174,13 @@ export function createBackendHost({ entry, ws, watcher, origin = () => '', log =
     // A tab joins the room its page named under the name it gave, a room
     // it makes seating the players its page said; a page that named
     // neither joins the empty room unnamed, and one that named no size a
-    // room seating the most.
-    join(client, { room = '', player = '', players = MAX_NET_CLIENTS } = {}) {
+    // room seating DEFAULT_ROOM_PLAYERS, as a game's rooms on Dewdrop do.
+    join(client, { room = '', player = '', players = DEFAULT_ROOM_PLAYERS } = {}) {
       if (tabs.has(client)) return;
       const key = typeof room === 'string' ? room : '';
       let it = rooms.get(key);
       if (it === undefined) {
-        const capacity = Number.isInteger(players) && players >= 1 && players <= MAX_NET_CLIENTS ? players : MAX_NET_CLIENTS;
+        const capacity = Number.isInteger(players) && players >= 1 && players <= MAX_NET_CLIENTS ? players : DEFAULT_ROOM_PLAYERS;
         it = createRoom(key, capacity);
         rooms.set(key, it);
       }

package/src/session.js

@@ -12,12 +12,21 @@
 // `session.exit()`, which on Dewdrop takes the player back to Dewdrop's
 // home page while the room's other players play on, the game hearing
 // `'exit'` as it goes; a backend has no player to send anywhere, so there it
-// throws NotSupportedError. `npm run dev` ends no session, so here `ending`
-// stays null and the event never fires, a game trying its handler by
-// calling it, and `exit()` ends nothing: the console says so, once.
+// throws NotSupportedError. A game that lays itself out for either shape
+// calls `session.allowPortrait()`, after which Dewdrop turns its view
+// portrait whenever its player's page asks — a phone held upright — and the
+// game hears each turn as a `resize`, its window taking the view's new
+// shape; until then a session stays landscape, and a backend, which has no
+// view, throws NotSupportedError. `npm run dev` ends no session, so here
+// `ending` stays null and the event never fires, a game trying its handler
+// by calling it, and `exit()` ends nothing: the console says so, once. The
+// game here is the browser's own window, which already takes any shape and
+// fires its own `resize`, so `allowPortrait()` changes nothing and says
+// what it does on Dewdrop, once.
 import { defineHandlers, side } from './net.js';
 
 let told = false;
+let toldPortrait = false;
 class Session extends EventTarget {
   get ending() { return null; }
   exit() {
@@ -26,6 +35,12 @@ class Session extends EventTarget {
     told = true;
     console.info('[dewdrop] session.exit(): on Dewdrop this ends the session and takes the player back to Dewdrop’s home page; npm run dev keeps the game running');
   }
+  allowPortrait() {
+    if (side.backend) throw new DOMException('session.allowPortrait is unavailable in a backend', 'NotSupportedError');
+    if (toldPortrait) return;
+    toldPortrait = true;
+    console.info('[dewdrop] session.allowPortrait(): on Dewdrop the view turns portrait whenever the player’s page is taller than wide, each turn a resize; npm run dev’s window already takes any shape');
+  }
 }
 defineHandlers(Session.prototype, ['ending']);