xxscreeps-mod-client 0.2.19 → 0.3.0

package/README.md

@@ -35,6 +35,10 @@ SCREEPS_MOD_CLIENT_MOUNT_PATH=/play npx xxscreeps start
 
 The mod resolves the client bundle from its [`screeps-client`](../screeps-client) dependency at runtime — no separate build step is needed. The shipped bundle is built with `base=./`, but the client resolves some assets (e.g. the sprite atlas under `themes/`) against the server root `/`. Mounting anywhere other than `/` therefore breaks those asset URLs and requires a custom build of `screeps-client` with a matching base — which is why the mount path defaults to `/`.
 
+## Login UI feature detection
+
+The mod reads `backend.allowGuestAccess`, `backend.allowEmailRegistration`, and `backend.steamApiKey` from `.screepsrc.yaml` and publishes them at `/api/version` as an `xxscreeps-mod-client` feature. `screeps-client` reads this to show or hide the Guest button, the "Create account" link, and the "Login with Steam" button to match what the server actually allows.
+
 ## xxscreeps mode
 
 The client bundle shipped with this mod is built with `VITE_XXSCREEPS=true`. In this mode the client auto-connects to its own origin as a guest (read-only) on first load, mirroring `@xxscreeps/client`'s default UX. A "Connect as Guest" button stays available in the login form so users can return to guest mode after signing out.

package/backend.js

@@ -2,6 +2,7 @@ import path from 'node:path'
 import { createRequire } from 'node:module'
 import { createReadStream, existsSync, readFileSync, statSync } from 'node:fs'
 import { hooks } from 'xxscreeps/backend/index.js'
+import { config } from 'xxscreeps/config/index.js'
 
 const require = createRequire(import.meta.url)
 const pkg = require('./package.json')
@@ -107,6 +108,21 @@ function sendInjectedIndex(ctx) {
   ctx.body = renderInjectedIndex(indexFile)
 }
 
+// Advertise the server's guest/registration/Steam settings at `/api/version` so
+// screeps-client can gate the corresponding login UI without extra requests.
+// See `.screepsrc.yaml`'s `backend.allowGuestAccess`, `backend.allowEmailRegistration`,
+// and `backend.steamApiKey`.
+hooks.register('version', serverData => {
+  const backend = config.backend ?? {}
+  serverData.features.push({
+    name: 'xxscreeps-mod-client',
+    version: 1,
+    allowGuestAccess: backend.allowGuestAccess ?? true,
+    allowEmailRegistration: backend.allowEmailRegistration ?? false,
+    steamLogin: Boolean(backend.steamApiKey),
+  })
+})
+
 hooks.register('middleware', koa => {
   if (!existsSync(indexFile)) {
     console.error(`[xxscreeps-mod-client] client bundle not found at ${indexFile}. Run "pnpm --filter screeps-client build:embedded:xxscreeps" first.`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xxscreeps-mod-client",
-  "version": "0.2.19",
+  "version": "0.3.0",
   "description": "xxscreeps mod that serves the screeps-client and connects it to the same server.",
   "type": "module",
   "xxscreeps": true,
@@ -23,7 +23,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "screeps-client": "^0.13.1"
+    "screeps-client": "^0.14.0"
   },
   "peerDependencies": {
     "xxscreeps": "*"