@lamppost/create-ink-player 1.0.3 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lamppost/create-ink-player",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "publishConfig": {
     "access": "public"
   },
@@ -18,6 +18,7 @@
     "interactive fiction",
     "game"
   ],
+  "type": "module",
   "main": "./index.js",
   "bin": {
     "create-ink-player": "./index.js"
@@ -29,5 +30,9 @@
     "README.md",
     "LICENSE"
   ],
-  "dependencies": {}
+  "dependencies": {},
+  "scripts": {
+    "update-template": "./update-template.js",
+    "changeset": "pnpm -w changeset"
+  }
 }

package/template/README.md

@@ -7,7 +7,7 @@ This is a web player for running [Ink](https://github.com/inkle/ink) stories cre
 * Run `pnpm dev` to see the result in your browser and confirm that things are running correctly.
 * Open up `story/game.ink` in the Inky editor and make modifications, go back to your game in the browser and see your changes live!
 * Update the settings in `src/index.tsx` to use your game name and update any other settings.
-* Update the About page in `src/About.tsx` to include some information about your game (or remove that screen entirely by updating `src/index.ts`).
+* 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.
 

package/template/package.json

@@ -9,7 +9,7 @@
         "preview": "rsbuild preview"
     },
     "dependencies": {
-        "@lamppost/ink-player": "^1.0.4",
+        "@lamppost/ink-player": "^2.0.2",
         "preact": "^10.27.1",
         "react-bootstrap": "^2.10.10"
     },

package/template/pnpm-lock.yaml

@@ -14,8 +14,8 @@ importers:
   .:
     dependencies:
       '@lamppost/ink-player':
-        specifier: ^1.0.4
-        version: 1.0.4(@popperjs/core@2.11.8)(@types/react@19.2.9)(react-dom@19.2.3(react@19.0.0-rc-fb9a90fa48-20240614))(react@19.0.0-rc-fb9a90fa48-20240614)
+        specifier: ^2.0.2
+        version: 2.0.2(@popperjs/core@2.11.8)(@types/react@19.2.9)(react-dom@19.2.3(react@19.0.0-rc-fb9a90fa48-20240614))(react@19.0.0-rc-fb9a90fa48-20240614)
       preact:
         specifier: ^10.27.1
         version: 10.28.2
@@ -143,8 +143,8 @@ packages:
   '@jridgewell/trace-mapping@0.3.31':
     resolution: {integrity: sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==}
 
-  '@lamppost/ink-player@1.0.4':
-    resolution: {integrity: sha512-ASlSBjFIIjHFOffEbuOAmOxw4XJU7QdcY6NgThZiDXTCO8D00S45jaaAHRBwQ84eEn9VnQxZTixlkTCvy9nRCw==}
+  '@lamppost/ink-player@2.0.2':
+    resolution: {integrity: sha512-vCCRD83uzsWIUfHwLZJkqoL7i7W9t4i/hlmNiixsBFocIfkxrq/Nt3vF6RYnDCICV8ZQ3XVjOd4u2Ptd80OJpg==}
 
   '@module-federation/error-codes@0.22.0':
     resolution: {integrity: sha512-xF9SjnEy7vTdx+xekjPCV5cIHOGCkdn3pIxo9vU7gEZMIw0SvAEdsy6Uh17xaCpm8V0FWvR0SZoK9Ik6jGOaug==}
@@ -1312,7 +1312,7 @@ snapshots:
       '@jridgewell/resolve-uri': 3.1.2
       '@jridgewell/sourcemap-codec': 1.5.5
 
-  '@lamppost/ink-player@1.0.4(@popperjs/core@2.11.8)(@types/react@19.2.9)(react-dom@19.2.3(react@19.0.0-rc-fb9a90fa48-20240614))(react@19.0.0-rc-fb9a90fa48-20240614)':
+  '@lamppost/ink-player@2.0.2(@popperjs/core@2.11.8)(@types/react@19.2.9)(react-dom@19.2.3(react@19.0.0-rc-fb9a90fa48-20240614))(react@19.0.0-rc-fb9a90fa48-20240614)':
     dependencies:
       bootstrap: 5.3.8(@popperjs/core@2.11.8)
       bootstrap-icons: 1.13.1

package/template/src/About.tsx

@@ -1,16 +1,16 @@
-import type { ScreenProps } from "@lamppost/ink-player";
+import type { PageProps } from "@lamppost/ink-player";
 import Button from "react-bootstrap/Button";
 import Card from "react-bootstrap/Card";
 import Spinner from "react-bootstrap/Spinner";
 
 /**
  * The component is provided with the following props:
- * - setPage: A function to navigate to a different screen
+ * - setPage: A function to navigate to a different page
  * - loading: A boolean indicating if the game is loading
  *
- * Use setPage("game") to navigate to the game screen.
+ * Use setPage("game") to navigate to the game page.
  */
-export function About({ setPage, loading }: ScreenProps) {
+export function About({ setPage, loading }: PageProps) {
     return (
         <Card>
             {/*

package/template/src/index.ts

@@ -1,6 +1,8 @@
 import { init } from "@lamppost/ink-player";
 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";
@@ -27,14 +29,6 @@ init({
      */
     // shortGameName: "LampPost Player",
 
-    /**
-     * Whether to enable dark mode. If not provided, dark mode will not be
-     * enabled. If enabled, it will turn on the toggle in the header,
-     * load the user's preference from their computer, and store the result
-     * in the browser's local storage.
-     */
-    // enableDarkMode: false,
-
     /**
      * The default theme to use. If not provided, the default theme will be
      * "light".
@@ -67,9 +61,9 @@ init({
     // stickyTags: ["Portrait", "Location", "BackgroundMusic"],
 
     /**
-     * The screens to display in the game. The only required screen is "Game".
+     * The pages to display in the game. The only required page is "Game".
      */
-    screens: [
+    pages: [
         {
             id: "home",
             title: "Home",
@@ -78,12 +72,12 @@ init({
         {
             id: "game",
             title: "Story",
-            component: "Game",
+            component: "game",
         },
         {
             id: "history",
             title: "History",
-            component: "History",
+            component: "history",
         },
     ],
 
@@ -96,5 +90,10 @@ init({
      *   import locationPlugin from "@lamppost/ink-player/plugins/location";
      *   plugins: [textInputPlugin({}), locationPlugin({})],
      */
-    plugins: [textInputPlugin({}), locationPlugin({})],
+    plugins: [
+        textInputPlugin({}),
+        locationPlugin({}),
+        historyPlugin({}),
+        darkModePlugin({}),
+    ],
 });