Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 5.12 KB

COMPILE_INFO.md

File metadata and controls

57 lines (36 loc) · 5.12 KB
Raw

Compiling GDE GoZen

Tip

If you don't want to compile the GDExtension yourself and want to easily receive the updates of GDE GoZen then you can always get the addon on my ko-fi page and on itch.io. These compiled versions get updated with every release, so you don't have to spend your time, electricity and pc resources on compiling. With the added benefit that you are helping to fund this project, which is very much appreciated! :D

Compiling this GDExtension can be done in three different ways:

  • Using the python file build.py;
  • Using EasyMenu;
  • Using the command line and scons;

For the people who need extra help, feel free to watch this video: https://youtu.be/62smFmZyekg

Before you do anything

Install python, scons, and git! Also, initialize the submodules of the git repo with git submodule update --init --recursive. Updating the submodules can be done with git submodule update --recursive --remote. Without doing this you'll get errors that the scons file could not be found.

Using build.py

For this, and all other options, you need Python3 and scons installed on your system. Also update the git submodules! To compile it's pretty straight forward, just run the script inside your terminal (on Windows use Powershell) with the command python build.py or python3 build.py depending on your distribution and OS. After that you'll be asked several questions for how you want to compile the GDExtension, enter the numbers of the selection you want and press enter.

There is an option for using the system FFmpeg, if the system does not have FFmpeg installed (Version 6+) you should not use the system install and you'll have to compile FFmpeg libraries from scratch to accompany the GDExtension file. Note that this is only applicable for Linux users! For Windows you don't have a choice as the FFmpeg libraries need to be included for it to work as there are no globally installed FFmpeg libraries.

GPL should ONLY be enabled when your project is open source and you need rendering capabilities. If you just want video playback then this part is not needed anyway. What this does is allow for more codec support, which is needed for certain encoders. Take in mind that when enabling this, you'll also need to select to rebuild the FFmpeg libraries.

Note

When you build GDE GoZen for the first time, it'll take a good amount of time. Also make certain that you are compiling the FFmpeg libraries as this is necessary for things to work!

Using EasyMenu

EasyMenu is a tool I made myself to help people compile the software which I make. You can get the working version from the release section on the repo.

Add the executable to the GDE GoZen folder, or open the easy_menu.conf file with the executable. You will need to press the buttons to update the git submodules and also enable (Re)compile FFmpeg on your first build. Also same as for building using build.py, read the GPL part as this is important to know before selecting it.

Using the command line

Using the command line is pretty straightforward, but I ask that if you never compiled with the command line before and don't want to learn how to do this, that you please use the EasyMenu option, or the build.py option.

To compile from the command line use scons with the default Godot compile commands afterwards:

  • -j<number of threads>: multi-threaded compiling;
  • target=<template>: is specificially for Godot, so use or template_debug or template_release;
  • platform=<OS>: linux or windows are supported right now, other platforms such as macos, android, and web aren't yet supported;
  • arch=<architecture>: only supported architecture is x86_64, no guarantee that x86_32, arm64, arm32 and rv64 work.

Then there are the extra arguments which are GDE GoZen specific:

  • use_system=<yes/no>: only use no if you are compiling for Linux systems which have FFmpeg 6+ installed;
  • recompile_ffmpeg=<yes/no>: on first compile runs, this should be yes for each OS;
  • enable_gpl=<yes/no>: if you need rendering capabilites and your project is licensed under GPL, you can set this to true;
  • location=<bin>: if you just need the binaries, pass bin and they'll be build in the bin folder, for the addon pass the test room's addon folder.

Struggling and need help?

Caution

At this moment only Linux and Windows are supported! Compiling on Windows, however, may come with some challenges and may not always work if you don't have the correct tools installed such as python, scons, git, ...

You can join our Discord server to ask for help, but before joining the Discord server because compiling doesn't work, please check if your submodules are properly initialized. If you run into some issues after trying, feel free to ask for help in the Discord server in the gozen-video-editor channel.