gemwright 0.1.3 → 0.1.5

package/README.md

@@ -1,4 +1,4 @@
-# <img src=".github/small-forge.png" align="left" alt="Forge your own shard" width="50" height="50" /> Gemwright — Forge your own shard
+# <img src="https://cdn.jsdelivr.net/npm/gemwright@latest/.github/small-forge.png" align="left" alt="Forge your own shard" width="50" height="50" /> Gemwright — Forge your own shard
 
 ## Motivation
 
@@ -45,6 +45,12 @@ gemwright deploy
 gemwright deploy --files /path/to/game-files
 ```
 
+### Next steps
+
+- Push your shard configuration and scripts to a private Git repository to track changes.
+- Set up a custom login hostname, such as `login.yourshard.com`. Create a DNS CNAME pointing to your Railway TCP proxy hostname.
+- Keep separate copies of your saves and accounts outside Railway. (Railway's built-in volume backups require the Pro plan)
+
 ## Development
 
 - [x] `init` to initialize shard with a few answers

package/dist/index.js

@@ -8,12 +8,12 @@ import chalk from "chalk";
 
 // src/deploy.ts
 import { randomUUID } from "node:crypto";
-import { mkdir as mkdir3, readFile as readFile6, rename, writeFile as writeFile3 } from "node:fs/promises";
+import { mkdir as mkdir3, readFile as readFile6, rename, writeFile as writeFile4 } from "node:fs/promises";
 import { join as join7, resolve as resolve2 } from "node:path";
 import { setTimeout as sleep } from "node:timers/promises";
 
 // src/emulators/servuo/staging.ts
-import { cp, mkdir, readFile as readFile2, rm as rm2, stat } from "node:fs/promises";
+import { cp, mkdir, readFile as readFile2, rm as rm2, stat, writeFile as writeFile2 } from "node:fs/promises";
 import { join as join3 } from "node:path";
 
 // src/assets.ts
@@ -181,7 +181,21 @@ function prepareServuoFiles(upstream, config, settings, password) {
     files["Config/General.cfg"] = setConfigValue(files["Config/General.cfg"] ?? "", "SupportWebsite", config.url);
   files["Config/Server.cfg"] = setConfigValue(files["Config/Server.cfg"], "Name", config.name);
   files["Config/Expansion.cfg"] = setConfigValue(files["Config/Expansion.cfg"], "CurrentExpansion", expansionNames[config.expansion]);
-  files["Config/DataPath.cfg"] = setConfigValue(files["Config/DataPath.cfg"], "CustomPath", "data/client");
+  files["Config/DataPath.cfg"] = setConfigValue(files["Config/DataPath.cfg"], "CustomPath", settings.clientFiles ?? "data/client");
+  if (settings.accountsPerIp !== undefined) {
+    if (!Number.isInteger(settings.accountsPerIp) || settings.accountsPerIp < 0 || settings.accountsPerIp > 2147483647)
+      throw new Error("Accounts per IP must be a whole number between 0 and 2147483647.");
+    files["Config/Accounts.cfg"] = setConfigValue(files["Config/Accounts.cfg"], "AccountsPerIp", String(settings.accountsPerIp));
+  }
+  if (settings.globalChat !== undefined)
+    files["Config/Chat.cfg"] = setConfigValue(files["Config/Chat.cfg"] ?? "", "Enabled", String(settings.globalChat));
+  if (settings.allowedClients !== undefined) {
+    const keys = ["AllowRegular", "AllowUOTD", "AllowGod", "AllowEC"];
+    if (!settings.allowedClients.length || settings.allowedClients.some((key) => !keys.includes(key)))
+      throw new Error("Choose at least one supported client.");
+    for (const key of keys)
+      files["Config/Client.cfg"] = setConfigValue(files["Config/Client.cfg"] ?? "", key, String(settings.allowedClients.includes(key)));
+  }
   files["Config/Accounts.cfg"] = setConfigValue(files["Config/Accounts.cfg"], "AutoCreateAccounts", settings.autoCreateAccounts ? "True" : "False");
   const protection = configValue(files["Config/Accounts.cfg"], "ProtectPasswords");
   const hashes = {
@@ -273,7 +287,7 @@ async function validateServuoShard(directory, config) {
     throw new Error("Railway deployment currently requires Server.cfg Listen=0.0.0.0 and Port=2593. Config was not changed.");
   }
   const data = await readFile2(join3(directory, "Config/DataPath.cfg"), "utf8");
-  if (configValue(data, "CustomPath") !== "data/client")
+  if (configValue(data, "CustomPath") !== "data/client" && configValue(data, "CustomPath") !== config.servuo?.clientFiles)
     throw new Error("Deployment currently supports DataPath.cfg CustomPath=data/client. Config was not changed.");
   const restart = await readFile2(join3(directory, "Config/AutoRestart.cfg"), "utf8").catch(() => "Enabled=False");
   if (configValue(restart, "Enabled")?.toLowerCase() === "true") {
@@ -292,6 +306,8 @@ async function stageServuo(directory, config) {
   await rm2(join3(server, ".git"), { recursive: true, force: true });
   await rm2(join3(server, "Config"), { recursive: true, force: true });
   await cp(join3(directory, "Config"), join3(server, "Config"), { recursive: true });
+  const dataPath = join3(server, "Config/DataPath.cfg");
+  await writeFile2(dataPath, setConfigValue(await readFile2(dataPath, "utf8"), "CustomPath", "data/client"));
   for (const folder of ["Scripts", "Data"]) {
     if ((await stat(join3(directory, folder)).catch(() => {
       return;
@@ -322,7 +338,7 @@ import { join as join5 } from "node:path";
 
 // src/emulators/sphere/config.ts
 import { createHash as createHash3 } from "node:crypto";
-import { mkdtemp as mkdtemp2, readdir as readdir3, readFile as readFile3, rm as rm3, writeFile as writeFile2 } from "node:fs/promises";
+import { mkdtemp as mkdtemp2, readdir as readdir3, readFile as readFile3, rm as rm3, writeFile as writeFile3 } from "node:fs/promises";
 import { tmpdir as tmpdir2 } from "node:os";
 import { join as join4 } from "node:path";
 
@@ -634,7 +650,7 @@ async function fetchSphereFiles(sources) {
       if (!response.ok)
         throw new Error(`Could not fetch Sphere ${repository}: HTTP ${response.status}`);
       const archive = join4(temporary, `${kind}.tar.gz`);
-      await writeFile2(archive, new Uint8Array(await response.arrayBuffer()));
+      await writeFile3(archive, new Uint8Array(await response.arrayBuffer()));
       await command(["tar", "-xzf", archive, "-C", temporary], temporary);
       return join4(temporary, `${repository}-${revision}`);
     }
@@ -961,7 +977,7 @@ async function loadShard(directory) {
 async function saveState(directory, state) {
   const path = join7(directory, ".gemwright/railway.json");
   await mkdir3(join7(directory, ".gemwright"), { recursive: true });
-  await writeFile3(`${path}.tmp`, JSON.stringify(state, null, 2) + `
+  await writeFile4(`${path}.tmp`, JSON.stringify(state, null, 2) + `
 `);
   await rename(`${path}.tmp`, path);
 }
@@ -1175,7 +1191,7 @@ async function deploy(options, directory = process.cwd()) {
 }
 
 // src/init.ts
-import { resolve as resolve5 } from "node:path";
+import { relative, resolve as resolve5 } from "node:path";
 import * as prompts5 from "@clack/prompts";
 
 // src/emulators/servuo/init.ts
@@ -1220,6 +1236,40 @@ async function initializeServuo(config, yes = false, loadConfig = fetchServuoCon
     message: "Allow players to create accounts on first login?",
     initialValue: registration.toLowerCase() === "true"
   }));
+  const accountDefault = configValue(upstream["Config/Accounts.cfg"] ?? "", "AccountsPerIp");
+  if (!accountDefault || !/^\d+$/.test(accountDefault) || Number(accountDefault) > 2147483647)
+    throw new Error("Upstream accounts per IP default is missing or invalid.");
+  const chatDefault = configValue(upstream["Config/Chat.cfg"] ?? "", "Enabled");
+  if (!chatDefault || !/^(true|false)$/i.test(chatDefault))
+    throw new Error("Upstream global chat default is missing or invalid.");
+  const clientOptions = [
+    { value: "AllowRegular", label: "Classic client" },
+    { value: "AllowUOTD", label: "Third Dawn client" },
+    { value: "AllowGod", label: "God client" },
+    { value: "AllowEC", label: "Enhanced client" }
+  ];
+  const clientDefaults = clientOptions.filter(({ value }) => {
+    const enabled = configValue(upstream["Config/Client.cfg"] ?? "", value);
+    if (!enabled || !/^(true|false)$/i.test(enabled))
+      throw new Error(`Upstream client default is missing or invalid: ${value}`);
+    return enabled.toLowerCase() === "true";
+  }).map(({ value }) => value);
+  const accountsPerIp = yes ? Number(accountDefault) : Number(answer(await prompts2.text({
+    message: "Accounts allowed per IP address",
+    defaultValue: accountDefault,
+    placeholder: accountDefault,
+    validate: (value) => value && (!/^\d+$/.test(value) || Number(value) > 2147483647) ? "Enter a whole number between 0 and 2147483647." : undefined
+  })));
+  const globalChat = yes ? chatDefault.toLowerCase() === "true" : answer(await prompts2.confirm({
+    message: "Enable global chat?",
+    initialValue: chatDefault.toLowerCase() === "true"
+  }));
+  const allowedClients = yes ? clientDefaults : answer(await prompts2.multiselect({
+    message: "Allowed clients",
+    options: clientOptions,
+    initialValues: clientDefaults,
+    required: true
+  }));
   const owner = yes ? "admin" : answer(await prompts2.text({
     message: "Owner username",
     placeholder: "admin",
@@ -1235,6 +1285,9 @@ async function initializeServuo(config, yes = false, loadConfig = fetchServuoCon
   const settings = {
     ...clientFiles ? { clientFiles: resolve3(clientFiles) } : {},
     autoCreateAccounts,
+    accountsPerIp,
+    globalChat,
+    allowedClients,
     owner
   };
   return { settings, files: prepareServuoFiles(upstream, config, settings, password2), generatedPassword };
@@ -1427,7 +1480,7 @@ async function initializeSphere(config, sources, yes = false, loadFiles = fetchS
 }
 
 // src/instance.ts
-import { appendFile, lstat, mkdir as mkdir4, readFile as readFile7, stat as stat5, writeFile as writeFile4 } from "node:fs/promises";
+import { appendFile, lstat, mkdir as mkdir4, readFile as readFile7, stat as stat5, writeFile as writeFile5 } from "node:fs/promises";
 import { dirname, isAbsolute, join as join8 } from "node:path";
 async function existingAncestor(directory) {
   try {
@@ -1517,7 +1570,7 @@ async function saveInstance(directory, config, initializeGit, files = {}) {
 `)}
 `);
     } else {
-      await writeFile4(join8(directory, filename), content, {
+      await writeFile5(join8(directory, filename), content, {
         flag: "wx",
         mode: ["Saves/Accounts/accounts.xml", "accounts/sphereaccu.scp"].includes(filename) ? 384 : 420
       });
@@ -1618,7 +1671,18 @@ async function initialize(options, resolveServuoSource = resolveLatestServuoSour
     prompts5.note(`Username: ${config.servuo?.owner ?? config.sphere?.owner}
 Password: ${generatedPassword}
 Save this password; it will not be shown again.`, "Owner account");
-  prompts5.outro(`Created ${configFilename} in ${directory}`);
+  const target = relative(process.cwd(), directory);
+  const commands = [];
+  if (target) {
+    const path = /^[\w./-]+$/.test(target) ? target : `'${target.replaceAll("'", "'\\''")}'`;
+    commands.push(`cd -- ${path}`);
+  }
+  commands.push("gemwright deploy");
+  prompts5.outro(`Created ${configFilename} in ${directory}
+
+Next steps:
+  ${commands.join(`
+  `)}`);
 }
 
 // src/index.ts

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "gemwright",
-  "description": "Forge your own shard.",
-  "version": "0.1.3",
+  "description": "Forge your own shard",
+  "version": "0.1.5",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gokaygurcan/gemwright.git"
@@ -13,7 +14,8 @@
   "files": [
     "dist/index.js",
     "templates/",
-    "patches/"
+    "patches/",
+    ".github/small-forge.png"
   ],
   "engines": {
     "node": ">=24"