Symphony of the Empires

Want to contribute or are interested in the development of the game? See our discord https://discord.gg/44QuvuDmCS

This is an Opensource RTS game engine; created to be very mod-friendly.

Required to build:

• SDL2 and SDL2-ttf
• lua 5.3 (or 5.4)
• GL and GLU
• libavcodec (on most package managers it's ffmpeg)

Build on Linux

Debian-based distros

Install all dependencies with this command:

sudo apt install -y libpng-dev libsdl2-dev libsdl2-ttf-dev liblua5.3-dev libtbb-dev libglew-dev libglm-dev libassimp-dev

The build with these commands once all the dependencies are met:

cmake -DUR_BACKEND_OPENGL=1 .
make

Specifying -j to make will freeze systems, use -j$(nproc) instead, if a multithreaded compilation is desired.

Use this code to install Lua5.4

wget http://mirrors.kernel.org/ubuntu/pool/universe/l/lua5.4/liblua5.4-0_5.4.0-2_amd64.deb
sudo dpkg -i liblua5.4-0_5.4.0-2_amd64.deb
wget http://mirrors.kernel.org/ubuntu/pool/universe/l/lua5.4/liblua5.4-dev_5.4.0-2_amd64.deb
sudo dpkg -i liblua5.4-dev_5.4.0-2_amd64.deb

Alternatively, you can call cmake with the flag -Dlua54:BOOL=ON to compile with Lua 5.4 - since 5.3 is used by default.

The project can also be built using clang.

Arch-based distros

pacman -S libpng sdl2 sdl2_ttf tbb glew lua53 glm

Build on Windows

MSYS2

Once msys2 has been installed for the first time, you'll have to run the following commands to install essential development packages:

pacman -Syu
pacman -Su

Simply run the following after setting up the initial msys environment:

pacman -S mingw-w64-SDL2_ttf mingw-w64-SDL2 mingw-w64-lua mingw-w64-zlib

# Try this one if the above does not work
pacman -S mingw-w64-x86_64-SDL2_ttf mingw-w64-x86_64-SDL2 mingw-w64-x86_64-lua mingw-w64-x86_64-zlib

On 32-bit systems the following is required:

pacman -S mingw-w64-i686-SDL2_ttf mingw-w64-i686-SDL2 mingw-w64-i686-lua mingw-w64-i686-zlib

Finally; to build you only have to run:

cmake -G"Unix Makefiles" -DUR_BACKEND_OPENGL=1 .
make

Visual Studio

Builds can be built using Visual C compiler. The trick is to create a new solution and place everything there, add src and src\client as include folders and use NuGet to obtain the required dependencies, then define the macro windows.

Running

In order to run the game you just need to run it via the command line or left-click the executable:

./game

If the server crashes and the port needs to be re-aquired do the following under *NIX systems:

fuser -k 1836/tcp

Coding style

4-spaces are used, tabs should be replaced with 4-spaces too. All functions, members and variables follow a snake_case convention; whereas the object-typenames and types should be done as CamelCase.

Object declaration

Class members on declarations should be ordered, starting by the private section, followed by the protected section, to finally conclude on the public section. Each section should first start by the "main-constructor", followed by copy-constructors and any variant of the constructors; after it, follows the destructor of the object. Then follows the main methods of the object. Methods don't need to have a specific order. After the methods all the remaining member data is appended. Members don't need to have a specific order.

In short - all functions for classes should be conformed as this:

class Foo {
    // private constructors/destructors
    Foo(const Bar&);

    // followed by private methods
    int add_cmpxchg(int&&);

    // finally by the private data
    int secret_value;
protected:
    // constructor, copy-constructor & variants, destructor
    Foo(const Bar*);

    // methods
    int add_cmpxchg_sse3(void);

    // members
    int stuff;
public:
    Foo();
    // here should be any variant of constructor function prototypes
    ~Foo();

    // rest of the functions
    explicit int add(int&, int&);

    // and finally the data
    int value;
};

Blocks

Simply put:

while(a) {
    if(b) {
        // stuff...
    } else if(c) {
        // stuff...
    }

    // no "single line" or brace-less ifs
    if(d < 0) {
        increment_d(&d);
    }
}

Naming convention

Classes, Structs, Types and Typenames are named in PascalCase, while variables, struct/method members and functions are declared using snake_case. Enum members and macros are declared in SCREAMING_SNAKE_CASE.

struct FooBar {
    FooBar() {};
    ~FooBar() {};

    int method(void) {
        return 0;
    };

    template<typename T1 = int, typename T2 = int>
    int add(T1 a, T2 b) {
        return a + b;
    };
public:
    int member;
    int test_thing;
    bool is_attack;
};