robbertkl/guesswho

Custom character sheet builder for the game "Guess Who?" by Hasbro

v1.0.3 2013-12-12 00:43 UTC

README

Latest Stable Version

PHP library + command line tool to generate custom charactar sheets for the game Guess Who? by Hasbro.

  • Input: 24 character pictures
  • Output: a two-page PDF with the character sheets, which can be inserted into the frame after printing

No scissors needed; just 1 fold. Characters are laid out to perfectly align with the original game frame.

GuessWho is PSR-0, PSR-1 and PSR-2 compliant.

Semantic Versioning is used for releases / tags.

Requirements

Installation

The easiest way to install is using Composer / Packagist by adding this to you composer.json file:

"require": {
    "robbertkl/guesswho": "dev-master"
}

Or just by running composer install after cloning the repo.

Documentation

The usage for the command line tool:

$ ./scripts/guesswho.php --help
Usage: ./scripts/guesswho.php [ options ] -o outputfile.pdf character-images [..]
-d|--dpi <integer>        Image DPI (default 300)
-f|--fontsize <integer>   Font size for character names (default 10)
-g|--gravity <string>     Gravity for crop and fit modes, e.g. north, northwest (default center)
-h|--help                 Show help message
-o|--output-file <string> Output PDF file
-r|--recursive            Search directories recursively
-s|--resize-mode <string> Image resize mode crop|fit (default crop)
-t|--title <string>       Set title of character sheet
-v|--verbose              Enable verbose output

For example:

$ ./scripts/guesswho.php -v -o example.pdf ~/my_images/

See the source of the command line tool for an example of how to use \GuessWho\CharacterSheet. Also, check out the API documentation, generated using ApiGen.

Known Limitations

  • Does not support North American 'letter' page size, only A4
  • Made for the European stand-up 6x4 version of Guess Who, might or might not work on others

Authors

Disclaimer

THIS REPO IS NOT MADE BY, OR OTHERWISE AFFILIATED WITH HASBRO.

Guess Who? was designed to allow the insertion of custom printed character sheets, which are offered by Hasbro on this website. However, the selection is quite limited and my kids wanted to make their own. How much more fun when the characters of the game are your own family members / friends / colleagues!

License

GuessWho is published under the MIT License.