Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 2.33 KB

README.md

File metadata and controls

101 lines (63 loc) · 2.33 KB

PONG - "ncurses" version - BETA

VERSION

0.6.3

Build

make

You can run this from the local bin directory via: ./bin/pong

Install

make install (Or, depending on your permissions, sudo make install

This will install pong to /usr/local/bin/. Update your executable path as needed.

At this point, you may want to clean your local build files:

make clean

Testing

make test

This will run Valgrind tests while the program is executing (defaults to valgrind ./bin/pong --leak-check=full -v (See Makefile for more info...)

Uninstall

So, this version of Pong wasn't your cup of tea? Well, that's fine, I suppose. Just run the following command and you will be rid of it for good! :-)

make uninstall

Play

Player 1 (LEFT): a for UP, z for DOWN (update src/include/pong.h to change)

Player 2 (RIGHT): ARROW UP for UP, ARROW DOWN for DOWN (update src/include/pong.h to change)

Documentation

As the code continues to grow, so will the documentation should it be formatted correctly. To generate the latest version of the docs, simply run:

doxygen Doxyfile

Dependencies

  • ncurses - ncurses ("new" curses - be sure to install ncurses.h - Many Debian/Ubuntu-based Linux distros package this in libncurses-dev)
  • Valgrind - Instrumentation Framework
  • Doxygen - Generate documentation from source code

AUTHOR INFO

-- JUSTIN R. EVANS --

[email protected]

https://www.linkedin.com/in/justinrobertevans

http://fullstackconsultancy.net/

Additional Notes

Presently, this is set to two player mode.

Winning score is set to 21 as per the Atari 2600 implmentation

File structure overview:

.
├── Makefile
├── README.md
├── bin
│   ├── pong
├── docs
├── src
│   ├── include
│   │   └── pong.h
│   ├── obj
│   │   ├── ball.o
│   │   ├── field.o
│   │   ├── paddle.o
│   │   ├── screen.o
│   │   └── user.o
|   ├── ball.c
│   ├── field.c
│   ├── paddle.c
│   ├── pong.c
│   ├── screen.c
│   └── user.c

Enjoy!