Muscii 🎨

A fast, modern, and colorful image-to-ASCII art converter written in Rust.

What is this?

This is a command-line tool that renders any image (JPEG, PNG, etc.) as colorized ASCII art directly in your terminal. It's a lightweight, cross-platform, and fast alternative to similar tools, built with Rust.

Features

• Fast: Built in Rust for high performance.
• Truecolor: Uses 24-bit ANSI color codes for accurate color representation.
• Smart Resizing: Automatically calculates the correct aspect ratio for terminal fonts.
• Easy to Use: Simple and intuitive CLI flags.
• Cross-Platform: Works on Windows, macOS, and Linux.

Installation

1. From Crates.io (Recommended)

Once you have the Rust toolchain installed, you can install directly from crates.io:

cargo install muscii

2. From Source

If you want to build it yourself:

# 1. Clone the repository
git clone https://github.com/yash-jain-1/muscii.git
cd muscii

# 2. Build and install
cargo install --path .

Usage

The command-line interface is simple:

muscii <PATH_TO_IMAGE> [OPTIONS]

Options

• <PATH>: The path to the image file (e.g., images/photo.jpg).
• -w, --width <WIDTH>: Sets the maximum width of the output in characters. The height will be calculated automatically.
• -H, --height <HEIGHT>: Sets the maximum height of the output in characters. The width will be calculated automatically.
• -h, --help: Prints help information.
• -V, --version: Prints version information.

Examples

1. Run with default size (fits to a width of 64 characters):

muscii "C:\Users\Me\Pictures\sunset.png"

2. Set a specific width of 120 characters:

muscii /home/me/art/my-logo.jpg --width 120

3. Set a specific height of 50 characters:

muscii assets/test.jpg -H 50

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details on how to get started.