Goby is a Ruby framework for developing text-RPGs. Popular examples of such games are Zork and Colossal Cave Adventure. Our purpose is to provide the engine and underlying logic so the user can focus on the fun part: content creation!
Play our (short) example game:
ruby lib/main.rb
Remove the example game (which leaves only the framework):
bash scripts/clear_preset.sh
We use YARD for documentation. In order to see the doc files, first ensure that YARD is installed:
gem install yard
Then run the following command in our project's root directory:
yardoc
The doc files will then be available as HTML files in the doc/ directory.
First, ensure that all tests are passing:
rspec
If so, then submit a pull request. Thanks!