Skip to content

Commit

Permalink
Add Compiling.md (partial)
Browse files Browse the repository at this point in the history
  • Loading branch information
ManpreetXSingh committed Feb 12, 2024
1 parent aed20ce commit 585263a
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions COMPILING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Compiling GoZen

This guide will help you compile the GoZen gdextension.

## Step 1: Installing dependencies

### Linux

### Windows

- Install Msys2 from [www.msys2.org](https://www.msys2.org/)
- Add `path\to\msys64\mingw64\bin` and `path\to\msys64\usr\bin` to the `Path` environment variable. The default installation path is `C:\msys64\`

- Update all packages by executing the following command in the terminal:

```bash
pacman -Suy
```

**Note:** In some cases pacman will prompt you to close all terminals. After confiming start a new terminal and re-run the above command.

- Install the required dependencies using the following command:

```bash
pacman -S mingw-w64-cross-binutils mingw-w64-x86_64-toolchain mingw-w64-x86_64-scons mingw-w64-x86_64-yasm diffutils make
```

## Step 2: Cloning repositories

- Open a terminal in the desired directory and clone the Gozen repository

```bash
git clone --recurse-submodules https://github.com/VoylinsGamedevJourney/GoZen.git
```

- Move to the Gozen directory

```bash
cd GoZen
```

- Clone the Godot-cpp repository

```bash
git clone https://github.com/godotengine/godot-cpp.git src/bin/gde_ffmpeg/godot-cpp
```

## Step 3: Compiling and editing the project

- Execute the build script

```bash
sh build.sh
```

**Note:** You will need to compile ffmpeg at least once. Enter `y` when prompted.

- Once the build is complete, you can now open the Godot project located in `./src` directory

```bash
cd src && /path/to/godot -e .
```

0 comments on commit 585263a

Please sign in to comment.