Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabe565/cli-of-life
Play Conway's Game of Life in your terminal
https://github.com/gabe565/cli-of-life
bubbletea cellular-automata conways-game-of-life golang hashlife quadtree
Last synced: about 2 months ago
JSON representation
Play Conway's Game of Life in your terminal
- Host: GitHub
- URL: https://github.com/gabe565/cli-of-life
- Owner: gabe565
- License: apache-2.0
- Created: 2024-07-12T07:07:00.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-14T08:34:15.000Z (2 months ago)
- Last Synced: 2024-11-14T09:31:53.774Z (2 months ago)
- Topics: bubbletea, cellular-automata, conways-game-of-life, golang, hashlife, quadtree
- Language: Go
- Homepage:
- Size: 346 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- charm-in-the-wild - cli-of-life - Play Conway's Game of Life in your terminal. (_built with Bubble Tea_) (Applications / Games)
README
# CLI Of Life
[](https://github.com/gabe565/cli-of-life/releases)
[](https://github.com/gabe565/cli-of-life/actions/workflows/build.yaml)
[](https://goreportcard.com/report/github.com/gabe565/cli-of-life)
Play Conway's Game of Life in your terminal!
## Installation
### Docker
Click to expand
A Docker image is available at [ghcr.io/gabe565/cli-of-life](https://ghcr.io/gabe565/cli-of-life)
```shell
sudo docker run --rm -it ghcr.io/gabe565/cli-of-life
```
### Homebrew (macOS, Linux)
Click to expand
Install cli-of-life from [gabe565/homebrew-tap](https://github.com/gabe565/homebrew-tap):
```shell
brew install gabe565/tap/cli-of-life
```
### APT (Ubuntu, Debian)
Click to expand
1. If you don't have it already, install the `ca-certificates` package
```shell
sudo apt install ca-certificates
```
2. Add gabe565 apt repository
```
echo 'deb [trusted=yes] https://apt.gabe565.com /' | sudo tee /etc/apt/sources.list.d/gabe565.list
```
3. Update apt repositories
```shell
sudo apt update
```
4. Install cli-of-life
```shell
sudo apt install cli-of-life
```
### RPM (CentOS, RHEL)
Click to expand
1. If you don't have it already, install the `ca-certificates` package
```shell
sudo dnf install ca-certificates
```
2. Add gabe565 rpm repository to `/etc/yum.repos.d/gabe565.repo`
```ini
[gabe565]
name=gabe565
baseurl=https://rpm.gabe565.com
enabled=1
gpgcheck=0
```
3. Install cli-of-life
```shell
sudo dnf install cli-of-life
```
### AUR (Arch Linux)
Click to expand
Install [cli-of-life-bin](https://aur.archlinux.org/packages/cli-of-life-bin) with your [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) of choice.
### Manual Installation
Click to expand
Download and run the [latest release binary](https://github.com/gabe565/cli-of-life/releases/latest) for your system and architecture.
## Usage
Run `cli-of-life` in a terminal to play.
By default, the grid will be empty, but rle/plaintext files can be loaded with `cli-of-life FILE.rle` or `cli-of-life https://...`
For full command-line reference, see [docs](docs/cli-of-life.md).
### Examples
```shell
$ cli-of-life https://conwaylife.com/wiki/Gosper_glider_gun
$ cli-of-life https://conwaylife.com/wiki/Twin_bees_shuttle
$ cli-of-life https://conwaylife.com/wiki/Breeder_1
$ cli-of-life https://conwaylife.com/wiki/Replicator
```
See the [LifeWiki for pattern files](https://conwaylife.com/wiki/Category:Patterns).
### Keybinds
| Key | Description |
|----------|-------------------------------------------|
| mouse | Place cells |
| `space` | Play/pause |
| `m` | Toggle between modes: smart, place, erase |
| `wasd` | Move the game board |
| `-`/`+` | Zoom |
| `<`/`>` | Change playback speed |
| `esc` | Toggle menu |
| `t` | Tick |
| `ctrl+c` | Quit |
## References
- [LifeWiki](https://conwaylife.com/wiki/Main_Page)
- [An Algorithm for Compressing Space and Time](https://www.drdobbs.com/jvm/an-algorithm-for-compressing-space-and-t/184406478) by Tomas G. Rokicki ([GitHub Mirror](https://github.com/mafm/HashLife))
- [Conway's Game of Life Blog Series](https://ericlippert.com/category/conwayslife/) by [Eric Lippert](https://github.com/ericlippert)
- [noctilu/quadtree](https://github.com/noctilu/quadtree)
- [HashLife](https://www.dev-mind.blog/hashlife/) by [ninguem](https://github.com/ngmsoftware)
- [An implementation of Hashlife in Python](https://johnhw.github.io/hashlife/index.md.html) by [John H Williamson](https://github.com/johnhw)
- [rowett/lifeviewer](https://github.com/rowett/lifeviewer)