Skip to content

Latest commit

 

History

History
403 lines (266 loc) · 11.8 KB

README_SETUP.md

File metadata and controls

403 lines (266 loc) · 11.8 KB
Raw

Setup Engine

(Setup instructions for the editor here).

Required Software

Platform SDK

To make contributions easier, we detect local installations of the common platform SDK's:

  • macOS + iOS: XCode
  • Linux: Clang++
  • Windows: Visual Studio Community 2022
    • We also require Clang:
      • In Visual Studio Installer, under Individual components, select C++ Clang Compiler for Windows and MSBuild support for LLVM (clang-cl) toolset.
      • Add clang to your PATH. For a default installation, the path to add will likely be C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\Llvm\bin
  • Android: Android Studio

For consoles, we refer to each vendor's installation notes.

Package managers

Windows...

  • Chocolatey - Chocolatey is a package installer that will help install various helper tools such as python, ripgrep etc.

Open a Command (cmd.exe) as administator and run:

@"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "[System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"

Once this is done, you can install new packages which are added to the PATH, by running:

choco install <package_name>

Required Software - Java JDK 21

Download and install the latest JDK 21 (21.0.5 or later) release from either of these locations:

  • Adoptium/Temurin - The Adoptium Working Group promotes and supports high-quality runtimes and associated technology for use across the Java ecosystem
  • Microsoft OpenJDK builds - The Microsoft Build of OpenJDK is a no-cost distribution of OpenJDK that's open source and available for free for anyone to deploy anywhere
Windows...

Or install using Chocolatey:

choco install temurin21

With choco, the install path is something like /c/Program\ Files/OpenJDK/openjdk-21.0.5_11

Linux...

Or install from apt-get:

> sudo apt install openjdk-21-jdk

When Java is installed you may also add need to add java to your PATH and export JAVA_HOME:

> nano ~/.bashrc

export JAVA_HOME=<JAVA_INSTALL_PATH>
export PATH=$JAVA_HOME/bin:$PATH

Verify that Java is installed and working:

> javac -version

Required Software - Python 3

You need a 64 bit Python 3 version (x86_64) to build the engine and tools. The latest tested on all platforms is Python 3.10.5.

macOS...

Once Python has been installed you also need install certificates (for https requests):

> /Applications/Python\ 3.10/Install\ Certificates.command

Windows...

Or install using Chocolatey:

choco install python

Linux...

You also need easy_install to install additional packages.

Required Software - DotNet 9

(optional)

NOTE The DotNet 9 preview currently only supports macOS platform

In order to build and test the csharp languange bindings locally, you need to install DotNet.

Install...

There are a few ways to install the DotNet sdk:

Bash:

> ./dotnet-install.sh --channel 9.0 --quality preview

PowerShell (Windows):

> ./dotnet-install.ps1 -Channel 9.0 -Quality preview

Required Software

macOS...

XCode

we use XCode for building and debugging macOS + iOS targets.

Windows...

Visual C++ 2022 Community

Download the Community version or use the Professional or Enterprise version if you have the proper licence. When installing, select the "Desktop Development with C++" workload. There is also an optional 3rd party git client. Also, make sure to install the "clang++" compiler as well.

Terminal

https://aka.ms/terminal

The git-bash setup can also install a setup for the Windows Terminal app.

This terminal has the tool winget to install some packages.

Git Bash

This installs both Git as well as a Terminal addon to allow you to use a *nix like bash terminal, making it much easier to build Defold through.

Download: Git For Windows

Git

This is not needed if you've installed git-bash

You need to download a command line version of Git.

During install, select the option to not do any CR/LF conversion.

You most likely want to set up working with ssh keys as well.

SSH Keys

Using Git Gui

  • Run Git GUI
  • Help > Show SSH Key
  • If you don't have an SSH Key, press Generate Key
  • Add the public key to your Github profile
  • You might need to run start-ssh-agent (in C:\Program Files\Git\cmd)

Command line

Alternatively, you can easily create your own key from command line:

$ ssh-keygen -t ed25519 -C "[email protected]"
# Copy the contents of the public file
$ cat ~/.ssh/id_ed25519.pub
# Add the public key to your Github profile (under the Setting tab on your github user profile)
# Test your new key:
$ ssh -T [email protected]

Now you should be able to clone the defold repo from a command prompt:

> git clone [email protected]:defold/defold.git

If this won't work, you can try cloning using Github Desktop.

Linux...

Additional tools

You need additional files and tools to be able to build and work with Defold on Linux:

Development files

  • libxi-dev - X11 Input extension library
  • libxext-dev - X11 Miscellaneous extensions library
  • x11proto-xext-dev - X11 various extension wire protocol
  • freeglut3-dev - OpenGL Utility Toolkit development files
  • libglu1-mesa-dev + libgl1-mesa-dev + mesa-common-dev - Mesa OpenGL development files
  • libcurl4-openssl-dev - Development files and documentation for libcurl
  • uuid-dev - Universally Unique ID library
  • libopenal-dev - Software implementation of the OpenAL audio API
  • libncurses5 - Needed by clang

Tools

  • build-essential - Compilers
  • rpm - package manager for RPM
  • git - Fast, scalable, distributed revision control system
  • curl - Command line tool for transferring data with URL syntax
  • autoconf - Automatic configure script builder
  • libtool - Generic library support script
  • automake - Tool for generating GNU Standards-compliant Makefiles
  • cmake - Cross-platform, open-source make system
  • tofrodos - Converts DOS <-> Unix text files
  • valgrind - Instrumentation framework for building dynamic analysis tools

Download and install using apt-get:

> sudo apt-get install -y --no-install-recommends libssl-dev openssl libtool autoconf automake build-essential uuid-dev libxi-dev libopenal-dev libgl1-mesa-dev libglw1-mesa-dev freeglut3-dev libncurses5

Optional Software

It is recommended but not required that you install the following software:

macOS...

  • wget + curl - for downloading packages (used for downloading packages in different scripts)
  • 7z - for extracting packages (archives and binaries)
  • ccache - for faster compilations of source code (optional)
  • cmake for easier building of external projects
  • patch for easier patching on windows (when building external projects)
  • ripgrep for faster search
  • dos2unix tool to convert line endings of certain source files (e.g. when building files in share/ext)

Quick and easy install:

> brew install wget curl p7zip ccache ripgrep dos2unix

Configure ccache by running (source)

> /usr/local/bin/ccache --max-size=5G

Windows...

  • wget + curl - for downloading packages (used for downloading packages in different scripts)
  • 7z - for extracting packages (archives and binaries)
  • ccache - for faster compilations of source code (optional)
  • cmake for easier building of external projects
  • patch for easier patching on windows (when building external projects)

Quick and easy install:

> pip install cmake patch

Configure ccache by running (source)

> /usr/local/bin/ccache --max-size=5G
  • ripgrep - A very fast text search program (command line)

Open a Command (cmd.exe) as administrator and run:

choco install ripgrep

Linux...

  • wget + curl - for downloading packages (used for downloading packages in different scripts)
  • 7z - for extracting packages (archives and binaries)
  • ccache - for faster compilations of source code (optional)
  • cmake for easier building of external projects
  • patch for easier patching on windows (when building external projects)
  • snapd for installing snap packages
  • ripgrep for faster search

Quick and easy install:

> sudo apt-get install wget curl p7zip ccache

Configure ccache by running (source)

> ccache --max-size=5G

Install snapd package manager:

> sudo apt install snapd

Install ripgrep:

> sudo snap install ripgrep --classic

Optional Setup

Optional Setup - Command Prompt

It's useful to modify your command prompt to show the status of the repo you're in. E.g. it makes it easier to keep the git branches apart.

You do this by editing the PS1 variable. Put it in the recommended config for your system (e.g. .profile or .bashrc) Here's a very small improvement on the default prompt, whic shows you the time of the last command, as well as the current git branch name and its status:

git_branch() {
    git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/(\1)/'
}
acolor() {
  [[ -n $(git status --porcelain=v2 2>/dev/null) ]] && echo 31 || echo 33
}
export PS1='\t \[\033[32m\]\w\[\033[$(acolor)m\] $(git_branch)\[\033[00m\] $ '

WSL (Windows Subsystem for Linux)

Linux...

It is possible to build Linux targets using WSL 1.

Install relevant packages (git, java, python, clang etc) using ./scripts/linux/install_wsl_packages.sh. If also updates your ~/.bashrc with updated paths.

Git clone into a mounted folder

In order to get the proper username of your files, we need to setup WSL for this. Otherwise the git clone won't work in a mounted C: drive folder.

Open (or create) the config file:

sudo nano /etc/wsl.conf

Add these lines:

[automount]
options = "metadata"

And restart your WSL session

X11

The script also sets the DISPLAY=localhost:0.0 which allows you to connect to a local X server.

A popular choice is VCXSRV