tenpin

A terminal tenpin bowling game.


Keywords
bowling-game, game, ruby, ruby-gem, terminal
License
MIT
Install
gem install tenpin -v 0.0.0

Documentation

tenpin logo

Tenpin

Gem Version Build Status Build status Code Climate Coverage Status Inline docs

Terminal "tenpin" bowling game built with TTY toolkit components.

Bowling known as "ten pins" is a game played by rolling a heavy ball down a narrow lane and attempting to knock down ten pins arranged in a triangle. A player can bowl up to two times per "frame", and a game consists of ten frames. A special rule applies to the last frame in which you can roll up to three times if you have a strike or a spare.

If a player knocks down all ten pins in the first throw, then they have what is called a "strike", and no second ball is rolled in the frame. When some or none pins are knocked down in the first throw, then a second ball is awarded. If all pins are knocked down in the second roll, then the player gets a "spare".

The maximum number of points possible is 300 which a player can get by rolling 12 strikes in a row.

Installation

Add this line to your application's Gemfile:

gem 'tenpin'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tenpin

Usage

Run the game:

$ tenpin

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/piotrmurach/tenpin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the GNU Affero General Public License v3.0.

Code of Conduct

Everyone interacting in the Tenpin project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Copyright

Copyright (c) 2019 Piotr Murach. See LICENSE.txt for further details.