Code Monkey home page Code Monkey logo

baku's Introduction

Baku

Baku provides a simple Entity Component System framework for use with Ruby game engines. It has been tested with Gosu, but should be flexible enough to work with any Ruby project that has a game loop.

Baku is still very much a work in progress. There are undoubtedly bugs. I will be continually iterating and improving on it as I use it for my personal game development projects. Enjoy!

The Baku wiki includes a quick start guide if you're already familiar with the ECS approach. If not, there is also a descriptive tutorial that will cover ECS concepts while walking you through setting up Gosu with Baku.

Installation

Add this line to your application's Gemfile:

gem 'baku'

And then execute:

$ bundle

Or install it yourself as:

$ gem install baku

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jtuttle/baku.

License

The gem is available as open source under the terms of the MIT License.

baku's People

Contributors

divoolej avatar jtuttle avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

baku's Issues

Update Wiki to use ComponentSystem instead of System

Hey there, I'm loving the library so far :) However, I found an issue while following the Tutorial / Quick Guide - all of the system examples still inherit from the Baku::System, which no longer works and causes a nasty error which is impossible to track without diving into the library code (which is probably going to drive many people away from the lib).

The references to Baku::System can be found here:

I wanted to create a PR but it seems that Github doesn't allow that for the Wiki content, so I'm creating this issue instead.

@jtuttle (mentioning for visibility :))

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.