Skip to content

Conway's Game of Life Terminal Eye Candy implemented in Python

License

Notifications You must be signed in to change notification settings

terrencetec/pconway

Repository files navigation

Logo

Conway's Game of Life Terminal Eye Candy implemented in Python.

Website Release Read the Docs License travis-ci codecov pypi pepy

features

  • Play Conway's Game of Life on your terminal.
  • Added mutation feature so the game never terminates (which makes it a terminal eye candy!).

Documentation: https://pconway.readthedocs.io

Repository: https://github.com/terrencetec/pconway

Getting Started

Dependencies

Required

  • Numpy
  • Curses (Included in the Linux version of Python. For Windows users, install windows-curse)

Installation

From PyPI

pip install pconway

From source

git clone https://github.com/terrencetec/pconway.git
cd pconway
pip install .

Debian based

(Not available yet)

sudo apt-get install pconway

Arch-based

(Not available yet) Install from AUR:

paru -Syu pconway

or

yay -Syu pconway

Usage

Command

$ gameoflife -c green -m 0.01

screenshot default

Help message

$ gameoflife -h
usage: gameoflife [-h]
                  [-c {black,blue,cyan,green,magenta,red,white,yellow}]
                  [-C CHAR] [-b] [-s SPEED] [-m MUTATION_RATE]

Play Conway\'s game of life

optional arguments:
  -h, --help            show this help message and exit
  -c {black,blue,cyan,green,magenta,red,white,yellow}, --color {black,blue,cyan,green,magenta,red,white,yellow}
                        Foreground color. Defaults \'white\'
  -C CHAR, --char CHAR  Character representing live cells.
                        Defaults '.'.
  -b, --border          Border on the screen
  -s SPEED, --speed SPEED
                        Frame per second
  -m MUTATION_RATE, --mutation-rate MUTATION_RATE
                        Mutation rate

How to Contribute

Try out the package and file an issue if you find any!