gunkiss/README.md

2.5 KiB

        _______________   ,--------------------------------------------------------.
       //`````````````\\  \                                                         \
      //~~~~~~~~~~~~~~~\\  \   by @ohsqueezy           &  @sleepin                   \
     //=================\\  \     [ohsqueezy.itch.io]     [sleepin.itch.io]           \
    //                   \\  \                                                         \
   //                     \\  \  zlib licensed code at [git.nugget.fun/nugget/gunkiss]  \
  //      ☆ GUNKISS ☆      \\  \                                                         \
 //_________________________\\  `--------------------------------------------------------'

Gunkiss

Generate a custom pudding from food product UPC codes and help a pair of rats take over the video game industry, using their extraterrestrial ability to turn trash into performance enhancing drug puddings that enable business professionals to predict the stock market with supernatural accuracy.

Where to play

Gunkiss is in-development. Public builds for the web and Android are expected to be released soon.

Libraries

The following external libraries are required to compile the game.

cURL

The game uses cURL to communicate with the Open Food Facts API. The cURL library and development headers must be installed to the system paths in order to compile the program.

Linux

On Linux, you can install libcurl and development headers through the package manager. For example, on Debian:

sudo apt install libcurl4 libcurl4-openssl-dev

Other systems

See [the downloads page][] for ways to get the library and headers. It must be installed in such a way that linking can be done with -lcurl and headers are in the default search path.

OpenCV

The game uses OpenCV to enable barcode reading through the camera. The library and headers by default are expected to be installed to [HOME]/local/opencv/lib and [HOME]/local/opencv/headers respectively, but those locations can be edited in the Makefile

ZBar

The game uses ZBar to scan images for barcodes and report what the barcode is. The library and headers by default are expected to be installed to [HOME]/local/zbar/lib and [HOME]/local/zbar/headers respectively, but those locations can be edited in the Makefile.