https://github.com/captn3m0/sushigo

https://github.com/captn3m0/sushigo

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/captn3m0/sushigo
• Owner: captn3m0
• License: mit
• Created: 2017-07-22T19:33:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-07-23T23:14:29.000Z (over 3 years ago)
• Last Synced: 2023-03-11T17:57:35.683Z (over 1 year ago)
• Language: Ruby
• Size: 39.1 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Sushi Go

This is a work-in-progress conversion of Sushi Go (original), the popular card game by Gamewright into Ruby.

The long term goal is to make it easily scriptable via a RPC-interface that hooks into

something as described in [my ideas repo][ideas].

Currently only supports the original game, and not Sushi Go Party. The following features are supported:

1. Scoring of individual rounds and final scoring (desserts)

2. Setup for 2-5 players

3. Chopsticks are supported, using the extra sushi go call

4. Pick-and-pass

There are rigorous tests for the scoring algorithms as well.

You can find the complete rules at [the gamewright website][rules].

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'sushigo'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install sushigo

## Usage

Run `rake` to run tests

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org).

## Contributing

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

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

[ideas]: https://github.com/captn3m0/ideas/blob/master/card-game-modelling.md

[rules]: http://www.gamewright.com/gamewright/pdfs/Rules/SushiGoTM-RULES.pdf