Crystal binding to the Allegro game programming library.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
generator
spec
src
.editorconfig
.gitignore
.travis.yml
LICENSE
LICENSE_ALLEGRO
README.md
shard.yml

README.md

CrystalAllegro

CrystalAllegro is a Crystal binding to the Allegro game programming library.

Installation

  • Install Allegro

  • Install the Crystal shard

    Add this to your application's shard.yml:

    dependencies:
      crystal_allegro:
        github: Fryguy/crystal_allegro

Usage

Start your application by calling CrystalAllegro.init:

require "crystal_allegro"

raise "Cannot initialize Crystal" unless CrystalAllegro.init

After that, it's up to you! For the Allegro API reference, go here. See the examples directory for Crystal ports of the Allegro examples.

Development

src/crystal_allegro/lib_allegro.cr is generated using crystal_lib. To regenerate it:

git clone https://github.com/crystal-lang/crystal_lib.git
cd crystal_allegro
crystal ../crystal_lib/src/main.cr -- generator/lib_allegro.cr > src/crystal_allegro/lib_allegro.cr

Contributing

  1. Fork it ( https://github.com/Fryguy/crystal_allegro/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

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

Third Party Licenses

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