glint

A simple 2D game framework for Crystal using Raylib.

Glint was inspired by a number of game engines and libraries, including but not limited to Löve2D, Godot Engine, DragonRuby GTK, microStudio and Solar2D.

Glint doesn't try to replicate them, but it does try to take from them core ideas that make games programming actually fun. It aims to make the necessary parts easy, and make the awesome parts possible.

Note: Glint is a work in progress. It is not yet feature complete (or even feature-ful) in any meaningful sense. Optimisation is a long, long way away, and there is almost no error or bounds checking, other than what Crystal provides. Use at your own risk.

Prerequisites

Raylib should already be installed. If not, you can install it with Homebrew.

$ brew install raylib

Installation

  1. Create a new Crystal app:

    $ cd my-dev-dir            # or wherever you develop
$ crystal init app my_app  # create a new Crystal app
$ cd my_app                # the new app directory

  2. Add the Glint dependency to your shard.yml:

    dependencies:
  glint:
    github: bluematt/glint

  3. Install the glint shard and other dependencies:

    $ shards install  # install dependencies
$ shards check    # optional: make sure dependencies are installed

Usage

# my_game.cr
require "glint"

class MyGame < Glint::Game
  def initialize
    @display_fps = true
    super(800, 600, "My Awesome Game")
  end

  def draw
    Label.draw("Hello, World!")
  end
end

Running and compilation

To run while developing:

$ crystal run my_game.cr

To compile for release:

$ crystal build my_game.cr --release --no-debug
$ ./my_game

Documentation

To generate the HTML documentation for the Glint API:

$ cd ./lib/glint        # the local glint library
$ crystal docs          # generate the glint docs locally
$ open docs/index.html  # open HTML docs in your default browser

Running tests

TODO Write tests.

Development

Glint is under active development.

Contributing

  1. Fork it (https://github.com/bluematt/glint/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

Contributors