Quest 5 - Documentation

Quest 5 is free, open source software for creating text adventure games. It is designed to be powerful, extensible and easy to learn. You can create games in any language - Quest currently has templates for English, French, German, Spanish, Dutch, Italian, Portuguese, Romanian, Esperanto, Russian and Icelandic.

You can use Quest in your web browser, or download a version for Windows (or start with the web, and if you like it, download the game you are working on, and finish it on the desktop version).

Contents

Tutorial

Other features

The User Experience

Advanced Topics

Reference

Contributing

Search

Tutorial

New to Quest? The tutorial will guide you through creating your first game, and is an excellent way to understand what Quest is about.

  1. Introduction
  2. Creating a simple game
  3. Interacting with objects
  4. Anatomy of a Quest game
  5. Using scripts
  6. Custom attributes
  7. Custom commands
  8. More things to do with objects
  9. Using containers
  10. Lockable containers
  11. Moving objects during the game
  12. Status attributes
  13. Using timers and turn scripts
  14. Releasing your game

Other features

Quest has a whole range of features built in and ready to use. You probably won’t be using them all, so just dip in as you need to.

The User Experience

Quest allows you to customise the user interface (UI) to suit the style and mood of your game.

Advanced Topics

A look at some of the more technical features of Quest. These articles assume you can at least copy-and-paste code.

Due to restrictions in the web editor, the following are only applicable to the desktop version.

Reference

Contributing

If you would like to help with developing Quest, please see the Developers page.

If you find a bug in Quest (as opposed to your own game), please log it on the Issue Tracker, or if there is a feature you would like included. We cannot guarantee all bugs and feature requests will be addressed, but they are more likely to be if reported here. Try to include as much detail as possible, includiong a same game that illustrates the issue if at all possible.

You can also discuss Quest at the forum. If you have an issue with your game, this is the place to go!

Quest is completely open source, including this documentation! The source code and documentation both live on GitHub (documentation is in the docs folder).