Quickly Converting media to ASCII!
Table of Contents
ASCII-gen is an open-source image-to-ASCII converter that allows users to transform images into text art, making it an essential tool for creatives and developers alike. The projects core functionality includes extracting frames from videos or loading images, converting them to ASCII art, and optimizing the output GIF for both quality and size. The project is written in Python and is compatible with Linux, and Windows systems.
| Feature | Description | |
|---|---|---|
| ⚙️ | Architecture | The project mainly runs in a GUI using PySimpleGui |
| 🔌 | Integrations | The project integrates external libraries such as requests, Pillow, moviepy, tkinter, PySimpleGUI, urllib3, certifi, rsa, numpy, and more. |
| 🧩 | Modularity | The project's structure is modular with each functionality separated into a dedicated Python script, enhancing code organization, reusability, and maintenance. |
| ⚡️ | Performance | Written to work dynamically with multithreading. |
| 📦 | Dependencies | The project depends on various external libraries and frameworks, listed within the requirements.txt. |
└── ASCII-gen/
├── ascii-image-converter.exe
├── examples
│ ├── fractal.gif
│ ├── logo.png
│ ├── moai.png
│ ├── purple haze.gif
│ ├── static haze rain.gif
│ ├── tesseract.gif
│ └── vortex.gif
├── gifsicle.exe
├── gui.py
├── installer-linux.sh
├── readme.md
├── requirements.txt
└── run.batExpand
| File | Summary |
|---|---|
| requirements.txt | Install crucial dependencies for the ASCII-gen project. The requirements file lists necessary packages including certifi, colorama, decorator, idna, imageio, moviepy, numpy, pillow, proglog, PySimpleGUI, requests, rsa, setuptools, termcolor, tkinter, tqdm, urllib3. These packages support features such as image processing, GUI development, and network requests. |
| installer-linux.sh | Installs essential dependencies for the Ascii-image-converter software on Linux systems. Configures package repositories, updates system packages, installs Ascii-image-converter, gifsicle, and Python dependencies. |
| gui.py | The main file. Does all of the GUI workload. |
| run.bat | Launches the Graphical User Interface (GUI) application for windows. |
System Requirements:
- Python:
version 3.10 to 3.12
- Clone the ASCII-gen repository:
$ git clone /~https://github.com/KillaMeep/ASCII-gen.git
- Change to the project directory:
$ cd ASCII-gen
Run the program!:
$ run.batIf you're on Linux:
$ ./insaller-linux.sh $ pip3 install -r requirements.txt $ python3 gui.py
Contributions are welcome! Here are several ways you can contribute:
- Report Issues: Submit bugs found or log feature requests for the
ASCII-genproject. - Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone /~https://github.com/KillaMeep/ASCII-gen.git
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to github: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!