# Sapphire - FINAL FANTASY XIV Server Emulator

<p align="center">
  <img src="https://i.imgur.com/I4bj1tR.png" alt="FFXIV Sapphire"/>
</p>

[![Discord Server](https://img.shields.io/badge/discord-Sapphire-7289DA.svg)](https://discord.gg/xxcdCER)
[![Sapphire Wiki](https://img.shields.io/badge/wiki-xiv.dev-blue)](https://sapphire.xiv.dev/)
[![Build Status](https://github.com/SapphireServer/Sapphire/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/SapphireServer/Sapphire/actions/workflows/build.yml)

Sapphire is a FINAL FANTASY XIV Server Emulator currently in development.
This branch is specifically for FFXIV version 3.3.

It is a **research project** to learn how retail servers work and currently not production code; at this time it is **insecure** (use throwaway passwords for accounts) and you should expect a lot of things unimplemented or broken.

Contributions are always welcome.

## Instructions, guides and tips
We provide a wiki with all sorts of information such as details, how to get started, contributing, command lists and development resources in our wiki.

[Sapphire Wiki](https://sapphire.xiv.dev/)

## Client Version
This branch currently targets FFXIV 3.3.

Game: 2016.07.05.0000.0001
EX1: 2016.05.21.0000.0001

A full list of patch names can be seen in the [wiki/Patch list](https://sapphire.xiv.dev/resources/patch-list).

We are not allowed to distribute the FFXIV client or any related content. Please do not ask for links or binaries related to FFXIV or Square Enix copyrighted content.

## Dependencies + Compiling
Sapphire requires the following software:

| *Name* | *Windows* | *Linux* |
| ------ | --------- | ------- |
| CMake 3.0.2+ and C++17 capable compiler | [Visual Studio 2022](https://www.visualstudio.com/) | `gcc 7` and `g++ 7` or newer |
| MySQL Server 5.7 | [MariaDB 10.7 (x64)](https://mariadb.org/download/) | MySQL server from your distribution's package manager |

Please check the [wiki/Getting Started](https://sapphire.xiv.dev/getting-started/overview) for detailed installation/build instructions for your OS.

## Links

* [Sapphire on YouTube](https://www.youtube.com/channel/UCJKYuovoGsq7PxSAfrNJKbw)

Final Fantasy XIV © 2010-2023 SQUARE ENIX CO., LTD. All Rights Reserved. We are not affiliated with SQUARE ENIX CO., LTD. in any way.