Skip to content

Commit

Permalink
updated README.md, clean tag
Browse files Browse the repository at this point in the history
  • Loading branch information
cxreiff committed Jul 29, 2024
1 parent 017d5a7 commit f890cf3
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "lifecycler"
description = "Bevy Game Jam #5 submission. Terminal aquarium."
version = "0.2.2"
version = "0.2.3"
edition = "2021"
license = "MIT OR Apache-2.0 OR CC0-1.0"
authors = ["cxreiff <[email protected]>"]
Expand Down
36 changes: 28 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,42 @@

[_bevy game jam #5 submission_](https://itch.io/jam/bevy-jam-5)

## installation
![logo](https://assets.cxreiff.com/github/lifecycler.png)

An aquarium that runs in your terminal!

A decoration/fidget-toy that lets you watch your fishes' lifecycle while you code. Test drive of my plugin [bevy_ratatui_render](https://github.com/cxreiff/bevy_ratatui_render).

## play with cargo

If you have [cargo](https://github.com/rust-lang/cargo) installed, you can simply run the following:

```sh
cargo install lifecycler
cargo install lifecycler --locked
```

Alternatively you can manually download an executable from the itch.io page.

## play

To launch the game:
...and then to launch the game:

```sh
lifecycler
```

If you manually installed the executable, you will have to include the path (e.g. `./lifecycler` if in the same directory).
## controls

| | |
|--------------------|----------------------------|
| Left Click or Drag | Dispense a food pellet. |
| Right click | $80 |
| M | Mute/unmute sound effects. |
| Q | Quit the game. |

## manual installation

Alternatively you can manually download an executable from the [itch.io page](https://cxreiff.itch.io/lifecycler) or [github releases](https://github.com/cxreiff/lifecycler/releases).

If you manually installed the executable, you will have to include the path to launch it (e.g. `./lifecycler` if in the same directory).

On macOS you may need to Right-Click > Open With, selecting a supported terminal, and then selecting Open in order to bypass code signing (I haven't figured out code signing yet).

## compatibility

Expand All @@ -36,3 +53,6 @@ This includes a decent variety of terminals, but I have personally confirmed goo
- WezTerm
- iTerm2

## gifs

![day mode](https://assets.cxreiff.com/github/lifecycler_day.gif)![night mode](https://assets.cxreiff.com/github/lifecycler_night.gif)

0 comments on commit f890cf3

Please sign in to comment.