pablofullana / goby

Ruby framework for creating text RPGs.

Goby

Goby is a Ruby framework for creating text RPGs. In the past 30+ years, the fine and respectable craft of text RPG development has been forgotten in favor of flashing lights and CGI cutscenes; however, there was once a time when the video game experience meant more than Dynamic Super Resolution™.

Text RPG development is a relatively fast and simple process. That's why our mission is to provide the highest degree of functionality, utilizing object-oriented design principles, so that users spend the majority of their time on the fun part of video game development: content creation!

Getting Started

Tutorials and examples are coming soon. Complete documentation is available. In order to start using Goby in your application, follow these instructions:

Add this line to your application's Gemfile:

gem 'goby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install goby

Contributing

Thank you for your interest in contributing! Please read our guidelines before sending a pull request.

Documentation

We use YARD for documentation. In order to generate the documentation (which will be stored in the doc/ directory), run the following command in the project's root directory:

yardoc