AltHack

This file will contain useful information about the AltHack project. Stay tuned!

The most up to date documentation can be found here.

How to Build

To build the main application, run the following:

git clone https://github.com/althack-project/althack
mkdir build
cd build
cmake ..
make

To build the documentation instead of the main application, change the make command to the following:

make documentation

The documentation can be found under build/docs/sphinx and build/docs/doxygen, respectively.

How to Run

To run the main application file, run

./build/bin/althack-bin

after building the main application. The main binary supports various command line options, which can be displayed via

./build/bin/althack-bin --help

Development Roadmap

This section will be revised into time segments, release cadence, etc., but for the time being I'm just collecting next steps and later make sense of their exact order and timing.

Backend selection - When game starts, allow selection of server or client mode. Overridable through command line parameters.
Account management in backend - At least in the server backend, accounts should be stored permanently and served to connecting clients.
More to come