ttysvr - GitLite

KO | EN

gitlite — search

#hacktoberfest #llm #go #machine-learning #rust #linux #windows #awesome #vue #awesome-list #ios #mcp #openai #open-source

ttysvr

(★ 490)

Screensavers for your terminal.

File Explorer

Download Latest Version (.zip)

- - checks.yml
  - release-plz.yml
  - release.yml
  - tests.yml
- bubble.png
- dvd_logo.png
- maze_ceiling_brick.png
- maze_ceiling_hedge.png
- maze_floor.png
- maze_wall_brick.png
- maze_wall_hedge.png
- tty_logo.png
- args.rs
- assets.rs
- bubbles.rs
- common.rs
- lib.rs
- logo.rs
- main.rs
- maze.rs
.gitignore
Cargo.lock
Cargo.toml
CHANGELOG.md
LICENSE-APACHE
LICENSE-MIT
README.md
release-plz.toml

# Installation Guide

1. Get the code

git clone https://github.com/cxreiff/ttysvr

Downloads the entire project code from GitHub to your computer.

cd ttysvr

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Rust (rustup) Rust is required to use cargo.
Homebrew A package manager for macOS/Linux.

cargo install --locked ttysvr

Builds and installs the package published on crates.io — no need to clone the repo yourself.

brew install cxreiff/tap/ttysvr

Installs the pre-built package via Homebrew — no source build required.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo install --locked ttysvr

Builds and installs the package published on crates.io — no need to clone the repo yourself.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ttysvr

Screensavers for your terminal. Start immediately or after a period of inactivity within a shell.

<p float="left">
<img src="https://assets.cxreiff.com/github/ttysvr_logo.gif?" width="30%">
<img src="https://assets.cxreiff.com/github/ttysvr_bubbles.gif?" width="30%">
<img src="https://assets.cxreiff.com/github/ttysvr_maze.gif?" width="30%">
<p>

Uses [bevy_ratatui_camera](https://github.com/cxreiff/bevy_ratatui_camera), my
bevy plugin that allows you to render a bevy application to the terminal using
[ratatui](https://github.com/ratatui-org/ratatui) and
[ratatui-image](https://github.com/benjajaja/ratatui-image).

Triggering the screensaver immediately works in any shell, triggering after a set period of
inactivity is currently Zsh only.

## installation

```sh
# cargo
cargo install --locked ttysvr
```
```sh
# homebrew
brew install cxreiff/tap/ttysvr
```
```sh
# arch linux
pacman -S ttysvr
```
> [!IMPORTANT]
> If you are on Linux and install using the cargo method, or otherwise build from source, you
> will first need to refer to
> [docs/linux_dependencies.md](https://github.com/bevyengine/bevy/blob/main/docs/linux_dependencies.md)
> in the bevy repo for your distro's instructions on making sure bevy's required linux dependencies
> are installed.

## usage

Starts the screensaver immediately. If no variant is specified, one is randomly selected.
```sh
ttysvr [VARIANT]
```

Some variants have subvariants.

```sh
ttysvr [VARIANT] [SUBVARIANT]
```

Sets up the screensaver to activate after `DELAY` seconds of inactivity in your current shell session.
```sh
eval `ttysvr [VARIANT] --init [DELAY]`
```

Cancels the screensaver in your current shell session.
```sh
eval `ttysvr --cancel`
```

> [!NOTE]
> Note that the `--init` and `--cancel` options require being wrapped in `eval` and backticks.
> This is because activating the screensaver after a set period of inactivity relies on setting
> the TMOUT environment variable in your _current shell_, instead of the child shell created by
> the `ttysvr` process. Issues/PRs are greatly appreciated if somebody is aware of a better way
> of doing this!

## variants

| variant | subvariants?     | description                                |
|---------|------------------|--------------------------------------------|
| bubbles |                  | Colorful bubbles bounce around the screen. |
| logo    | `dvd`, `tty`     | DVD player style bouncing logo.            |
| maze    | `brick`, `hedge` | 3D randomly generated maze.                |

## compatibility

### zsh only

The screensaver delay works based on setting a session timeout and catching the
ALRM signal in a way only compatible with ZSH. If you know a way to achieve something
similar in another shell, please open an issue!

### terminal

This requires that your terminal:

1. Supports 24bit color.
2. Has reasonably efficient rendering.

This includes a decent variety of terminals, but I have personally confirmed good results in the following:

- Alacritty (macOS, linux)
- Kitty (macOS)
- WezTerm (macOS)
- iTerm2 (macOS)

### ssh

I have recently added a change that has allowed me to run the screensavers over SSH. This is not very well
tested however, so please open an issue if you run into problems!