Installation

Installation

ComChan can be installed in many ways

crates.io (Recommended)

# Standard installation (CPU Braille Engine)
cargo install comchan

# Installation with Hardware-Accelerated 3D support (Ratty Terminal)
cargo install comchan --features ratty

AUR

Thanks to orhun, comchan is now available in the AUR

There are 2 targets in the AUR for comchan

Without 3D support

# Using yay
yay -S comchan

# Using paru
paru -S comchan

With 3D support

# Using yay 
yay -S comchan-ratty

# Using paru 
paru -S comchan-ratty

Install the binary

You can install the binary comchan-bin from the AUR

yay -S comchan-bin
# OR 
paru -S comchan-bin

You can also use cargo binstall

cargo binstall comchan

Note

The binary is packaged with the ratty feature enabled, which means you can install the binary if your machine is unable to compile comchan with the ratty feature.

Using elda

comchan (Without 3D support for now) can also be installed via elda as follows

elda i https://github.com/Vaishnav-Sabari-Girish/ComChan

From Source

For the latest development version

git clone https://github.com/Vaishnav-Sabari-Girish/ComChan.git
cd ComChan

# Build and install  (No 3D)
cargo install --path .

# Build and Install (With 3D)
cargo install --path . --features ratty