https://github.com/ndr3www/rustii

Command line tool for converting images to ASCII art
https://github.com/ndr3www/rustii

ascii ascii-art ascii-art-generator ascii-graphics command-line command-line-app command-line-tool commandline linux-app rust windows-app

Last synced: 4 months ago
JSON representation

Command line tool for converting images to ASCII art

• Host: GitHub
• URL: https://github.com/ndr3www/rustii
• Owner: ndr3www
• License: mit
• Created: 2024-04-18T21:25:04.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-11T20:19:57.000Z (8 months ago)
• Last Synced: 2025-02-02T08:11:18.195Z (4 months ago)
• Topics: ascii, ascii-art, ascii-art-generator, ascii-graphics, command-line, command-line-app, command-line-tool, commandline, linux-app, rust, windows-app
• Language: Rust
• Homepage: https://crates.io/crates/rustii
• Size: 165 KB
• Stars: 17
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

    

  



# Installation

## Through cargo

`cargo install rustii`

## Manually

### Linux

Just download the appropriate binary from [latest release](https://github.com/ndr3www/rustii/releases/latest) and copy it to a directory specified in your `$PATH`, for example:

`sudo cp rustii /usr/bin`

### Windows

1. Download **rustii.exe** from [latest release](https://github.com/ndr3www/rustii/releases/latest)

2. Create a folder named **rustii** anywhere you like

3. Copy **rustii.exe** to the newly created folder

4. Type `environment` in your search bar and hit `Enter`

5. Click the `Environment Variables...` button

6. Select **Path** variable and click `Edit...`

7. Click `New` and then `Browse...`, then find and select the **rustii** folder

8. Click `OK` and you're done!

# Usage

Basically `rustii` has 2 commands:

- `render` - generates ASCII art from a specified image

- `open` - prints specified ASCII art to the terminal/console

`rustii` compresses generated ASCII art file by default, so if you want to get the raw ASCII art, you can simply redirect the output of the `open` command, for example: `rustii open ascii.txt > raw_ascii.txt`

Type `rustii --help` or `rustii -h` to get more details

# Examples

`rustii render avatar.jpg --output ascii.txt --scale 0.22 0.09 --contrast 10`

![image](https://github.com/ndr3www/rustii/assets/164680506/75be086c-67c5-4e84-a3f3-3c65d4af80ec)

`rustii render catedral.jpg --output ascii.txt --scale 0.13 0.053`

![image(1)](https://github.com/ndr3www/rustii/assets/164680506/26d32faf-1748-4c36-b6f7-525d30b38fe2)

`rustii render woman.jpg --output ascii.txt --scale 0.09 0.032 --contrast -5`

![image(2)](https://github.com/ndr3www/rustii/assets/164680506/4c7d2e76-3536-4e92-9e4d-98cc1d1a502a)