60 lines
1.3 KiB
Markdown
Executable File
60 lines
1.3 KiB
Markdown
Executable File
# Deer
|
|
|
|
Deer is a game engine currently in development by Chewico, focused on facilitating voxel-based scenarios.
|
|
|
|
# How to Compile
|
|
|
|
Deer can compile for both Linux and Windows. Mac support is not considered due to philosophical and technical reasons.
|
|
Deer is built using Premake 5, which generates project files for various build systems such as Make and MSVC.
|
|
|
|
You can check out Premake at:
|
|
|
|
- [Premake Official Website](https://premake.github.io)
|
|
- [Premake Core Source Code](https://github.com/premake/premake-core)
|
|
|
|
## Linux
|
|
|
|
### Clone the repo
|
|
|
|
```console
|
|
git clone https://git.frostdeer.com/Chewico/DeerEngine.git
|
|
cd Deer
|
|
```
|
|
|
|
### Generating Project Files
|
|
|
|
As we mentioned we need to generate the make files with premake, to do this you can install the premake bin or compile it as we will mention
|
|
|
|
```console
|
|
sudo apt-get install uuid-dev make gcc
|
|
cd vendor/premake-core
|
|
make -f Bootstrap.mak linux
|
|
cd ../..
|
|
```
|
|
|
|
```console
|
|
vendor/premake-core/bin/release/premake5 gmake
|
|
```
|
|
|
|
If you want to generate vscode workspace use
|
|
|
|
```console
|
|
./vendor/premake-core/bin/release/premake5 vscode
|
|
```
|
|
|
|
### Compile
|
|
|
|
Run
|
|
|
|
```console
|
|
sudo apt update
|
|
sudo apt install clang libx11-dev libxcursor-dev libxrandr-dev libxinerama-dev libxi-dev libgtk-3-dev make gcc gdb
|
|
sudo make
|
|
```
|
|
|
|
### Run
|
|
|
|
```console
|
|
./bin/linux-x86_64/Debug/DeerStudio/DeerStudio
|
|
```
|