https://github.com/curiousdannii/ifvms.js

The Interactive Fiction Virtual Machines Suite - in Javascript
https://github.com/curiousdannii/ifvms.js

emulator interactive-fiction z-machine

Last synced: 8 days ago
JSON representation

The Interactive Fiction Virtual Machines Suite - in Javascript

• Host: GitHub
• URL: https://github.com/curiousdannii/ifvms.js
• Owner: curiousdannii
• License: mit
• Created: 2011-03-25T09:29:44.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2023-12-24T02:11:03.000Z (11 months ago)
• Last Synced: 2024-04-24T13:16:38.951Z (7 months ago)
• Topics: emulator, interactive-fiction, z-machine
• Language: JavaScript
• Homepage:
• Size: 725 KB
• Stars: 90
• Watchers: 10
• Forks: 22
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ifvms.js

========

ifvms.js, the Javascript Interactive Fiction Virtual Machines project is a new set of third generation VM engines for web IF interpreters. Like the second generation VMs Gnusto and Quixe, the ifvms.js VMs include a Just-In-Time disassembler/compiler. What justifies the third generation label is that the disassembler generates an Abstract Syntax Tree, allowing Inform idioms, for example for and while loops, to be identified and mapped to Javascript control structures (currently not enabled). Identifying these idioms allows the JIT code to run for longer, lowering overheads and therefore increasing performance.

Currently only the Z-Machine is supported, but plans to support Glulx and possibly TADS are in the works.

ifvms.js is MIT licenced, but please help the community by sharing any changes you make with us.

Playing stories with ifvms.js

-----------------------------

ifvms.js is used by [Parchment](https://github.com/curiousdannii/parchment). To play a story with Parchment go to [iplayif.com](https://iplayif.com).

ifvms.js is also included in the desktop interpreter [Lectrote](https://github.com/erkyrath/lectrote).

A minimalistic terminal interpreter is also available. If you install the ifvms npm package globally then the `zvm` script will be added to your path:

```

npm install -g ifvms

zvm story.z5

zvm story.zblorb

```

Testing ifvms.js

----------------

Simply running `make` is enough to run the test suite.