# floatybox
Float your way through perilous terrain in this endless side-scoller game.

![floatybox](https://raw.githubusercontent.com/octobanana/floatybox/master/res/floatybox.png)

## Contents
* [About](#about)
  * [Features](#features)
  * [Future Features](#future-features)
* [Usage](#usage)
  * [Getting Started](#getting-started)
* [Pre-Build](#pre-build)
  * [Environments](#environments)
  * [Compilers](#compilers)
  * [Dependencies](#dependencies)
  * [Linked Libraries](#linked-libraries)
  * [Included Libraries](#included-libraries)
  * [macOS](#macos)
* [Build](#build)
* [Install](#install)
* [License](#license)

## About
__floatybox__ is an endless side-scrolling game that runs in the terminal using a text-based user interface. The objective is to help guide Box through an endless series of moving goals. Achieve a high score by getting the longest streak!

### Features
* role-play as a box
* stunning truecolour support
* ultra-high-definition unicode graphics
* watch a "sophisticated" ai navigate effortlessly
* provide players with a sense of pride and accomplishment

### Future Features
* ghost replay mode
* remote leaderboards
* deterministic physics

## Usage
View the usage and help output with the `-h|--help` flag,
or as a plain text file in `./doc/help.txt`.

### Getting Started
Run `floatybox` in a terminal that supports __truecolour__.

Use the `<left-mouse>` button or the `<space>` key to play!

## Pre-Build
This section describes what environments this program may run on,
any prior requirements or dependencies needed, and any third party libraries used.

> #### Important
> Any shell commands using relative paths are expected to be executed in the
> root directory of this repository.

### Environments
* __Linux__ (supported)
* __BSD__ (supported)
* __macOS__ (supported)

### Compilers
* __GCC__ >= 8.0.0 (supported)
* __Clang__ >= 7.0.0 (supported)
* __Apple Clang__ >= 11.0.0 (untested)

### Dependencies
* __CMake__ >= 3.8
* __Boost__ >= 1.72.0
* __ICU__ >= 62.1
* __PThread__

### Linked Libraries
* __pthread__ (libpthread) POSIX threads library
* __icuuc__ (libicuuc) part of the ICU library
* __icui18n__ (libicui18n) part of the ICU library
* __boost_coroutine__ (libboost_coroutine) Boost coroutine library

### Included Libraries
* [__Belle__](https://github.com/octobanana/belle):
  Asynchronous input and signal handling, modified and included as `./src/ob/belle`
* [__Parg__](https://github.com/octobanana/parg):
  CLI arg parser, modified and included as `./src/ob/parg.hh`

### macOS
Using a new version of __GCC__ or __Clang__ is __required__, as the default
__Apple Clang compiler__ does __not__ support C++17 Standard Library features such as `std::filesystem`.

A new compiler can be installed through a third-party package manager such as __Brew__.
Assuming you have __Brew__ already installed, the following commands should install
the latest __GCC__.

```sh
brew install gcc
brew link gcc
```

The following CMake argument will then need to be appended to the end of the line when running the shell script.
Remember to replace the placeholder `<path-to-g++>` with the canonical path to the new __g++__ compiler binary.

```sh
./RUNME.sh build -- -DCMAKE_CXX_COMPILER='<path-to-g++>'
```

## Build
The included shell script will build the project in release mode using the `build` subcommand:

```sh
./RUNME.sh build
```

## Install
The included shell script will install the project in release mode using the `install` subcommand:

```sh
./RUNME.sh install
```

## License
This project is licensed under the MIT License.

Copyright (c) 2020 [Brett Robinson](https://octobanana.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.