termixel

KO | EN

gitlite — search

#automation #html #ui #nextjs #anthropic #ai-agents #list #pytorch #mysql #android

(★ 9)

small terminal sprite renderer

File Explorer

ZIP Download

- cached_rendering.rs
- sprite_rendering.rs
- - Cargo.toml
  - README.md
- - list.md
  - sprite.md
- config_path.rs
- main.rs
.gitignore
build.sh
Cargo.lock
Cargo.toml
install.ps1
install.sh
README.md
rust-toolchain.toml

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> **This project was not written by a clanker**

Termixel is a minimal and sort of fast terminal sprite renderer. It uses Unicode characters to render pixel art directly in the terminal.
Termixel is heavily optimized for size and currently comes in at around **200 KB**. It currently only supports `.png` files and will probably never support any other formats.
If you want support for more file formats, feel free to fork the repo and implement it yourself.

> Termixel is designed for rendering pixel art and may not be suitable for bigger images.

## Installation

### Linux

If you want to quickly install Termixel, you can use our installation script:

```bash
curl -fsSL https://raw.githubusercontent.com/genkii/termixel/main/install.sh | bash
```

The script downloads the Termixel binary and installs it to `~/.local/bin`.

After the installation, make sure `~/.local/bin` is in your `PATH`. If it isn't, add this to your shell configuration:

```bash
export PATH="$HOME/.local/bin:$PATH"
```

### Windows

On Windows, you can use our PowerShell installation script:

```powershell
irm https://raw.githubusercontent.com/genkii/termixel/main/install.ps1 | iex
```

The script downloads the Termixel executable and installs it to your local application directory. It also adds Termixel to your user `PATH`.

You can also view the [installation script](https://github.com/genkii/termixel/blob/main/install.ps1) on GitHub.

### From Source

If you prefer, you can build Termixel yourself from source.

Clone the repository and build it using Cargo:

```bash
git clone https://github.com/genkii/termixel.git
cd termixel
cargo build --release
```

If you want a smaller binary, you can also use the `build.sh` script to build the project.

The compiled binary will be located in:

```text
target/release/termixel
```

## Setup

Termixel looks for `.png` files in its config directory.

### Linux

```text
~/.config/termixel/
```

### Windows

```text
%APPDATA%\termixel\
```

Just put your `.png` files in the folder.

## CLI

### `termixel list`

Lists all available sprites.

### `termixel sprite <name>`

Renders a sprite in the terminal.

The name is the filename without `.png`.

## Using The Crate

Termixel uses the inbuild termixel-core crate you can check it out on crates.io

https://crates.io/crates/termixel-core

## Supported Formats

Currently, only `.png` is supported.
There probably won't be support for other formats in the future. If you need another format, feel free to fork the repo and add it yourself.

## Limitations

Termixel is made for small pixel-art sprites. Bigger images can get difficult to read and take up a lot of space in the terminal.
The main goal of the project is to keep it small, simple, and portable.

## Contributing

If you want to improve Termixel or add something to it, feel free to open an issue or pull request.

termixel

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README