# AdventureRL
Point-N-Click adventure game framework, using real video recordings as animations.

## Installation
Add this line to your application's Gemfile:
```ruby
gem 'adventure_rl'
```
And then execute:
```
$ bundle
```
Or install it yourself as:
```
$ gem install adventure_rl
```

## Documentation
Documentation is being written and is available under the `doc/` directory  
in the project's root directory.

## Development
We have just started this project, so this gem is highly __Work In Progress__.  

While developing this framework, we are creating a [demo game][demo-url] with it.

## License
The gem is available as open source under the terms of the [MIT License][MIT-url].

[demo-url]: https://github.com/Noah2610/AdventureRL-Demo
[MIT-url]:  https://opensource.org/licenses/MIT