https://github.com/nskins/goby

Command-line role-playing game framework
https://github.com/nskins/goby

cli command-line framework game-development gamedev rpg ruby text-rpg

Last synced: 9 days ago
JSON representation

Command-line role-playing game framework

• Host: GitHub
• URL: https://github.com/nskins/goby
• Owner: nskins
• License: mit
• Created: 2016-08-18T02:57:04.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-02-02T20:02:34.000Z (almost 3 years ago)
• Last Synced: 2024-10-02T02:24:39.068Z (about 1 month ago)
• Topics: cli, command-line, framework, game-development, gamedev, rpg, ruby, text-rpg
• Language: Ruby
• Homepage:
• Size: 542 KB
• Stars: 122
• Watchers: 17
• Forks: 56
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-for-beginners - Goby - RPGs. (Ruby)
• awesome-for-beginners - Goby - RPGs. (Ruby)
• awesome-for-beginners - Goby - RPGs. (Ruby)
• fucking-awesome-for-beginners - Goby - RPGs. (Ruby)

README

        
# Goby [![Build Status](https://travis-ci.org/nskins/goby.png)](https://travis-ci.org/nskins/goby) [![Coverage Status](https://coveralls.io/repos/github/nskins/goby/badge.svg?branch=master)](https://coveralls.io/github/nskins/goby?branch=master)

Goby is a Ruby framework for creating [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) [role-playing games](https://en.wikipedia.org/wiki/Role-playing_video_game). Goby comes with out-of-the-box support for 2D map development, background music, monster battles, customizable items & map events, stats, equipment, and so much more. With thorough testing and documentation, it's even easy to expand upon the framework for special, unique features. If you are looking to create the next classic command-line RPG, then look no further!

Goby will always be free and open source software. If you have any questions, please contact [email protected].

## Example Games

Interested to see what you can do with Goby? Look no further!

- [Ayara](https://github.com/nskins/ayara): an exploration-based RPG that takes place in a city.

- [Ostrichland](https://github.com/gintavang/Ostrichland): the precursor to the Goby framework!

## Getting Started

In order to start using Goby in your application, follow these instructions:

Add this line to your application's Gemfile:

```ruby

gem 'goby'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install goby

## Contributing

Thank you for your interest in contributing! Please read our [guidelines](https://github.com/nskins/goby/blob/master/CONTRIBUTING.md) before sending a pull request.

## Documentation

We use [YARD](https://github.com/lsegal/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