Welcome to Brainfuck Art’s documentation!#

Brainfuck Art is a Python library developed as a hobby project for generating images with hidden Brainfuck code. Inspired by htmlfuck, the library provides functionality to encode text into Brainfuck, convert images to ASCII art, and export the output in HTML, SVG, or PDF formats.

Example#

You can download this example as a PDF: Coffee PDF. Copy the content (Ctrl+A) and paste it into a Brainfuck interpreter like this one to recover the hidden content.

Features#

Text to Brainfuck: Convert any text into Brainfuck code.
ASCII Art Generation: Transform images into color blocks.
Multiple Output Formats: Export your creations as HTML, SVG, or PDF.
Command-Line Interface (CLI): Generate and export art from the terminal.
Python API: Integrate Brainfuck Art into your Python projects with ease.

Installation#

To install Brainfuck Art, ensure you have Python 3.9 or higher, and run:

pip install brainfuck-art

Command-Line Usage#

You can use Brainfuck Art directly from the command line to create art with hidden Brainfuck code:

# Download the example image
curl -L -o coffee.png https://github.com/pablomm/brainfuck-art/blob/main/docs/assets/coffee.png\?raw\=true

# Generate Art with hidden text
brainfuck-art coffee.png -t "I love coffee" -o "coffee.pdf" -W 100 -H 100

Main Options#

-t, –text: Text to encode as Brainfuck code.
-o, –output: The output file name (with extension).
-W, –width: Width of the output in characters.
-H, –height: Height of the output in characters.
-f, –filetype: File type for output (html, svg, pdf).

Python API Usage#

You can also use Brainfuck Art as a Python package to programmatically generate Brainfuck code, interpret it, and create visual art.

Generate Brainfuck Code#

from brainfuck_art import text_to_bf

code = text_to_bf("brainfuck")
print(code)

Example output:

'>+++++++[>++++++++++++++<-]>.<++++[>++++<-]>.<++++[>----<-]>-.++++++++.+++++.--------.+++++++++++++++.<+++[>------<-]>.++++++++.'

Execute Brainfuck Code#

from brainfuck_art import execute_bf

output, tape = execute_bf(code)
print(output)  # Outputs: brainfuck

Generate ASCII Art with Hidden Text#

from brainfuck_art import image_to_matrix, save_matrix_to_svg

text = "I love coffee"
text_matrix, color_matrix = image_to_matrix("coffee.png", text=text)
save_matrix_to_svg(text_matrix, color_matrix, output_file="coffee.svg")

You can also save the output in PDF or HTML formats using the same approach.

License#

Brainfuck Art is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

Contents:

Modules