How to run it in 2023

[JaimeObregon]

This repo seems unmantained and won't run on a modern setup:

$ node -v
v17.2.0
$ yarn -v
1.22.15
$ git clone https://github.com/mikedotJS/adventurejs.git
Cloning into 'adventurejs'...
remote: Enumerating objects: 271, done.
remote: Total 271 (delta 0), reused 0 (delta 0), pack-reused 271
Receiving objects: 100% (271/271), 1.05 MiB | 872.00 KiB/s, done.
Resolving deltas: 100% (108/108), done.
$ cd adventurejs
$ yarn
yarn install v1.22.15
[1/4] 🔍  Resolving packages...
[2/4] 🚚  Fetching packages...
[3/4] 🔗  Linking dependencies...
[4/4] 🔨  Building fresh packages...
[1/4] ⠠ fsevents
[-/4] ⠠ waiting...
[3/4] ⠠ deasync
error /private/tmp/adventurejs/node_modules/deasync: Command failed.
[…]

Packages deasync and fsevents won't install. The latter points to https://fsevents-binaries.s3-us-west-2.amazonaws.com/v1.2.4/fse-v1.2.4-node-v102-darwin-x64.tar.gz — which is broken.

[JaimeObregon]

For anyone interested, I managed to run it by specifying exact versions of the dependencies:

diff --git a/package.json b/package.json
index 101ca7e..907b645 100644
--- a/package.json
+++ b/package.json
@@ -21,16 +21,16 @@
   },
   "homepage": "https://github.com/mikedotJS/adventurejs#readme",
   "devDependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-plugin-transform-class-properties": "^6.24.1",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-plugin-transform-runtime": "^6.23.0",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-flow": "^6.23.0",
-    "flow-bin": "^0.80.0",
+    "babel-cli": "6.26.0",
+    "babel-plugin-transform-class-properties": "6.24.1",
+    "babel-plugin-transform-object-rest-spread": "6.26.0",
+    "babel-plugin-transform-runtime": "6.23.0",
+    "babel-preset-env": "1.7.0",
+    "babel-preset-flow": "6.23.0",
+    "flow-bin": "0.80.0",
     "husky": "next",
-    "lint-staged": "^7.2.2",
-    "parcel-bundler": "^1.9.7",
+    "lint-staged": "7.2.2",
+    "parcel-bundler": "1.9.7",
     "prettier": "1.14.2"
   }
 }

I then removed the lockfile, installed Node.js version 16, and installed all dependencies:

rm yarn.lock
nvm install 16
yarn install

I considered submitting a pull request to update the README.md instructions, but previous pull requests appear to remain unmerged.

After that a local server spins up and I can navigate to localhost:1234. But there I only see a static <canvas> element (as shown in the attached image). The browser console shows no error. Unfortunately, there's no interactivity, instructions, or documentation available.

[JaimeObregon]

The trick is to press F3. Doing so brings up a layer displaying debug information in the top-left corner of the screen, which includes some instructions, as depicted here:

However, it's still unclear whether I'm missing something or which features are fully implemented. For instance, I'm not sure how to make the characters walk, if that feature is even available.

I hope this information is helpful to others.