INSTALL.md

Installation

Table of contents

• Platforms
• Get the source code
• Dependencies
  • Linux dependencies
  • Windows dependencies
  • MacOS dependencies
• Compiling
  • Linux details
  • Windows details
  • MacOS details
• Installing

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:

• CMake (3.4 or greater)
• Ninja
• Msys2 (Windows only)

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

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 libpixman-1-dev libpng-dev libsdl2-dev libsdl2-image-dev libtinyxml2-dev libnode-dev ninja-build zlib1g-dev libarchive-dev

Fedora:

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

Windows dependencies

To install the required dependencies with msys2, run the following in mingw32:

pacman -S base-devel mingw-w64-i686-gcc mingw-w64-i686-cmake mingw-w64-i686-make mingw-w64-i686-curl mingw-w64-i686-freetype mingw-w64-i686-giflib mingw-w64-i686-libjpeg-turbo mingw-w64-i686-libpng mingw-w64-i686-libwebp mingw-w64-i686-pixman mingw-w64-i686-SDL2 mingw-w64-i686-SDL2_image mingw-w64-i686-tinyxml2 mingw-w64-i686-v8 mingw-w64-i686-zlib mingw-w64-i686-libarchive

MacOS dependencies

On MacOS you will need Mac OS X 11.0 SDK and the corresponding Xcode. In a terminal, install the dependencies using brew:

brew install gnutls freetype jpeg googletest pixman sdl2 sdl2_image tinyxml2 libarchive ninja zlib xmlto dylibbundler

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

Windows details

Run the following in mingw32.exe:

cmake -G Ninja ..

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