ougge/README.md

32 lines
1.2 KiB
Markdown

# OUGGE
A game engine or something, idk.
## Installation
1. **Clone the repository.**
```sh
git clone --recurse-submodules --depth 1 https://timerix.ddns.net/git/Timerix/ougge.git
```
2. **Install [cbuild](https://timerix.ddns.net/git/Timerix/cbuild).**
3. **Install [SDL2](https://github.com/libsdl-org/SDL) and [SDL2_image](https://github.com/libsdl-org/SDL_image).**
- On **Linux** install shared libraries from a package manager or compile them from source.
- On **Windows** download pre-built dll's from github releases and put them into `dependencies/precompiled/`.
4. **Symlink SDL headers directory** to `dependencies/include`.
```sh
ln -s SDL2_HEADERS_DIRECTORY_ABSOLUTE_PATH -T dependencies/include/SDL2
```
Location of the headers can be found by `pkg-config --cflags --libs sdl2`.
Mingw installs SDL2 headers to `/mingw64/include/SDL2`.
5. **Download mono runtime** ([source is here](https://github.com/dotnet/runtime/tree/main/src/mono)).
- default version
```sh
cbuild download_mono_from_nuget
```
- or some specific version
```sh
cbuild download_mono_from_nuget=x.y.z
```
7. **Compile the program**
```sh
cbuild build_exec_dbg
```