# Rayex

[![Hex.pm](https://img.shields.io/hexpm/v/rayex.svg)](https://hex.pm/packages/rayex)
[![API Docs](https://img.shields.io/badge/api-docs-blue.svg?style=flat)](https://hexdocs.pm/rayex/)
[![Run Tests](https://github.com/shiryel/rayex/actions/workflows/test.yml/badge.svg)](https://github.com/shiryel/rayex/actions/workflows/test.yml)

[![Twitter](https://img.shields.io/twitter/follow/shiryel_.svg?style=social)](https://twitter.com/shiryel_)

Rayex provides Elixir NIF bindings to [Raylib](https://www.raylib.com/)

> WIP: many of the functions on raylib are yet not implemented, check the [contributing section](#contributing) to help

![](examples/3d_picking.gif)

## Installation

The package can be installed by adding `rayex` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:rayex, "~> 0.0.1"}
  ]
end
```

The docs can be found at [https://hexdocs.pm/rayex](https://hexdocs.pm/rayex).

## How to run

You need the following deps installed on your system:
* elixir
* raylib v4.0
* pkg-config

Note: If you are using Nix or NixOS you can run __nix-shell__ to get an ready to go env to work on!

Now you can run:
```bash
mix deps.get
iex -S mix
```

Testing Rayex
```elixir
# Import all modules
use Rayex

# open new window
init_window 200, 200, "window name"

# draw a line
begin_drawing
draw_line 10, 10, 50, 51, %{r: 255, g: 161, b: 0, a: 255}
end_drawing
```

Also you can run our examples!!

## Contributing

There are a few things that you need to know about the code:
* This project aims to run each one of [those functions](https://www.raylib.com/cheatsheet/cheatsheet.html) with elixir
* To do so, we are using [Unifex](https://hexdocs.pm/unifex/readme.html) to create NIFs
* On `c_src/rayex/rayex.spec.exs` you can find the definitions that will be generated by Unifex
* On `c_src/rayex/rayex.c` you can find how they are implemented
* On `c_src/rayex/rayex.h` and `lib/unifex/code_generator/base_types/...` you can find custom types
* On `lib/rayex/unifex/raylib.ex` is where the generated functions will be stored and used for each module under `lib/rayex`, the public API

Any contributions are appreciated

## License

   Copyright 2021 Shiryel

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.