Regalia - Enhanced RAGS 2.x player for the browser

Background

What is RAGS?

RAGS, the 'Rapid adventure game system', is a set of tools to develop simple point and click games with text and images. There is a 'Rags Designer' used to create the games, and a 'Rags Player' to play them. Typically available only on Windows.

RAGS didn't seem to get a lot of traction as a vehicle for traditional "Interactive Fiction". It's mostly around these days for pornography.

What is Regalia?

Rags 2.x has a 'Save To Web Format(BETA)' option available in the designer that produces a HTML/CSS/JavaScript version of the game for usage in your web browser. Unfortunately, since that option is 'BETA', it will only work for the simplest of games, and the design is not so great.

This project is an attempt to fix that runner code, or at least fix it for games that anyone cares about.

Limitations

Exporting a game in the Rags 3.x designer creates a Silverlight thing instead of a plain JavaScript app. This cannot be used with regalia. A beta support for Rags 3.x games is possible when they are exported using rags2html though.

Just like the desktop Rags player, saves from one version of a game will not work on other versions. This is because Rags saves are just a copy of the entire game state, so if you load an old Rags save you're basically loading the old version of the game.

Features

Save/Load

• Saves use localStorage instead of deprecated browser storage APIs
• Saves are stored as deltas against the original game state, rather than full copies of the game state. So in some cases, the saves are ~100k instead of ~20mb.
• Saves can be exported to files, for backup or portability between browser sessions

Cheating

• Game variables can be inspected, changed, and frozen

Interface

• Navigation compass has much larger clickable regions
• Objects and Characters that are in the room with you but don't have any actions available are shown as grayed-out.

Fixes

• Many, many bugs in the original 'Save To Web Format(BETA)' code that would stop progress in games have been fixed. (Partially/incorrectly implemented commands, race conditions, memory leaks, etc...)

Compatibility

Regalia has been tested to some extent with the following games, though it's not clear if you can make it all the way to the end.

• The Apartments
• Evil, Inc
• Mindshift, part I
• The Sinner
• Wife Trainer

Installing Regalia

To play a Rags game in Regalia, first you need to export the game with the Rags designer, using the 'Save To Web Format(BETA)' option.

Before exporting, you will probably need to use the custom patched RagsLib.dll included on the Releases page for this project. Replace the RagsLib.dll that exists next to your RagsDesigner.exe in the Rags folder. Make a copy first, if you want.

If the game you want to open is password-protected, note that you can find versions of the Rags Designer on the internet with this password protection removed.

Next, you need to run the Regalia install script on your game:

• Ensure you have some version of Ruby installed - on Windows, try https://rubyinstaller.org/
• Ensure you have some version of NodeJS/NPM installed - https://nodejs.org/en/download/
• In the Regalia source directory, npm install
• In the Regalia source directory, ./bin/install /path/to/exported/game/dir

This will create a "(your game name) - regalia.html" file in that directory, as well as a "regalia" subdirectory with all the associated JavaScript and CSS.

To run the game, just open the "(your game name) - regalia.html" file in any browser. Tested mostly only in Chrome, your mileage may vary.

As an alternative, the rags2html project can be used to export any RAGS games into a ready-to-use regalia version.

Why is there a patched RagsLib.dll?

The export code in the original 'Save To Web Format(BETA)' feature does an okay job of exporting out all the game data to a JavaScript file, but doesn't correctly escape quotes in all fields. So if your game has double-quotes in certain places, it won't load. The patched RagsLib.dll fixes this in some places (but not all):

• Custom Choice Titles
• Timer Names
• Character Custom Properties

Problems

I don't know, file an issue, I guess. I don't have a lot of time to work on this project anymore, but maybe we can figure something out.

For Developers

Running Tests

Create or update a .env file in the project root directory, with the following vars populated:

GAMES_DIR=/some-directory-with-games-in-it

Then, run all the playthrough specs:

rspec spec

Or a specific playthrough spec:

rspec spec/playthroughs/the_apartments_spec.rb