angina

⚠️ Under construction ⚠️ Some of the code examples you see on this page are outdated. I am working on a new API.

angina is a cross-platform* game engine with graphics, audio handled by SDL 2 and build system with CMake.

It is written from scratch, with help of tutorials on LazyFoo Game Tuts with SDL and C++ Applications Dev Course

Users of angina should inherit from the main Engine class and build their own game! :)

*Tested only on Windows and Linux.

See a chess game developed with the engine 👀

Project structure

platform - Low level module. SDL wrappers (Surface, Texture), thread and time libraries.
renderer - Low level module. Renderer and primitives - Object, Point.
engine - Mid level module. Uses renderer, contains class that drives game loop.
core - Low level module for math, physics libraries, etc. of that sort.
examples - Implementations of games, built with the engine.
resources - Place for all the assets of the game and a header file that exposes paths to them.
releases - Holds archives of builds that you can download, unzip and run.

Steps to run on your computer

Go to releases folder and pick the version for your OS.
Download the zip
Unzip it
Run the exe/binary.

Steps to build

Windows 10

cd Release
cmake -DCMAKE_BUILD_TYPE=Release .. -G "MinGW Makefiles"
mingw32-make

Linux

TODO: Add steps

Steps to run in debug mode:

Go to build folder
cmake ..

Ubuntu 20.04 (gcc (Ubuntu 9.4.0-1ubuntu1~20.04.1) 9.4.0)

make
./angina

Windows 10 using MinGW (TODO: add compiler version here)

mingw32-make
./angina.exe

MacOS (TODO: Test whether it runs on MACOS!)

Getting started with your own game!

Step 1: Inherit Engine class and implement virtual methods. Step 2: Create a component and add it to main screen

void Test::callbackFunc() {
	std::cout << "Hello ! I am the clicked button! The secret is " << privateNumber << std::endl;
}

void Test::init() {
	Point p = { 0, 0 };
	Dimensions dim = { 200, 70 };
	Color background = Color::BLUE;
	Color textColor = Color::RED;
	std::string txt = "Click me!";

  // Here we use a factory to create a button and add a callback to it.
	RectTextButton* btn = getFactory().createButton(p, dim, background, textColor, txt, defaultFont, std::bind(&Test::callbackFunc, this));

	rootScreen.put(*btn); --> Putting the button on the main screen.
}

Step 3: Instantiate your game engine and do not forget to startup SDL.

#include <cstdint>
#include <cstdlib>
#include <iostream>

#include "platform/sdl/init/Graphics.h"

#include "test/Test.h"
#include "exceptions/BaseException.h"

int32_t main([[maybe_unused]] int32_t argc, [[maybe_unused]] char** argv) {
	try {
		Graphics::boot();
		Graphics::bootImageExtension();
		Graphics::bootTTFExtensions();

		Engine* game = new Test();

		game->start();

		delete game;

		Graphics::shutdown();

		return EXIT_SUCCESS;
	} catch (const BaseException& ex) {
		std::cerr << ex << std::endl;

		Graphics::shutdown();

		return EXIT_FAILURE;
	}
}

To be done ("Art is never finished, it is abandoned.")

Separate engine resources from chess game resources.
Implement Minimax (Not until a tic-tac-toe with minimax)
Networking (something simple using networking first)
Player timers (Blitz style)

pancanin / angina