Note: This readme describes how to develop the Vorple library itself. If you're interested in developing games using Vorple, see the documentation at vorple-if.com instead.
Setting up the development environment
These instructions assume a Unix environment (Linux or macOS). Setting up the environment on a Windows machine should follow similar steps.
The entire Vorple system is comprised of several parts:
- A Glulx engine Quixe that runs the Inform game files
- A custom web interpreter Haven that handles displaying the game output and getting input from the player
- Inform 6 and Inform 7 extensions that allow game authors to use Vorple from within Inform
The project includes webpack-dev-server that re-runs the build step automatically whenever Vorple or Haven sources change and creates a local server that lets you run the development version directly on the computer.
To set up the development environment:
- Install Node.js
- Install the rest of the packages with
npm install. npm should come with the Node.js installation.
npm installto install packages
Now you can do
npm start to start the development server at http://localhost:9000. The server restarts automatically when changes are made to source files.
The development server exposes files from the
library directory. For example, if you place
zork.ulx in this directory you can play it from the address
http://localhost:9000/?story=zork.ulx when the server is running.
You can also substitute npm with Yarn (recommended).
Building release versions
npm run build script compiles the Vorple and Haven source code and copies everything into a
dist directory. It also creates the files in the
lib directory that are needed in the npm distribution package.
To run the tests:
npm installpackages if you haven't already. This will download and install required test software.
npm start:testto start the development server (keep it running while the tests run)
- In another window run
npm testto start the tests
You should now see a bunch of browser windows pop up, load Vorple, and close soon after. The terminal where you ran
npm test should show whether the tests pass or fail.
npm test runs the tests using Firefox,
npm test:chrome uses Chrome,
npm test:safari uses Safari and
npm test:all runs tests once with all browsers. To run tests in Safari, you need to enable WebDriver support as per these instructions.
There are two separate story files for the Inform 6 and Inform 7 libraries. The Inform 7 tests file is used by default. The environment variable
INFORM_VERSION defines which file to use, e.g.
INFORM_VERSION=6 npm test:chrome tests the Inform 6 story file using Chrome.
Hint: running the entire test set might take some time, so if you're working on only one feature you can temporarily skip other tests by changing
'./tests/specs/**/*.js' near the start of the wdio.conf.js file to point to a specific test file.