Skip to content

Latest commit

 

History

History
152 lines (100 loc) · 4.64 KB

INSTALL.md

File metadata and controls

152 lines (100 loc) · 4.64 KB
Raw

Installation

Table of contents

Platforms

You can download installers from the website. If you want to compile LibreSprite from source, continue reading.

You should be able to compile LibreSprite on the following platforms:

  • Windows 10 + VS2015 Community Edition + Windows 10 SDK
  • Mac OS X 11.0 Big Sur + Xcode 7.3 + OS X 11.0 SDK
  • Linux + GCC 8.5 or higher with C++14 support

To compile LibreSprite you will need:

Get the source code

Clone the repository and its submodules using the following command:

git clone --recursive https://github.com/LibreSprite/LibreSprite

(You can use Git for Windows to clone the repository on Windows.)

To update an existing clone, use the following commands:

cd LibreSprite
git pull
git submodule update --init --recursive

Backends

LibreSprite can be compiled with two different backends:

  1. SDL2 backend (WIP)
  2. Allegro backend (deprecated) (Windows and Linux only)

Dependencies

You'll need the following dependencies to compile LibreSprite:

Linux dependencies

Debian/Ubuntu:

sudo apt-get install cmake g++ libcurl4-gnutls-dev libfreetype6-dev libgif-dev libgtest-dev libjpeg-dev liblua5.4-dev libpixman-1-dev libpng-dev libsdl2-dev libsdl2-image-dev libtinyxml-dev libnode-dev ninja-build zlib1g-dev

Fedora:

sudo dnf install g++ cmake libcurl-devel freetype-devel giflib-devel gtest-devel libjpeg-devel lua-devel pixman-devel libpng-devel SDL2-devel SDL2_image-devel tinyxml-devel zlib-devel ninja-build nodejs-devel

Windows dependencies

To install the required dependencies with vcpkg, run:

vcpkg install curl freetype giflib gtest libjpeg-turbo lua libpng libwebp pixman sdl2 sdl2-image tinyxml v8 zlib --triplet x64-windows

Beware: --triplet x64-windows is only necessary for a 64 architecture build.

MacOS dependencies

On MacOS you will need Mac OS X 11.0 SDK and Xcode 7.3 (older versions might work).

Compiling

First, create the build directory with the following commands:

cd LibreSprite
mkdir build
cd build

Then following the platform-specific instructions for compiling below.

The build directory will contain the results of the compilation process. If you want to build a fresh copy of LibreSprite, remove the build directory and recompile.

Linux details

To compile LibreSprite, run the following commands:

cmake -G Ninja ..
ninja libresprite

To compile the legacy Allegro backend, run cmake with the flags -DUSE_SDL2_BACKEND=off -DUSE_ALLEG4_BACKEND=on.

The repository contains a patched version of the Allegro 4 library. If you want to use your installed version of Allegro, run cmake with the flag -DUSE_SHARED_ALLEGRO4=ON. However, this is not recommended due to issues with Allegro 4.4 (1) (2).

Windows details

If you're using a command prompt and aiming for a x64 build, be sure to use the x64 prompt or it won't find vcpkg libraries.

To compile LibreSprite, run the following commands:

cmake ^
  -DCMAKE_TOOLCHAIN_FILE=put_your_vcpkg_path_here\vcpkg\scripts\buildsystems\vcpkg.cmake ^
  -G Ninja ^
  ..

To compile the legacy Allegro backend, run cmake with the flags -DUSE_SDL2_BACKEND=off -DUSE_ALLEG4_BACKEND=on.

The repository contains a patched version of the Allegro 4 library. If you want to use your installed version of Allegro, run cmake with the flag -DUSE_SHARED_ALLEGRO4=on.

MacOS details

To compile LibreSprite, run the following commands:

cmake \
  -DCMAKE_OSX_ARCHITECTURES=x86_64 \
  -DCMAKE_OSX_DEPLOYMENT_TARGET=10.7 \
  -DCMAKE_OSX_SYSROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.0.sdk \
  -G Ninja \
  ..
ninja libresprite

Installing

Once you've finished compiling, you can install LibreSprite by running the following command from the build directory:

ninja install