diff options
Diffstat (limited to 'README.mdown')
| -rw-r--r-- | README.mdown | 31 |
1 files changed, 29 insertions, 2 deletions
diff --git a/README.mdown b/README.mdown index 82ebbca..6e0f6b4 100644 --- a/README.mdown +++ b/README.mdown @@ -1,3 +1,30 @@ -## Boids simulation made using [Ruby2D](http://www.ruby2d.com) and [FelFlame](https://github.com/realtradam/FelFlame) + -Making this mostly as a test of using FelFlame in a real project, to try out and see if I can find bugs of flaws in it. +[](https://github.com/realtradam/FelFlame/blob/master/LICENSE) +[](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) + + + +## How to Play + +### Without Bundler +once you gem install `ruby2d`, `felflame`, and `ruby2d-camera` simple 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 `SingletomConfig` 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. 😁 |