README.mdown


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

![Piranha](https://github.com/realtradam/ruboids/blob/master/assets/Predator%201.png?raw=true)

[![MIT License](https://img.shields.io/github/license/realtradam/FelFlame?label=license&style=flat)](https://github.com/realtradam/FelFlame/blob/master/LICENSE)
[![Ko-Fi](https://img.shields.io/static/v1?message=Buy%20me%20a%20coffee&logo=kofi&labelColor=ff5e5b&color=434B57&logoColor=white&label=%20)](https://ko-fi.com/tradam)


# Ruboids

Ruboids is a [Boids Algorithm Simulation](https://en.wikipedia.org/wiki/Boids) made using [Ruby2D](http://www.ruby2d.com), [FelFlame](https://github.com/realtradam/FelFlame) and [Ruby2D-Camera](https://github.com/realtradam/ruby2d-camera)

![Ruboid Example](https://github.com/realtradam/ruboids/blob/master/ruboid-example.gif?raw=true)

## How to Play

### Without Bundler
once you install the gems `ruby2d`, `felflame`, and `ruby2d-camera` simply do `ruby run.rb`

### Using Bundler
`bundler install` followed by `bundler exec ruby run.rb`

## Controls
Left click on the screen to create a Piranha.  
Right Click and drag to move the camera. (`w` `a` `s` `d` works as well)  
Scrollwheel to zoom. (`z` and `x` work as well) 

## Playing around with the parameters
All the parameters you can change are nicely stored inside the `SingletonConfig` component in the `$config` variable in `run.rb` so it is easy to quickly and easily change and play around with them.

## Purpose
I made this to stress test my new framework FelFlame and see how it is, and it was really nice and easy making this game so I will probably continue to use it for future projects. Also just I wanted to play around with boids. 😁