Skip to content

nick-aschenbach/game-words

Repository files navigation

Game Words

Find words, phrases, songs, movies, characters, actions and sayings for Pictionary, Catchphrase, Charades or the holidays. Each game has several categories and difficulty levels. This library returns a word list for some or all categories (nearly 5,000 in all).

A command line interface is provided in addition to the Ruby library

Installation

Add this line to your application's Gemfile:

gem 'game_words'

And then execute:

$ bundle

Or install it yourself as:

$ gem install game_words

Command Line Usage

Show all words for a game:

$ gamewords charades

Show all words for a specific game category:

$ gamewords catchphrase people

Show a list of games:

$ gamewords -l

Show a list of categories for a game:

$ gamewords -c pictionary

Show a single random word or phrase:

$ gamewords -r holidays newyears

Library Usage

Show all words for a game:

gen = GameWords::Generator.new
gen.words 'catchphrase'

Show the words for a specific game category:

gen.words 'charades', 'hard'

Show a list of games:

gen.games

Show the categories for a game:

gen.game_categories 'pictionary'

Easily show a random word:

gen.words('pictionary', 'easy').sample

Contributing

  1. Fork it ( https://github.com/[my-github-username]/gamewords/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

Find words for pictionary, catchphrase, charades and holidays

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages