Skip to content

BorgVM/BorgVM

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

BorgVM: A 2D game interpreter

  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.

  1. 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.

2.1. Which games does BorgVM support?

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

  1. Running Z-machine games

3.1. Required files

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

3.2. Running the game

  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.

4.1. Location of configuration file

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

Operating System Location
Windows Vista/7/8 \Users\username\AppData\Roaming\BorgVM\BorgVM.ini
Windows 2000/XP \Documents and Settings\username\Application Data\BorgVM\BorgVM.ini
Unix ~/.BorgVMrc
Mac OS X ~/Library/Preferences/BorgVM Preferences
Others BorgVM.ini in the current directory
  1. Troubleshooting, Known Bugs, Issues

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

  1. Debugging

Hitting Ctrl-D will bring up the debug menu.

  1. Bug Reports

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

7.1. How, and where do I report bugs?

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.
  1. Contact

About

The project for engines using the ScummVM architecture that don't meet the guidelines for inclusion in ScummVM or ResidualVM.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published