Skip to content

Latest commit

 

History

History
119 lines (86 loc) · 2.42 KB

readme.md

File metadata and controls

119 lines (86 loc) · 2.42 KB

cimg

[ file embedding in images ]

License: Unlicense Made with C

✧ features

  • 🖼️ embed files in PNG, JPEG, BMP, or GIF images
  • 📦 automatic data compression
  • 🔄 easy file extraction
  • ✨ preserves image quality
  • 📚 supports multiple files

✧ installation

git clone https://github.com/getjared/cimg.git
cd cimg

# compile embed tool
gcc embed.c -o embed -lz

# compile extract tool
gcc extract.c -o extract -lz

✧ dependencies

  • 📝 c compiler (gcc or clang)
  • 🔧 make
  • 📚 zlib development libraries
    • debian/ubuntu: zlib1g-dev

✧ supported formats

format read write
PNG
JPEG
BMP
GIF

✧ quick start guide

embedding files

./embed <input_image> <output_image> <file1_to_embed> [file2_to_embed ...]

example:

./embed original.png modified.png secret.txt data.pdf

extracting files

./extract <modified_image>

example:

./extract modified.png

✧ example workflow

embedding multiple files

./embed photo.jpg modified.jpg document.pdf notes.txt archive.zip

extraction result

> Extracted: document.pdf (156,789 bytes)
> Extracted: notes.txt (2,045 bytes)
> Extracted: archive.zip (1,034,567 bytes)

✧ technical details

  • 🔄 automatic format detection
  • 📦 embedded data compression
  • 🖼️ quality preservation
  • 📚 multiple file support
  • 🔍 format validation

✧ notes

  • 📝 modified images may be larger than originals
  • 💾 compression helps minimize size impact
  • 🔍 files are verified during embedding
  • 📦 extraction preserves original files
  • ⚡ designed for efficiency

✧ pro tips

  • 📸 png format typically works best
  • 📦 compress large files before embedding
  • 🖼️ higher quality images can store more
  • 💾 keep backups of original files
  • 🔍 verify extracted files after recovery
╭─────────────────────────╮
│  made with ♥ by jared   │
╰─────────────────────────╯