Sista

Sista is a lightweight, fast, easy-to-use, memory-safe and OS-agnostic object-oriented library for making terminal videogames and animations in C++.

Sista provides a set of classes and functions to make terminal games in C++ easier, shielding developers from having to reinvent the wheel every time they want to make a terminal videogame.

Installation

Sista as a source library

To install Sista, simply download the latest release from GitHub, and extract the contents of the archive to your project's source directory.

Sista as a shared library

If you want to use Sista as a shared library, you can use the provided Makefile in the repository. Simply run the following command in your terminal with administrative privileges.

sudo make install

This will install the libSista.so shared library in the system library path, and the headers in the system include path. This is the preferred inclusion method for versions v3.0.0 and later. More on this in the documentation.

sudo make uninstall

This will remove the installed files from the system library and include paths. The same disclaimer applies as above, you will need administrative privileges to run this command.

Sista as a shared library - <tt>.deb</tt> package

We release a .deb package for Debian and derivatives with each release. The upload is manual for the moment.

• go to the latest release
• download the sista_<VERSION>_<ARCHITECTURE>.deb release asset
• use sudo apt install path/to/sista_<VERSION>_amd64.deb, like sudo apt install ~/Downloads/sista_3.0.0-1_amd64.deb

For the moment only amd64 (for x86_64 architectures essentially) packages are published. With the right tools you can package your own.

git clone https://github.com/FLAK-ZOSO/Sista
cd packageroot
dpkg-buildpackage -us -uc -a arm64 -b # Specify your architecture, such as "i386", "arm64", "amd64"

Usage

Using Sista as a source library

To use Sista, simply include the "sista.hpp" header in your project's source files.

#include "include/sista/sista.hpp"

The "sista.hpp" header includes all of the other headers in the "include/sista/" directory, so you don't have to include them individually.

Using Sista as a shared library

You also need to include the "sista/sista.hpp" header in your source files, as shown above.

#include <sista/sista.hpp>

This approach will require you to link against libSista when compiling your project. You can do this by adding the -lSista flag to your g++ command.

g++ -std=c++17 -o my_project my_project.cpp -lSista

See the documentation for more details on how to use Sista as a shared library and how to link against it. A comprehensive example is provided in the [Makefile](Makefile) in the repository, together with the installation targets.

Documentation

The English tutorials and basic documentation for Sista can be found at Sista - ReadTheDocs.

The actual, detailed documentation of both library and C API can be found at flak-zoso.github.io and is automatically generated from the source code using Doxygen.

Under the demo/ directory, you can find many minimal demos that showcase the features of Sista. These demos are minimal examples and do not aim to provide a complete walkthrough of the library, unlike the sista.cpp example. Their description is provided in the `demo/README.md` file.

Additional information about versions can be found in the `Release Notes`.

Sista-based works

Here are some of the most relevant works based on Sista.

• Inomhus - Bättre att stanna inomhus (better be in the house) - a survival videogame
• Starklag - den starkastes lag (the law of the strongest) - a partial evolution simulator
• Dödas - de dödas angrepp (attack of the dead) - a survival speedrun videogame
• Dune - a survival videogame inspired by Dune
• Inävjaga - Inälvor jagade (intestin hunt) - a survival videogame with hordes of enemies