@lamppost/create-ink-player 1.0.8 → 1.0.9

package/index.js

@@ -4,8 +4,8 @@ import {
     cpSync,
     existsSync,
     mkdirSync,
-    renameSync,
     readFileSync,
+    renameSync,
     rmSync,
     writeFileSync,
 } from "node:fs";
@@ -18,11 +18,13 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
 async function main() {
+    const incomingName = process.argv[2];
+
     // Ask for the directory name
     const rl = readline.createInterface({ input, output });
 
-    let directoryName = "";
-    while (true) {
+    let directoryName = incomingName || "";
+    while (directoryName.length === 0) {
         const answer = await rl.question(
             "What directory name would you like to use? ",
         );
@@ -54,8 +56,8 @@ async function main() {
     }
 
     // Ask for the game name
-    let gameName = "";
-    while (true) {
+    let gameName = incomingName || "";
+    while (gameName.length === 0) {
         const answer = await rl.question("What is the name of your game? ");
         const trimmed = answer.trim();
 
@@ -92,7 +94,7 @@ async function main() {
     // Update package.json
     const packageJsonPath = join(targetDir, "package.json");
     const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
-    packageJson.name = gameName;
+    packageJson.name = directoryName;
     writeFileSync(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`);
 
     // Update the gameName in the src/index.ts file
@@ -111,6 +113,19 @@ async function main() {
     );
     writeFileSync(readmeMdPath, readmeMd);
 
+    if (incomingName) {
+        console.log("Skipping installation and update of ink-player...");
+        console.log(`\nTo get started:`);
+        console.log(`  cd ${directoryName}`);
+        console.log(`  pnpm install`);
+        console.log(`  pnpm update-ink-player`);
+        console.log(`  pnpm dev`);
+        console.log(
+            `\nThis will start the development server and open the game in your browser. You can now start working on your game.`,
+        );
+        process.exit(0);
+    }
+
     console.log("Installing dependencies...");
 
     // Run pnpm install

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lamppost/create-ink-player",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "publishConfig": {
     "access": "public"
   },

package/template/README.md

@@ -10,6 +10,7 @@ This is a web player for running [Ink](https://github.com/inkle/ink) stories cre
 * Update the About page in `src/About.tsx` to include some information about your game (or remove that page entirely by updating `src/index.ts`).
 * Add any custom CSS styling inside the `src/styles.scss` file.
 * Run `pnpm build` to create the final HTML/JS/CSS/Image files needed to display the game. The files will be output to the `dist/` directory. You can then bundle them or upload them to the location of your choice.
+* To update your game to the latest version of the ink player you can run `pnpm update-ink-player`.
 
 ## Next Steps
 

package/template/src/index.ts

@@ -1,8 +1,8 @@
 import { init } from "@lamppost/ink-player";
+import darkModePlugin from "@lamppost/ink-player/plugins/dark-mode";
+import historyPlugin from "@lamppost/ink-player/plugins/history";
 import locationPlugin from "@lamppost/ink-player/plugins/location";
 import textInputPlugin from "@lamppost/ink-player/plugins/text-input";
-import historyPlugin from "@lamppost/ink-player/plugins/history";
-import darkModePlugin from "@lamppost/ink-player/plugins/dark-mode";
 
 import "@lamppost/ink-player/styles.css";
 import "./styles.scss";