1. What is BorgVM?

2. Current state

3. Running Z-machine games

4. Configuration

5. Troubleshooting

6. Debugging

7. Bug Reports

8. Contact

9. What is BorgVM?

BorgVM is a game engine reimplementation using the ScummVM architecture
that allows you to play games that don't meet the requirements for
inclusion in ScummVM or ResidualVM, such as interactive fiction games.

2. Current state

At this point BorgVM is fit for normal use, when playing supported games. It is however worth noting that you should still save early, and save often, as problems or dead-ends might still exist.

Currently BorgVM supports interactive fiction games that use the Infocom
Z-machine. The Z-machine reimplementation in BorgVM is based on Frotz.

3. Running Z-machine games

To run Z-machine games, you will need to create a folder containing the original game files.

1. Prepare the game directory as specified above

2. Open BorgVM

3. Choose "Add Game"

4. Select the folder you created in Step 1

5. Click Start

6. Configuration

There are options to configure how your game is displayed, which can be selected from the GUI.

By default, the configuration file is saved in, and loaded from:

5. Troubleshooting, Known Bugs, Issues

Currently, there is no support for terminal style functions for interactive fiction games.

6. Debugging

Hitting Ctrl-D will bring up the debug menu.

7. Bug Reports

BorgVM still has a few bugs. If you find a new one, don't hesitate to report it.

You can report bugs at our github-issue-tracker: http://www.github.com/BorgVM/BorgVM/issues

Remember to always have the following information in your bug reports:

• Information about the game (Zork I, Zork Zero, ...)
• Language of game (English, German, ...)
• Platform and Compiler (Win32, Linux, Mac OS X, ...)
• Bug details, including instructions on reproducing it
• Preferably also a link to a save game right before the bug happened.

9. Contact

• Github: http://www.github.com/BorgVM/BorgVM