Home

Welcome to the Sapphire wiki!

1. What is Sapphire?
2. Is it stable?
3. Is it secure?
4. Can I run my own server?
5. How do I install it?
6. How can I contribute?
7. How can I get help?

What is Sapphire?

Sapphire is a research implementation of the Final Fantasy XIV Online server. The purpose of Sapphire is to gain an understanding of how retail game servers work. The current focus is on understanding the network layer and how the server controls actors in the retail client.

Is it stable?

No, Sapphire is currently under heavy development. Unexpected crashes, unimplemented or inconsistent features, and data corruption are known issues. Since the retail server is constantly evolving, so too must Sapphire to keep working with the current retail client.

Is it secure?

No, Sapphire has minimal encryption and security features for the database. Make sure all account credentials you use are throwaways.

Can I run my own server?

Yes, you can run Sapphire locally or on a hosted server, however be aware of the security and stability issues before your expose the server to anyone else. Note that many features are not yet implemented, so please don't think of Sapphire as a replacement for FFXIV retail.

How do I install it?

Sapphire must be compiled from source code. If you are not familiar with C++ project compilation, it is recommended you do not attempt this without studying up on software development. Sapphire is a complex project with non-trivial 3rd party dependencies that require a basic understanding of the software build process. You should understand package management and how to setup a development environment, plus version control systems (specifically, git) before proceeding.

If you are comfortable setting up a development environment and building a project, please see Installation in the sidebar to the right. They are not particularly user friendly as Sapphire is not currently ready for public use.

How can I contribute?

Pull requests to Sapphire are welcome. Please see documentation on the sidebar to the right, as well as the code contributors guide. Testing and debugging can also be of great help, so you don't need to know C++ to contribute. To get in touch, reach out to us on Discord.

How can I get help?

For bug reports, please see GitHub Issues. You can also discuss problems in the #troubleshooting channel on Discord.

What client version do I need/How do I get the correct client version?

We are not allowed to distribute the FFXIV client or any related content.

For 3.x branches such as ThreePointThree, we provide a list of patch names that we target for development and use.