Detailed instructions for building on Linux

JoshEngebretson edited this page Jan 11, 2017 · 23 revisions

Introduction

The Atomic Game Engine can be built on Linux for development in JavaScript/TypeScript, C++, and optionally C#. For JavaScript and TypeScript, the built-in Monaco editor can be used as well as external editors. C# support requires Mono and MonoDevelop to be installed.

If you are having any issues, please visit Atomic's dedicated Linux community support forum

1) Installing Mono & MonoDevelop (Optional for C# Support)

If you need C# support, Mono and MonoDevelop must be installed before building the engine as this process also generates the managed AtomicNET assemblies and native runtime. These instructions are for Debian-based distributions. You can skip to step 2 if you are only interested in C++/JS/TS development or want to install Mono at a later time.

Start by adding the Mono Project GPG signing key and the package repository to your system:

# sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF

# echo "deb http://download.mono-project.com/repo/debian wheezy main" | sudo tee /etc/apt/sources.list.d/mono-xamarin.list

# sudo apt-get update

If you're using Ubuntu 13.10/Debian 8.0 or later, you will also need to add the mod_mono and libgdiplus repository to your system:

# echo "deb http://download.mono-project.com/repo/debian wheezy-apache24-compat main" | sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list

# echo "deb http://download.mono-project.com/repo/debian wheezy-libjpeg62-compat main" | sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list

For older Ubuntu releases (12.04 or 12.10), to enable installation, you'll have to add the following repository:

# echo "deb http://download.mono-project.com/repo/debian wheezy-libtiff-compat main" | sudo tee -a /etc/apt/sources.list.d/mono-xamarin.list

Now, run sudo apt-get update. After this, you can install all the packages you need:

# sudo apt-get install referenceassemblies-pcl mono-devel mono-complete monodevelop

2) Building the Atomic Editor

Please follow these instructions to build the Atomic Editor and other binaries to the /Artifacts/AtomicEditor folder. Once built, the editor can be started from this folder.

3) Getting Started with the Atomic Game Engine

Looking for help getting started? Please see these help topics, visit the Atomic Community site, or join us in the Atomic Gitter Chat.