Skip to content

Installation

Skyler edited this page Aug 30, 2017 · 4 revisions

This guide is a quick run through on how to setup Maelstrom.

Building

Note: Make sure you restore git sub modules before attempting to build.

The build process for Maelstrom is straightforward, with the solution loaded in Visual Studio you only need to restore the NuGet packages and build the solution.
All projects are built into the same output folder bin in the root directory of the solution file.

Database

The database layout for Maelstrom revolves around 3 separate databases, the authentication, datacentre and world.
The authentication database includes all account and service account information, the datacentre database includes all character information for realms in the datacentre and finally the world database includes static information shared by the world servers such as NPC spawns.

You want to execute the 3 base SQL files found in ...\sql\base of your Maelstrom repository folder on 3 separate databases, by default these are maelstrom_authentication, maelstrom_datacentre and maelstrom_world.
With the base files executed you now need to execute all the SQL files found in the ...sql\updates on the respective database.

Configuration Files

In the build folder of Maelstrom you'll find 2 JSON files, LobbyConfig.example.json and WorldConfig.example.json, copy these files and remove the .example extension.
Update the MySQL information in both these configuration files to match the 3 databases created earlier.
Update the AssetPath to the root installation directory of FFXIV (folder with the boot and game folders).

With this information set correctly both the lobby and world servers should start successfully.

Account Creation

In order to login to the server you'll need to create an account and associated service account, this can be achieved from the lobby server console.

To create the account you can use the account_create command which takes 2 parameters of a username and password.
Once you create the account you need to assign a service account, you can use the account_service_create command which takes 2 parameters of accountId and name.
By default the first account created is assigned id 1, the name is the string shown in the service account list on login, retail sets this to FINAL FANTASY XIV 1-8, a single account can be assigned up to 8 service accounts.

Login

With the account and service account created you can now launch the client with this account.
Launch either ffxiv.exe or ffxiv_dx11.exe directly with the parameters below making sure to change the DEV.TestSID value to your newly created accounts username.

DEV.TestSID=username SYS.Region=0 language=1 DEV.MaxEntitledExpansionID=2 DEV.LobbyHost01=127.0.0.1 DEV.LobbyPort01=54994 DEV.LobbyHost02=127.0.0.1 DEV.LobbyPort02=54994 DEV.LobbyHost03=127.0.0.1 DEV.LobbyPort03=54994 DEV.LobbyHost04=127.0.0.1 DEV.LobbyPort04=54994 DEV.LobbyHost05=127.0.0.1 DEV.LobbyPort05=54994 DEV.LobbyHost06=127.0.0.1 DEV.LobbyPort06=54994  

NOTE: Due to lack of a launcher accounts are only logged in with the username, this will change in the future.

Once you reach the main menu, make sure you have both the lobby and world servers running and select any of the data centres to login.

Clone this wiki locally