Skip to content

Fryguy/allegro4r

Repository files navigation

     ______   ___    ___                               __ __
    /\  _  \ /\_ \  /\_ \                             /\ \\ \
    \ \ \L\ \\//\ \ \//\ \      __     __   _ __   ___\ \ \\ \    _ __
     \ \  __ \ \ \ \  \ \ \   /'__`\ /'_ `\/\`'__\/ __`\ \ \\ \_ /\`'__\
      \ \ \/\ \ \_\ \_ \_\ \_/\  __//\ \L\ \ \ \//\ \L\ \ \__ ,__\ \ \/
       \ \_\ \_\/\____\/\____\ \____\ \____ \ \_\\ \____/\/_/\_\_/\ \_\
        \/_/\/_/\/____/\/____/\/____/\/___L\ \/_/ \/___/    \/_/   \/_/
                                       /\____/
                                       \_/__/

Allegro4r

A Ruby FFI binding to the Allegro game programming library.

Installation

Add this line to your application's Gemfile:

gem 'allegro4r'

And then execute:

$ bundle

Or install it yourself as:

$ gem install allegro4r

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Fryguy/allegro4r.

License

The gem is available as open source under the terms of the MIT License. See LICENSE.txt.

Third Party Licenses

The files in examples/data are borrowed from the Allegro source in order to allow the Ruby examples to serve as a mirror of the original examples. As such, the Allegro license is also included in LICENSE_ALLEGRO.txt.