Chewico/DeerEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

IDK

Browse Source
This commit is contained in:
Chewico 2025-05-17 15:24:37 +02:00
parent a65c2bc262
commit f2f9c9a9cd
1 changed files with 24 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README.md
View File

@ -1,11 +1,6 @@
# Deer
Deer is a game engine currently in development by Chewico, focused on facilitating voxel-based scenarios.
# Usage
## DeerStudio
DeerStudio is the program used to create games with Deer. When executed, the first thing DeerStudio will do is prompt for the folder of the Deer project. For example, there is an example project named roe/. Simply select the folder containing roe, and you will be able to run DeerStudio.
# 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.
@ -16,69 +11,40 @@ You can check out Premake at:
- [Premake Core Source Code](https://github.com/premake/premake-core)
## Linux
#### Clone the repo
### Clone the repo
```console
git clone https://github.com/ChewicoGIT/Deer
git clone https://git.frostdeer.com/Chewico/DeerEngine.git
cd Deer
```
## PreRequisites
You will need clang to build the project, as well as the following libraries:
### 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
#### Debian
```console
sudo apt-get install uuid-dev
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
sudo make
```
To build the make files you can compile Premake5 (Preferred) or Download the bin from the official website [Premake Bin](https://premake.github.io/download).
### Compile Premake5(Optional)
Premake5 is the build system for Deer. It is needed to generate the Makefiles necessary to build the project.
Premake5 requires the uuid-dev package:
#### Debian
```console
sudo apt-get install uuid-dev
```
```console
cd vendor
git clone https://github.com/premake/premake-core.git
cd premake-core/
git submodule init
git submodule update
make -f Bootstrap.mak linux
cd ..
```
### Compile Project
If you have downloaded the Premake5 binary, replace ./vendor/premake-core/bin/release/premake5 with your Premake5 binary location. Make sure to be in the project root when executing commands.
### Compile in relase mode
```console
./vendor/premake-core/bin/release/premake5 gmake
make
```
#### Compile in debug mode
```console
./vendor/premake-core/bin/release/premake5 gmake
make config=debug
```
#### Run
### Run
```console
./bin/linux-x86_64/Debug/DeerStudio/DeerStudio
```
### Setup VsCode(Optional)
I recomend install the C/C++ extension From Microsoft in VsCode if not present
```console
cd vendor
./vendor/premake-core/bin/release/premake5 vscode
code Deer.code-workspace
```