github.com/unn4m3d/crystaledge

A pure Crystal Vector Math library

27 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  crystaledge:
    github: unn4m3d/crystaledge
    version: ~> 0.2.6

Then run:

shards install

shard.yml

Crystal
no constraint declared
License
MIT
Author
unn4m3d <smelnikov871@gmail.com>

Dependencies

This version declares no dependencies.

Documentation

Read the API documentation

Generated from the source of the current release. The first visit to a release that has never been documented starts its build.

README

# crystaledge
[![Build Status](https://travis-ci.org/unn4m3d/crystaledge.svg?branch=master)](https://travis-ci.org/unn4m3d/crystaledge)

Pure Crystal vector math library (**WIP**)


## Installation


Add this to your application's `shard.yml`:

```yaml
dependencies:
  crystaledge:
    github: unn4m3d/crystaledge
```

## Development

TODO List:
- [x] Vector2 math
  - [x] Vector2 * Matrix3
  - [x] Vector2 tests
  - [x] Vector2 docs
  - [ ] "Dangerous" versions of Vector2 methods
- [x] Vector3 math
  - [x] Vector3 * Matrix4
  - [x] Vector3 rotation
  - [x] Vector3 reflection
  - [x] Vector3 tests
  - [ ] Vector3 docs
  - [ ] "Dangerous" versions of Vector3 methods
- [x] Vector4 math
  - [x] Vector4 tests
  - [ ] Vector4 docs
  - [ ] "Dangerous" versions of Vector4 methods
- [x] Matrix3 math
  - [x] Matrix3 tests
  - [ ] Matrix3 docs
- [x] Matrix4 math
  - [x] Matrix4 tests
  - [ ] Matrix4 docs
- [x] Quaternion
  - [x] Quaternion tests
  - [ ] Quaternion docs

## Contributing

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

- [unn4m3d](https://github.com/unn4m3d) - creator, maintainer
- [l3kn](https://github.com/l3kn)