Skip to content

Commit

Permalink
add wiki to readme; update readme;
Browse files Browse the repository at this point in the history
  • Loading branch information
hkAlice committed Feb 4, 2023
1 parent 587844f commit 29f8a86
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,44 @@
</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/)
[![Linux Build Status](https://api.travis-ci.org/SapphireServer/Sapphire.svg?branch=master)](https://travis-ci.org/SapphireServer/Sapphire)
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/lil7lxa3ty165emm?svg=true)](https://ci.appveyor.com/project/SapphireMordred/Sapphire)


Sapphire is a FINAL FANTASY XIV Server Emulator currently in development.
This branch is specifically for version 3.0.
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).

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 (of course contributions are always welcome).
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 2017](https://www.visualstudio.com/) | `gcc 7` and `g++ 7` or newer |
| MySQL Server 5.7 | [Official Site](https://dev.mysql.com/downloads/mysql/) | MySQL server from your distribution's package manager |
| 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](https://github.com/SapphireMordred/Sapphire/wiki) for detailed installation/build instructions for your OS.
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-2018 SQUARE ENIX CO., LTD. All Rights Reserved. We are not affiliated with SQUARE ENIX CO., LTD. in any way.
Final Fantasy XIV © 2010-2023 SQUARE ENIX CO., LTD. All Rights Reserved. We are not affiliated with SQUARE ENIX CO., LTD. in any way.

0 comments on commit 29f8a86

Please sign in to comment.