summaryrefslogtreecommitdiff
path: root/README.md
blob: bb68061d266cc251a5ebdb0be515be909c14231c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Building
Third-party libraries used:

 * EnTT
 * nlohmann\_json
 * raylib

Both Raylib and Nlohmann's JSON libraries are available in mainstream distribution repositories. Confirmed with Arch
Linux and Ubuntu. In case they are not, you can install Raylib[1] and JSON[2] from source. EnTT is rarely available. For
Arch Linux you can use AUR package[3]. Otherwise, install from source git repository[4].

After making sure all dependencies are available, run CMake to generate and build:

    $ cmake -B build .
    $ cd build/
    $ make

Or use any preferred equivalent method.


# Running
To run the game, once it's built start it from the build directory root:

    $ cd build/
    $ kurator/kurator

This is to ensure dependencies on resources paths.


[1] https://github.com/raysan5/raylib
[2] https://github.com/nlohmann/json
[3] https://aur.archlinux.org/packages/entt
[4] https://github.com/skypjack/entt