Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rxxuzi/mango
ASCII Art Generator
https://github.com/rxxuzi/mango
ascii-art c-lang cli-app command-line-tool windows-app
Last synced: 2 days ago
JSON representation
ASCII Art Generator
- Host: GitHub
- URL: https://github.com/rxxuzi/mango
- Owner: rxxuzi
- License: mit
- Created: 2024-08-16T18:28:36.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-03T17:10:20.000Z (3 months ago)
- Last Synced: 2024-11-12T15:11:48.655Z (2 months ago)
- Topics: ascii-art, c-lang, cli-app, command-line-tool, windows-app
- Language: C
- Homepage:
- Size: 190 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mango
Mango is a powerful command-line tool that converts images into ASCII art and displays them in the terminal with advanced color support.
## Features
- Supports multiple image formats (PNG, JPEG, BMP, JPG, JFIF, GIF)
- True Color support for more accurate color representation (16 million colors)
- Customizable padding for output
- Adjustable maximum width for resizing large images
- Colored output using terminal escape sequences
- Bold output characters for improved visibility
- Cross-platform compatibility (Windows and Linux)
- Simple and intuitive command-line interface
## Requirements
- Terminal with color support (True Color support recommended)
- C compiler (GCC or Clang recommended)
- Git
## Setup
Before building the project, you need to clone the `stb` repository to get the required header files:
1. Open a terminal and navigate to the project root directory.
2. Run the following command to clone the `stb` repository into the `src/stb` directory:
```
git clone https://github.com/nothings/stb src/stb
```
This will create a `src/stb` directory containing all the necessary header files, including `stb_image.h` and `stb_image_resize2.h`.
## Usage
After building the project, you can run Mango with the following syntax:
```
./mango [options]
```
### Options
- `-p, --pad `: Set padding (default: 1)
- `-w, --width `: Set maximum width (default: console width)
- `-t, --true-color`: Enable True Color mode
- `-v, --version`: Display version information
- `-h, --help`: Display help message
## Examples
1. Convert an image with default settings:
```
./mango image.png
```
2. Convert an image with custom padding and width:
```
./mango -p 2 -w 100 image.jpg
```
3. Convert an image using True Color mode:
```
./mango -t image.gif
```
## Changelog
For a detailed list of changes and version history, please see the [CHANGELOG.md](CHANGELOG.md) file.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- [stb](https://github.com/nothings/stb) library for image loading and resizing
- Inspired by various terminal-based image viewers