Skip to content

tomScheers/nFace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nFace

nFace is a terminal-based camera application that converts your live camera feed into ASCII art in real-time using ncurses.

Video Preview

Requirements

  • Linux (for v4l2)
  • A camera (obviously)
  • gcc
  • gzip
  • ncurses library
  • tmux (optional but recommended)

Installation Process

First you'll have to clone the repo from Github

git clone https://github.com/tomScheers/nFace.git
cd nFace

Secondly, you'll have to run make

make

To run the program, you'll need to run

(optional) install it to your system

sudo make install

For nix users

You can install all necessary dependencies via a development shell

nix develop

Usage

You can run the project by executing the binary

bin/nface

Or, if you have installed it to your system, just run

nface

For nix users

You can run the program without any prior installations with nix

nix run github:tomScheers/nFace#default

Options

Flag Description
--help Show help message
-v, --version Show current program version
-w, --width Modify the width of the image frame
-h, --height Modify the height of the image frame
-i, --increment Modify the block increment, the higher the faster, but the less accurate the picture will be

N.B.

  • You can change the resolution of the camera by increasing/decreasing your terminal size using tmux, because this program is responsive

About

An ASCII based CLI camera program

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •