mxcop / soul-hunters

Co-op ghost hunting madness

Soul Hunters _{OpenGL & GLFW}

You and your friend are trapped in a haunted castle.
With one flashlight and a vacuum cleaner you will fight your way through waves of ghosts.

Cloning

Make sure to clone using the following command :

$ git clone --recurse-submodules <git:url>

Updating submodules

$ git submodule update --recursive --init

Development

Premake

To get started first download the premake binary from https://premake.github.io/download/
Then add the executable file from the archive into the project root directory. (next too premake5.lua)

Generating project files

To generate the project files run the following commands :

$ premake5 vs2022

^{Replace vs2022 with gmake2 if you're on Linux.}

Codestyle

Our style guidelines look like the code snippet visible below:

/*
 * '#define' and 'const' variables are UPPERCASE.
 */
#define MACRO 17
const float PI = 3.14;

/*
 * 'class' and 'struct' are CamelCase.
 */
class Class 
{
    int id;
};
struct Struct {...};

/*
 * functions, variables, and namespaces are snake_case.
 */
void my_func(int func_arg) 
{
    bool is_enabled = true;

    if (is_enabled) {
        /* 'if' statement use same-line curly brackets. */
    }
};

namespace my_space {...};