Skip to content
Adam edited this page Aug 17, 2021 · 8 revisions

Installing Sapphire on Linux

This document expects you to have a development environment for Linux setup.

  1. Setup
  2. Download
  3. Build
  4. Configure

Setup

You will need to install build and runtime dependencies before compiling, please see below for your specific distribution.

CentOS/RHEL/Fedora

If you don't already have a development environment setup, run the following:

yum groupinstall -y development

Install development headers and tools:

yum install -y cmake git libmariadb-devel zlib-devel

After installing all dependencies, you can proceed to download, build, and configure.

Care must be taken when considering versioning for libraries, especially in rolling release distros such as Arch Linux, in which you must take extra steps to make sure you're targeting the correct version.

Debian/Ubuntu

If you don't already have a development environment setup, run the following:

apt install -y build-essential

Install development headers and tools:

apt install cmake git libmariadb-dev zlib1g-dev

After installing all dependencies, you can proceed to download, build, and configure.

Archlinux

If you don't already have a development environment setup, run the following:

pacman -Sy --needed base-devel

Install development headers and tools:

pacman -Sy cmake git libmariadbclient

After installing all dependencies, you can proceed to download, build, and configure.

Download

git clone --recursive https://github.com/SapphireServer/Sapphire.git sapphire

#required for current client version. Otherwise checkout the appropriate version for your client
git checkout develop 

Build

mkdir build && cd build
cmake ..
make -j 4

Configure

The build will output the binaries into bin/ in the folder you invoke cmake from, along with a nested subdirectory for config files. You will need the game data files plus a running MySQL DB to point the binaries at. You can then run the servers as normal processes.

FFXIV Sapphire

Deprecated (4.0~5.58)

Getting Started
About
Installation

Installing
Linux
Mac
Windows

Developing
Actor Control
Scripting

Administration
Debug Commands
GM Commands

Other
PS4 Support

Clone this wiki locally