FFXIV Classic Wiki - User contributions [en]

Main Page

2021-03-24T19:36:00Z

Unnamed mercenary:

__NOTOC__
'''Welcome to the Project Meteor Wiki'''

:This wiki contains information on the various components of FFXIV 1.0. <br/>
:You can also find a guide on how to build and run the Project Meteor Server yourself and host what has been developed so far.

'''THIS PROJECT IS NOT FEATURE-COMPLETE'''
:Project Meteor is in early development. Many server-side features still need to be developed '''and no content is scripted'''.
:Do not expect this to fully replicate the Final Fantasy XIV 1.23 experience.

'''THIS PROJECT IS ALSO NOT A PRIVATE SERVER'''
:This is a server '''software''' project.
:There are no plans to host a running server for people to connect to. You need to do that yourself.

== Getting started ==
<div style="float:left; width:300px">
*[[Setting up the project]]
*[[Feature Status]]
*[[FAQs]]

*[[Debug Commands|Debug Commands]]
*[[Utilities | Useful Utilities]]
*[[Points of interest]]
</div>

<div style="float:left; width:600px">
::{| class="wikitable"
|+ Important Links
|- style="font-size: 20px;"

| Source Code: [https://bitbucket.org/Ioncannon/project-meteor-server Project Meteor Server]
|}
</div>
{{clear}}

== Game Engine Specifications ==
<div style="float:left; width:200px;">
=== Game Data ===
*[[Regions | Region IDs]]
*[[Weather | Weather IDs]]
*[[Music | Music IDs]]
*[[Quest_Scripts | Quest IDs ]]
*[[Monster_Models | Monster Models]]
*[[BgObj_Models | Background Object Models]]
*[[Populace_Animation | NPC Animation IDs]]
*[[Unofficial_Additions | Unofficial additions]]
*[[Dungeons]]
</div>

<div style="float:left; width:200px;">

=== Game Protocol ===
*[[Packet Headers]]
*[[Game Opcodes]]
*[[Math Formula]]
*[[Server Flow]]
*[[Retail Patcher and Login]]
*[[ZiPatch File Structure]]
</div>

<div style="float:left; width:200px;">

=== Actor System ===
*[[Actor System | Understanding the actor system]]
*[[NPC Actors]]
*[[Event System]]
*[[Animations and VFX]]
</div>

Main Page

2020-06-27T20:56:40Z

Unnamed mercenary: Make something harder to find

__NOTOC__
'''Welcome to the Project Meteor Wiki'''

:This wiki contains information on the various components of FFXIV 1.0. <br/>
:You can also find a guide on how to build and run the Project Meteor Server yourself and host what has been developed so far.

== Getting started ==
<div style="float:left; width:300px">
*[[Setting up the project]]
*[[Feature Status]]
*[[FAQs]]

*[[Debug Commands|Debug Commands]]
*[[Utilities | Useful Utilities]]
*[[Points of interest]]
</div>

<div style="float:left; width:600px">
::{| class="wikitable"
|+ Important Links
|- style="font-size: 20px;"

| Source Code: [https://bitbucket.org/Ioncannon/project-meteor-server Project Meteor Server]
|}
</div>
{{clear}}

== Game Engine Specifications ==
<div style="float:left; width:200px;">
=== Game Data ===
*[[Regions | Region IDs]]
*[[Weather | Weather IDs]]
*[[Music | Music IDs]]
*[[Quest_Scripts | Quest IDs ]]
*[[Monster_Models | Monster Models]]
*[[BgObj_Models | Background Object Models]]
*[[Populace_Animation | NPC Animation IDs]]
*[[Unofficial_Additions | Unofficial additions]]
*[[Dungeons]]
</div>

<div style="float:left; width:200px;">

=== Game Protocol ===
*[[Packet Headers]]
*[[Game Opcodes]]
*[[Math Formula]]
*[[Server Flow]]
*[[Retail Patcher and Login]]
*[[ZiPatch File Structure]]
</div>

<div style="float:left; width:200px;">

=== Actor System ===
*[[Actor System | Understanding the actor system]]
*[[NPC Actors]]
*[[Event System]]
*[[Animations and VFX]]
</div>

Setting up the project

2020-06-18T17:46:30Z

Unnamed mercenary:

<div style="float:right;">__TOC__</div>
:''Updated as of commit 18ef69f (2019-06-19)''

== '''NOTICE''' ==
This is for setting up a server for the '''FINAL FANTASY XIV v1.23b''' client, the original iteration of the game.

The '''FINAL FANTASY XIV: A REALM REBORN''' client is '''not''' compatible with this project.

== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Project Meteor Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Project Meteor Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Project Meteor Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Project Meteor Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 10
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 7
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.3
| style="background: green; color: white; text-align: center;" | Officially supported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/project-meteor-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/project-meteor-server Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''Meteor.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'Meteor' (4 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 4 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Project Meteor Server source code location>\data\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy all of the '''data/www/login_su''' folder contents from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Project Meteor Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server <br /><br />
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\''' <br />
# Copy '''map_config.ini''', '''staticactors.bin''' and the <span style="font-size:150%">'''scripts'''</span> folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\''' <br />
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''<br />

<span style="font-size:300%">Do not skip step 3 for the love of our sanity.</span>

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Project Meteor Server source code location>\data\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Project Meteor Server source location>\data\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Project Meteor Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
: 1. Confirm all WAMP/web services are running
: 2. Run the lobby server: '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\Lobby Server.exe'''
: 3. Run the map server: '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\Map Server.exe'''
: 4. Run the map server: '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\World Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2020-06-18T17:46:17Z

Unnamed mercenary:

<div style="float:right;">__TOC__</div>
:''Updated as of commit 18ef69f (2019-06-19)''

== '''NOTICE''' ==
This is for setting up a server for the '''FINAL FANTASY XIV v1.23b''' client, the original iteration of the game.

The '''FINAL FANTASY XIV: A REALM REBORN''' client is '''not''' compatible with this project.

== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Project Meteor Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Project Meteor Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Project Meteor Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Project Meteor Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 10
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 7
| style="background: yellow; color: white; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.3
| style="background: green; color: white; text-align: center;" | Officially supported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/project-meteor-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/project-meteor-server Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''Meteor.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'Meteor' (4 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 4 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Project Meteor Server source code location>\data\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy all of the '''data/www/login_su''' folder contents from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Project Meteor Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server <br /><br />
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\''' <br />
# Copy '''map_config.ini''', '''staticactors.bin''' and the <span style="font-size:150%">'''scripts'''</span> folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\''' <br />
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''<br />

<span style="font-size:300%">Do not skip step 3 for the love of our sanity.</span>

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Project Meteor Server source code location>\data\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Project Meteor Server source location>\data\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Project Meteor Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
: 1. Confirm all WAMP/web services are running
: 2. Run the lobby server: '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\Lobby Server.exe'''
: 3. Run the map server: '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\Map Server.exe'''
: 4. Run the map server: '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\World Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2020-06-18T17:45:44Z

Unnamed mercenary: Mark MariaDB as officially supported because that's the WAMP default now

<div style="float:right;">__TOC__</div>
:''Updated as of commit 18ef69f (2019-06-19)''

== '''NOTICE''' ==
This is for setting up a server for the '''FINAL FANTASY XIV v1.23b''' client, the original iteration of the game.

The '''FINAL FANTASY XIV: A REALM REBORN''' client is '''not''' compatible with this project.

== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Project Meteor Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Project Meteor Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Project Meteor Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Project Meteor Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 10
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 7
| style="background: yellow; color: white; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.3
| style="background: green; color: black; text-align: center;" | Officially supported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/project-meteor-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/project-meteor-server Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''Meteor.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'Meteor' (4 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 4 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Project Meteor Server source code location>\data\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy all of the '''data/www/login_su''' folder contents from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Project Meteor Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server <br /><br />
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\''' <br />
# Copy '''map_config.ini''', '''staticactors.bin''' and the <span style="font-size:150%">'''scripts'''</span> folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\''' <br />
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''<br />

<span style="font-size:300%">Do not skip step 3 for the love of our sanity.</span>

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Project Meteor Server source code location>\data\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Project Meteor Server source location>\data\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Project Meteor Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
: 1. Confirm all WAMP/web services are running
: 2. Run the lobby server: '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\Lobby Server.exe'''
: 3. Run the map server: '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\Map Server.exe'''
: 4. Run the map server: '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\World Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2020-06-18T17:44:35Z

Unnamed mercenary: Removed info on specific windows 10 builds. Windows 7 is EOL and End of Support

<div style="float:right;">__TOC__</div>
:''Updated as of commit 18ef69f (2019-06-19)''

== '''NOTICE''' ==
This is for setting up a server for the '''FINAL FANTASY XIV v1.23b''' client, the original iteration of the game.

The '''FINAL FANTASY XIV: A REALM REBORN''' client is '''not''' compatible with this project.

== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Project Meteor Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Project Meteor Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Project Meteor Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Project Meteor Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 10
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/project-meteor-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/project-meteor-server Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''Meteor.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'Meteor' (4 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 4 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Project Meteor Server source code location>\data\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy all of the '''data/www/login_su''' folder contents from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Project Meteor Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server <br /><br />
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\''' <br />
# Copy '''map_config.ini''', '''staticactors.bin''' and the <span style="font-size:150%">'''scripts'''</span> folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\''' <br />
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/''' <br />
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''<br />

<span style="font-size:300%">Do not skip step 3 for the love of our sanity.</span>

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Project Meteor Server source code location>\data\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Project Meteor Server source location>\data\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Project Meteor Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Project Meteor Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Project Meteor Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Project Meteor Server source location>/data/'''
#: to '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
: 1. Confirm all WAMP/web services are running
: 2. Run the lobby server: '''<Project Meteor Server source location>\Lobby Server\bin\(Debug\Release)\Lobby Server.exe'''
: 3. Run the map server: '''<Project Meteor Server source location>\Map Server\bin\(Debug\Release)\Map Server.exe'''
: 4. Run the map server: '''<Project Meteor Server source location>\World Server\bin\(Debug\Release)\World Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Debug Commands

2019-08-26T13:52:35Z

Unnamed mercenary: Added links to graphics docs by Kyne and Paru

<div style="float:right;">__TOC__</div>
:''Updated as of commit 38014f8(2016-08-19)''

The following commands are available as part of the Project Meteor Server. <br/> They can be used by typing their usage examples into the chat box within the game.

== Standard commands ==
=== help ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | help
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Prints out a list of available commands
|-
! rowspan="2" | Usage
|align="left"| !help
|-
|align="left"| !help <command>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <command>
| Brings up the help description for the given command
|}

=== mypos ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | mypos
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Prints out your absolute location in the current region
|-
! Usage
| align="left" | !mypos
|}

=== music ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | music
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Plays music <id> to player
|-
! Usage
|align="left"| !music <id>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <id>
| Plays the music defined at <id>. Refer to [[Music]] for a list of IDs
|}

=== warp ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | warp
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Warp to a location from a list, or enter a <zone> with coordinates <x> <y> <z>
|-
! rowspan="3" | Usage
|align="left"| !warp <spawn list>
|-
|align="left"| !warp <zone> <x> <y> <z>
|-
|align="left"| !warp <zone> <x> <y> <z> <privateArea> <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px; | <spawn list>
| The ID from the list of locations as defined in server_zones_spawnlocations in the database
|-
! style="width:200px; | <zone>
| Value of the zone to head to. Refer to [[Regions]] for the list of zone IDs
|-
! style="width:200px; | <X>
| X Position
|-
! style="width:200px; | <Y>
| Y Position
|-
! style="width:200px; | <Z>
| Z Position
|-
! style="width:200px; | <privateArea>
| Warp into a defined private area of a given zone ID
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== nudge ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | nudge
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Positions your character forward a set <distance>, defaults to 5 units
|-
! rowspan="3" | Usage
|align="left"| !nudge
|-
|align="left"| !nudge <distance>
|-
|align="left"| !nudge <distance> <up/down>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <distance>
| The amount of units to move forward
|-
! style="width:200px;| <up/down>
| Nudge vertically instead. Up, U, or +, for moving up. Down, D, or -, for moving down
|}

=== speed ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | speed
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Set movement speed for player. Enter no value to reset to default
|-
! rowspan="3" | Usage
|align="left"| !speed
|-
|align="left"| !speed <run>
|-
|align="left"| !speed <stop> <walk> <run>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <stop>
| Stationary speed (does nothing for players)
|-
! style="width:200px;| <walk>
| Walking speed
|-
! style="width:200px;| <run>
| Running speed
|}

== Server Administration commands ==
=== giveitem ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | giveitem
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Adds <item> <qty> to <location> for player or <targetname>
|-
! rowspan="3" | Usage
|align="left"| !giveitem <item> <qty>
|-
|align="left"| !giveitem <item> <qty> <location>
|-
|align="left"| !giveitem <item> <qty> <location> <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <item>
| Item ID to give, as defined in xtx_itemName
|-
! style="width:200px;| <qty>
| Quantity of item to add
|-
! style="width:200px;| <location>
| Inventory location to go into (eg, Bag, Key Item, Loot, Currency) as defined in global.lua from the scripts folder. <br/> Defaults to INVENTORY_COMMON
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== givegil ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | givegil
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Adds gil <qty> to player or <targetname>
|-
! rowspan="2" | Usage
|align="left"| !givegil <qty>
|-
|align="left"| !givegil <qty> <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <qty>
| Quantity of gil to add
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== givecurrency ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | givecurrency
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Adds <item> to currency by amount <qty> to player or <targetname>
|-
! rowspan="2" | Usage
|align="left"| !givecurrency <item> <qty>
|-
|align="left"| !givecurrency <item> <qty> <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <item>
| Item ID to give, as defined in xtx_itemName
|-
! style="width:200px;| <qty>
| Quantity of item to add
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== givekeyitem ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | givekeyitem
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Adds <keyitem> to player or <targetname>
|-
! rowspan="2" | Usage
|align="left"| !giveitem <keyitem>
|-
|align="left"| !giveitem <keyitem> <target name>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <keyitem>
| Item ID to give, as defined in xtx_itemName
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== delitem ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | delitem
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Removes <item> <qty> from <location> for player or <targetname>
|-
! rowspan="3" | Usage
|align="left"| !delitem <item> <qty>
|-
|align="left"| !delitem <item> <qty> <location>
|-
|align="left"| !delitem <item> <qty> <location> <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <item>
| Item ID to remove, as defined in xtx_itemName
|-
! style="width:200px;| <qty>
| Quantity of item to remove
|-
! style="width:200px;| <location>
| Inventory location to remove from (eg, Bag, Key Item, Loot, Currency) as defined in global.lua from the scripts folder. <br/> Defaults to INVENTORY_COMMON
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== delcurrency ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | delcurrency
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Removes currency <qty> from player or <targetname>
|-
! rowspan="2" | Usage
|align="left"| !delcurrency <item> <qty>
|-
|align="left"| !delcurrency <item> <qty> <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <item>
| Item ID to give, as defined in xtx_itemName
|-
! style="width:200px;| <qty>
| Quantity of item to add
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== delkeyitem ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | delkeyitem
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Removes <keyitem> from player or <targetname>
|-
! rowspan="2" | Usage
|align="left"| !delkeyitem <keyitem>
|-
|align="left"| !delkeyitem <keyitem> <target name>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <keyitem>
| Item ID to remove, as defined in xtx_itemName
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== weather ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | weather
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Change the weather client-side to <id> and optional <transition> for player
|-
! rowspan="3" | Usage
|align="left"| !weather <id>
|-
|align="left"| !weather <id> <transition>
|-
|align="left"| !weather <id> <transition> <zonewide>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <id>
| Changes to the weather defined at <id>. Refer to [[Weather ]] for a list of IDs
|-
! style="width:200px;| <transition>
| Fades from the current weather effect to the next one, in seconds
|-
! style="width:200px;| <zonewide>
| Sets the weather change to every player within the same zone
|}

== Debug commands==

=== endevent ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | endevent
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Passes endEvent() to player or <targetname> to close a script
|-
! rowspan="2" | Usage
|align="left"| !endevent
|-
|align="left"| !endevent <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}

=== sendpacket ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | sendpacket
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Sends a custom <packet> to player or <targetname>
|-
! rowspan="2" | Usage
|align="left"| !sendpacket <packet>
|-
|align="left"| !sendpacket <packet> <targetname>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <packet>
| Filename of the packet to look for from within a folder named <code>packets</code> in the Map Server directory
|-
! style="width:200px; | <targetname>
| Name of player to select remotely. Two words, firstname & lastname, separated by a space
|}
=== graphic ===
{|class="wikitable"
! scope="col" style="width:200px; padding:1em; background:#E0CEF2; solid ##CEF2EC; margin:auto;" | graphic
| scope="col" style="width:500px; padding:1em; background:#CEE0F2; solid ##CEF2EC; text-align:center;" | Changes appearance for equipment with given parameters
|-
! Usage
|align="left"| !graphic <slot> <wID> <eID> <vID> <cID>
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
! colspan="2" style="width:700px; background:#CEF2E0; border:#A3BFB1; padding-left:2em; padding-right:2em; | Parameters
|-
! style="width:200px;| <slot>
| Slot type
|-
! style="width:200px;| <wID>
| Weapon type
|-
! style="width:200px;| <eID>
| Equipment type
|-
! style="width:200px;| <vID>
| Variant type
|-
! style="width:200px;| <cID>
| Color type
|}

{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" |Parameter Breakdown
| align="center" style="background:#f0f0f0;"|'''slot'''
| align="center" style="background:#f0f0f0;"|'''weaponID'''
| align="center" style="background:#f0f0f0;"|'''equipID'''
| align="center" style="background:#f0f0f0;"|'''variantID'''
| align="center" style="background:#f0f0f0;"|'''colorID'''
|-
| 0 - ???||???||Height?||???||???
|-
| 1 – Colors||EyeColor||HairColor||SkinColor||??
|-
| 2 – Head?||???||FaceType/Eyes||FacialFeatures||???
|-
| 3 – Hair||???||HairStyle||Highlight||???
|-
| 4 - ???||||||||
|-
| 5 - MainHand ||Model||SubType||Variant||Color Where Applicable
|-
| 6 - OffHand ||Model||SubType||Variant||Color Where Applicable
|-
| 7 - Special Mainhand||Model||SubType||Variant||Color Where Applicable
|-
| 8 - Special Offhand||Model||SubType||Variant||Color Where Applicable
|-
| 9 - Throwing||Model||SubType||Variant||Color Where Applicable
|-
| 10 - Pack||Model||SubType||Variant||Color Where Applicable
|-
| 11 - Pouch||Model||SubType||Variant||Color Where Applicable
|-
| 12 - Head||???||Model||Variant||Color Where Applicable
|-
| 13 - Body||???||Model||Variant||Color Where Applicable
|-
| 14 - Legs||???||Model||Variant||Color Where Applicable
|-
| 15 - Hands||???||Model||Variant||Color Where Applicable
|-
| 16 - Feet||???||Model||Variant||Color Where Applicable
|-
| 17 - Belt||???||Model||Variant||
|-
| 18 - Neck||???||Model||???||???
|-
| 19 - Right Ear||???||Model||???||???
|-
| 20 - Left Ear||???||Model||???||???
|-
| 21 - Right Wrist||???||Model||???||???
|-
| 22 - Left Wrist||???||Model||???||???
|-
| 23 - Right Ring #1||???||Model||???||???
|-
| 24 - Left Ring #1||???||Model||???||???
|-
| 25 - Right Ring #2||???||Model||???||???
|-
| 26 - Left Ring #2||???||Model||???||???
|-
| 27 - ???||||||||

|}

*Warning: Improper weapon combinations/objects placed in slots 5 and/or 6 can crash the game. Ex. Dual-wielding swords.

[https://docs.google.com/spreadsheets/d/1VPLeavtXps31guP0ADXTsTTjX4eMK-VwrvDug7kHVso/edit#gid=370822967 Kyne's list of IDs]
[https://docs.google.com/document/d/1DJq3fp-3omlZ4Bsejd5tPhAb3ZvYczdVpSZO4QGWG3Y/edit?usp=sharing Paru's list of IDs]

Points of interest

2019-06-19T19:12:33Z

Unnamed mercenary:

<div style="float:right;">__TOC__</div>
== Towns ==
=== Limsa Lominsa ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Adventurers' Guild
|align="right"| 133
|align="right"| -466
|align="right"| 40
|align="right"| 200
|-
| Musketeers' Guild
|align="right"| 230
|align="right"| -600
|align="right"| 42
|align="right"| -50
|-
| Arcanists' Guild
|align="right"| 230
|align="right"| -786
|align="right"| 12
|align="right"| 217
|-
| Marauders' Guild
|align="right"| 230
|align="right"| -753
|align="right"| 8
|align="right"| 370
|-
| Culinairians' Guild
|align="right"| 230
|align="right"| -502
|align="right"| 44
|align="right"| 47
|-
| Fishermens' Guild
|align="right"| 230
|align="right"| -624
|align="right"| 4
|align="right"| 361
|-
| Blacksmiths' Guild
Armorers' Guild
|align="right"| 230
|align="right"| -487
|align="right"| 42
|align="right"| 425
|-
| Airship Landing
|align="right"| 230
|align="right"| -460
|align="right"| 91
|align="right"| 177
|-
| Ferry Docks
|align="right"| 230
|align="right"| -856
|align="right"| 4
|align="right"| 238
|}

=== Gridania ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Adventurers' Guild
|align="right"| 155
|align="right"| 69
|align="right"| 4
|align="right"| -1208
|-
| Archers' Guild
|align="right"| 206
|align="right"| 228
|align="right"| 12
|align="right"| -1268
|-
| Conjurers' Guild
|align="right"| 206
|align="right"| -334
|align="right"| 8
|align="right"| -1678
|-
| Lancers' Guild
|align="right"| 206
|align="right"| 175
|align="right"| 27
|align="right"| -1580
|-
| Carpenters' Guild
|align="right"| 206
|align="right"| 18
|align="right"| 9
|align="right"| -1265
|-
| Leatherworkers' Guild
|align="right"| 206
|align="right"| 91
|align="right"| 20
|align="right"| -1455
|-
| Botanists' Guild
|align="right"| 206
|align="right"| -206
|align="right"| 20
|align="right"| -1460
|-
| The Lotus Stand
|align="right"| 155
|align="right"| 25
|align="right"| 10
|align="right"| -2140
|-
| Airship Landing
|align="right"| 155
|align="right"| 60
|align="right"| -7
|align="right"| -1212
|}

=== Ul'dah ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Adventurers' Guild
|align="right"| 175
|align="right"| -65
|align="right"| 196
|align="right"| 47
|-
| Pugilists' Guild
|align="right"| 175
|align="right"| -178
|align="right"| 190
|align="right"| 105
|-
| Thaumaturges' Guild
|align="right"| 209
|align="right"| -292
|align="right"| 206
|align="right"| 229
|-
| Gladiators' Guild
|align="right"| 209
|align="right"| -185
|align="right"| 194
|align="right"| 186
|-
| Goldsmiths' Guild
|align="right"| 209
|align="right"| -123
|align="right"| 201
|align="right"| 260
|-
| Weavers' Guild
|align="right"| 209
|align="right"| 45
|align="right"| 195
|align="right"| 253
|-
| Alchemists' Guild
|align="right"| 209
|align="right"| -205
|align="right"| 230
|align="right"| 283
|-
| Miners' Guild
|align="right"| 209
|align="right"| -96
|align="right"| 195
|align="right"| 320
|-
| Airship Landing
|align="right"| 209
|align="right"| -122
|align="right"| 271
|align="right"| 140
|}

=== Inns ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Limsa Inn
|align="right"| 244
|align="right"| -160
|align="right"| 0
|align="right"| -160
|-
| Gridania Inn
|align="right"| 244
|align="right"| 160
|align="right"| 0
|align="right"| 160
|-
| Ul'dah Inn
|align="right"| 244
|align="right"| 0
|align="right"| 0
|align="right"| 0
|}

=== Limsa Market Wards ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Bedroom
|align="right"|134
|align="right"|0
|align="right"|0
|align="right"|0
|-
| Building
|align="right"|134
|align="right"|-160
|align="right"|0
|align="right"|-160
|-
| Limsa Market Ward
|align="right"|134
|align="right"|160
|align="right"|0
|align="right"|160
|-
| Ul'dah Market Ward
|align="right"|134
|align="right"|320
|align="right"|0
|align="right"|320
|-
| Gridania Market Ward
|align="right"|134
|align="right"|480
|align="right"|0
|align="right"|480
|}

=== Gridania Market Wards ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Bedroom
|align="right"|160
|align="right"|0
|align="right"|0
|align="right"|0
|-
| Building
|align="right"|160
|align="right"|-160
|align="right"|0
|align="right"|-160
|-
| Gridania Market Ward
|align="right"|160
|align="right"|160
|align="right"|0
|align="right"|160
|-
| Limsa Market Ward
|align="right"|160
|align="right"|320
|align="right"|0
|align="right"|320
|-
| Ul’dah Market Ward
|align="right"|160
|align="right"|480
|align="right"|0
|align="right"|480
|}

=== Ul'dah Market Wards ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Bedroom
|align="right"|180
|align="right"|0
|align="right"|0
|align="right"|0
|-
| Building
|align="right"|180
|align="right"|-160
|align="right"|0
|align="right"|-160
|-
| Ul'dah Market Ward
|align="right"|180
|align="right"|160
|align="right"|0
|align="right"|160
|-
| Gridania Market Ward
|align="right"|180
|align="right"|320
|align="right"|0
|align="right"|320
|-
| Limsa Market Ward
|align="right"|180
|align="right"|480
|align="right"|0
|align="right"|480
|}

=== Grand Company Offices ===
{| class="wikitable sortable"
! Name
! ZoneID
! RegionID
! X
! Y
! Z
|-
| Limsa - Maelstrom Command
|align="right"|232
|align="right"|202
|align="right"|160
|align="right"|0
|align="right"|-160
|-
| Limsa - Stateroom
|align="right"|232
|align="right"|202
|align="right"|-160
|align="right"|0
|align="right"|155
|-
| Limsa - Briefing Room
|align="right"|232
|align="right"|202
|align="right"|-320
|align="right"|0
|align="right"|-320
|-
| Ul'dah - Hall of Flames
|align="right"|233
|align="right"|205
|align="right"|160
|align="right"|0
|align="right"|-160
|-
| Ul'dah - The Fragrant Chamber
|align="right"|233
|align="right"|205
|align="right"|-160
|align="right"|0
|align="right"|160
|-
| Gridania - Adders' Nest
|align="right"|234
|align="right"|204
|align="right"|160
|align="right"|0
|align="right"|-160
|}

== Outworld ==
=== La Noscea ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | La Noscea Proper
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| LL
| Limsa Lominsa
|align="right"| 128
|align="right"| -80
|align="right"| 30
|align="right"| 175
|-
| LL
| Zephyr Gate
|align="right"| 128
|align="right"| -35
|align="right"| 40
|align="right"| 150
|-
| LL
| Camp Bearded Rock
|align="right"| 128
|align="right"| 25
|align="right"| 50
|align="right"| -25
|-
| LL
| Shposhae
|align="right"| 128
|align="right"| 285
|align="right"| 25
|align="right"| 335
|-
| LL
| Moraby Bay
|align="right"| 128
|align="right"| 325
|align="right"| 25
|align="right"| 575
|-
| LL
| Oschon's Torch
|align="right"| 128
|align="right"| 130
|align="right"| 60
|align="right"| 1325
|-
| LL
| Craneperch Tower
|align="right"| 128
|align="right"| 675
|align="right"| 50
|align="right"| 550
|-
| LL
| Widow Cliffs
|align="right"| 128
|align="right"| 950
|align="right"| 50
|align="right"| 825
|-
| LL
| Cedarwood
|align="right"| 128
|align="right"| 600
|align="right"| 55
|align="right"| 0
|-
| EL
| Red Rooster Stead
|align="right"| 130
|align="right"| 1100
|align="right"| 55
|align="right"| -455
|-
| EL
| Gullperch Tower
|align="right"| 130
|align="right"| 1250
|align="right"| 50
|align="right"| -475
|-
| EL
| Tiger Helm Island
|align="right"| 130
|align="right"| 1625
|align="right"| 60
|align="right"| -450
|-
| EL
| South Bloodshore
|align="right"| 130
|align="right"| 1525
|align="right"| 0
|align="right"| -650
|-
| EL
| Cassiopeia Hollow
|align="right"| 130
|align="right"| 1125
|align="right"| 30
|align="right"| -800
|-
| EL
| Camp Bloodshore
|align="right"| 130
|align="right"| 1125
|align="right"| 50
|align="right"| -925
|-
| EL
| Wineport
|align="right"| 130
|align="right"| 625
|align="right"| 50
|align="right"| -1175
|-
| EL
| Agelyss Wise
|align="right"| 130
|align="right"| 1400
|align="right"| 55
|align="right"| -1650
|-
| WL
| Swiftperch Tower
|align="right"| 129
|align="right"| -800
|align="right"| 50
|align="right"| -675
|-
| WL
| Aleport
|align="right"| 129
|align="right"| -1318
|align="right"| 5
|align="right"| -575
|-
| WL
| Camp Skull Valley
|align="right"| 129
|align="right"| -1000
|align="right"| 60
|align="right"| -1125
|-
| WL
| Woad Whisper Canyon
|align="right"| 129
|align="right"| -625
|align="right"| 55
|align="right"| -1275
|-
| WL
| Halfstone
|align="right"| 129
|align="right"| -1800
|align="right"| 65
|align="right"| -950
|-
| WL
| The Isles of Umbra
|align="right"| 129
|align="right"| -2010
|align="right"| 60
|align="right"| -760
|-
| WL
| Camp Bald Knoll
|align="right"| 129
|align="right"| -1900
|align="right"| 55
|align="right"| -1375
|-
| WL
| Mistbeard Cove
|align="right"| 129
|align="right"| -1755
|align="right"| 30
|align="right"| -1500
|-
| UL
| Kobold Garrison
|align="right"| 135
|align="right"| -725
|align="right"| 70
|align="right"| -1650
|-
| UL
| Bronze Lake
|align="right"| 135
|align="right"| -325
|align="right"| 55
|align="right"| -1825
|-
| UL
| Zelma's Run
|align="right"| 135
|align="right"| -125
|align="right"| 60
|align="right"| -1425
|-
| UL
| Kobold Encampment
|align="right"| 135
|align="right"| 575
|align="right"| 55
|align="right"| -1700
|-
| UL
| Camp Iron Lake
|align="right"| 135
|align="right"| -275
|align="right"| 80
|align="right"| -2260
|-
| UL
| Oakwood
|align="right"| 135
|align="right"| -900
|align="right"| 40
|align="right"| -2175
|-
| UL
| U'Ghamaro Mines
|align="right"| 135
|align="right"| 100
|align="right"| 60
|align="right"| -2725
|}

==== Shposhae ====
==== Cassiopeia Hollow ====
==== Mistbeard Cove ====
==== U'Ghamaro Mines ====

=== The Black Shroud ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 250px;" | The Black Shroud Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| CS
| Gridania (29-27)
|align="right"| 150
|align="right"| -190
|align="right"| 10
|align="right"| -1070
|-
| CS
| Gridania (34-27)
|align="right"| 150
|align="right"| -315
|align="right"| 5
|align="right"| -1000
|-
| CS
| Camp Bentbranch
|align="right"| 150
|align="right"| 300
|align="right"| 5
|align="right"| -525
|-
| CS
| Humblehearth
|align="right"| 150
|align="right"| -100
|align="right"| 5
|align="right"| -550
|-
| CS
| Lifemend Stump
|align="right"| 150
|align="right"| -800
|align="right"| 20
|align="right"| -1050
|-
| CS
| Amberscale Rock
|align="right"| 150
|align="right"| -575
|align="right"| -15
|align="right"| -475
|-
| CS
| Tam Tara Deepcroft
|align="right"| 150
|align="right"| 315
|align="right"| 5
|align="right"| -250
|-
| CS
| Sorrel Haven
|align="right"| 150
|align="right"| -285
|align="right"| -25
|align="right"| -35
|-
| CS
| Five Hangs
|align="right"| 150
|align="right"| 630
|align="right"| 15
|align="right"| -300
|-
| CS
| The Mirror
|align="right"| 150
|align="right"| 700
|align="right"| 15
|align="right"| -90
|-
| ES
| Camp Nine Ivies
|align="right"| 151
|align="right"| 1700
|align="right"| 20
|align="right"| -850
|-
| ES
| The Hawthrone Hut
|align="right"| 151
|align="right"| 1950
|align="right"| 20
|align="right"| -550
|-
| ES
| Larkscall
|align="right"| 151
|align="right"| 2300
|align="right"| 30
|align="right"| -700
|-
| ES
| Verdant Drop
|align="right"| 151
|align="right"| 1525
|align="right"| 25
|align="right"| -1125
|-
| ES
| Lynxpelt Patch
|align="right"| 151
|align="right"| 1300
|align="right"| 50
|align="right"| -1525
|-
| ES
| Moonspore Grove
|align="right"| 151
|align="right"| 2215
|align="right"| 20
|align="right"| -1780
|-
| SS
| Buscarron's Fold
|align="right"| 154
|align="right"| 415
|align="right"| 5
|align="right"| 550
|-
| SS
| Camp Tranquil
|align="right"| 154
|align="right"| 725
|align="right"| -10
|align="right"| 1125
|-
| SS
| The Thousand Maws of Toto-Rak
|align="right"| 154
|align="right"| 850
|align="right"| -10
|align="right"| 645
|-
| SS
| Silent Arbor
|align="right"| 154
|align="right"| 1000
|align="right"| -10
|align="right"| 600
|-
| SS
| Quarrymill
|align="right"| 154
|align="right"| 1450
|align="right"| -15
|align="right"| 900
|-
| SS
| The Rootslake
|align="right"| 154
|align="right"| 1530
|align="right"| 0
|align="right"| 1090
|-
| SS
| Longroot
|align="right"| 154
|align="right"| 1125
|align="right"| 0
|align="right"| 1450
|-
| SS
| Snakemolt
|align="right"| 154
|align="right"| 180
|align="right"| 0
|align="right"| 1350
|-
| SS
| Thanalan
|align="right"| 154
|align="right"| 760
|align="right"| -5
|align="right"| 1850
|-
| WS
| Camp Crimson Bark
|align="right"| 153
|align="right"| -1550
|align="right"| -10
|align="right"| -550
|-
| WS
| Lichenweed
|align="right"| 153
|align="right"| -1920
|align="right"| 0
|align="right"| -1050
|-
| WS
| Murmur Rills
|align="right"| 153
|align="right"| -2150
|align="right"| -45
|align="right"| -150
|-
| WS
| Mor Dhona
|align="right"|153
|align="right"| -2800
|align="right"| -23
|align="right"| -390
|-
| WS
| Turning Leaf
|align="right"| 153
|align="right"| -1337
|align="right"| -13
|align="right"| 337
|-
| NS
| Camp Emerald Moss
|align="right"| 152
|align="right"| -1050
|align="right"| 20
|align="right"| -1750
|-
| NS
| Fallgourd Lake
|align="right"| 152
|align="right"| -1500
|align="right"| 35
|align="right"| -1925
|-
| NS
| Coerthas
|align="right"| 152
|align="right"| -1625
|align="right"| 20
|align="right"| -1925
|-
| NS
| The Mun-Tuy Cellars (24-18)
|align="right"| 152
|align="right"| -700
|align="right"| 20
|align="right"| -1925
|-
| NS
| Treespeak
|align="right"| 152
|align="right"| -900
|align="right"| 35
|align="right"| -2175
|-
| NS
| Ixali Clearing
|align="right"| 152
|align="right"| -800
|align="right"| 5
|align="right"| -2345
|-
| NS
| Hyristmill
|align="right"| 152
|align="right"| -600
|align="right"| 5
|align="right"| -2400
|-
| NS
| The Mun-Tuy Cellars (20-13)
|align="right"| 152
|align="right"| -1025
|align="right"| 5
|align="right"| -2425
|-
| NS
| Alder Springs
|align="right"| 152
|align="right"| -1575
|align="right"| 15
|align="right"| -2575
|-
| NS
| Lasthold
|align="right"| 152
|align="right"| -800
|align="right"| 30
|align="right"| -2800
|}

==== Tam-Tara Deepcroft ====
==== The Mun-Tuy Cellars ====

=== Thanalan ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | Thanalan Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| WT
| Camp Horizon
|align="right"| 172
|align="right"| -1300
|align="right"| 55
|align="right"| -150
|-
| WT
| Copperbell Mines
|align="right"| 172
|align="right"| -750
|align="right"| 120
|align="right"| -100
|-
| WT
| Nophica's Wells
|align="right"| 172
|align="right"| -875
|align="right"| 90
|align="right"| 375
|-
| WT
| Scorpion Keep
|align="right"| 172
|align="right"| -1225
|align="right"| 60
|align="right"| 200
|-
| WT
| The Silver Bazaar
|align="right"| 172
|align="right"| -1375
|align="right"| 60
|align="right"| 575
|-
| WT
| The Coffer & Coffin
|align="right"| 172
|align="right"| -1750
|align="right"| 55
|align="right"| -325
|-
| WT
| The Footfalls
|align="right"| 172
|align="right"| -1650
|align="right"| 25
|align="right"| -475
|-
| WT
| Ferry Docks
|align="right"| 172
|align="right"| -2210
|align="right"| 15
|align="right"| -400
|-
| WT
| Chocobo Stables
|align="right"| 172
|align="right"| -2200
|align="right"| 15
|align="right"| -425
|-
| CT
| Ul'dah (26-30)
|align="right"| 170
|align="right"| -25
|align="right"| 185
|align="right"| -75
|-
| CT
| Ul'dah (27-32)
|align="right"| 170
|align="right"| 125
|align="right"| 185
|align="right"| 225
|-
| CT
| Cactus Basin
|align="right"| 170
|align="right"| 625
|align="right"| 185
|align="right"| 125
|-
| CT
| Four Sisters
|align="right"| 170
|align="right"| 525
|align="right"| 220
|align="right"| 0
|-
| CT
| Camp Black Brush
|align="right"| 170
|align="right"| 35
|align="right"| 200
|align="right"| -475
|-
| CT
| Nanawa Mines
|align="right"| 170
|align="right"| 90
|align="right"| 185
|align="right"| -1050
|-
| ET
| Camp Drybone
|align="right"| 171
|align="right"| 1250
|align="right"| 265
|align="right"| -550
|-
| ET
| The Golden Bazaar
|align="right"| 171
|align="right"| 1125
|align="right"| 315
|align="right"| -1080
|-
| ET
| Thal's Respite
|align="right"| 171
|align="right"| 1675
|align="right"| 285
|align="right"| -1100
|-
| ET
| The Black Shroud
|align="right"| 171
|align="right"| 2047
|align="right"| 280
|align="right"| 1219
|-
| ET
| The Burning Wall
|align="right"| 171
|align="right"| 2000
|align="right"| 280
|align="right"| -760
|-
| ET
| Mythril Pit T-8
|align="right"| 171
|align="right"| 1355
|align="right"| 255
|align="right"| -224
|-
| ET
| Halatali
|align="right"| 171
|align="right"| 1600
|align="right"| 255
|align="right"| -225
|-
| ET
| Amalj'aa Encampment
|align="right"| 171
|align="right"| 2050
|align="right"| 265
|align="right"| -325
|-
| ET
| Little Ala Mhigo
|align="right"| 171
|align="right"| 1150
|align="right"| 250
|align="right"| 190
|-
| ET
| Amalj'aa Altar
|align="right"| 171
|align="right"| 1475
|align="right"| 250
|align="right"| 250
|-
| ET
| Sandgate
|align="right"| 171
|align="right"| 2000
|align="right"| 250
|align="right"| 75
|-
| ST
| Camp Broken Water
|align="right"| 174
|align="right"| 1700
|align="right"| 300
|align="right"| 1000
|-
| ST
| Nald's Reflection
|align="right"| 174
|align="right"| 950
|align="right"| 315
|align="right"| 700
|-
| ST
| Burnt Lizard Creek
|align="right"| 174
|align="right"| 1175
|align="right"| 280
|align="right"| 1400
|-
| ST
| Zahar'ak
|align="right"| 174
|align="right"| 2125
|align="right"| 300
|align="right"| 1025
|-
| ST
| The Red Labyrinth
|align="right"| 174
|align="right"| 1800
|align="right"| 250
|align="right"| 1850
|-
| ST
| Zanr'ak
|align="right"| 174
|align="right"| 2400
|align="right"| 250
|align="right"| 1525
|-
| NT
| Camp Bluefog
|align="right"| 173
|align="right"| -175
|align="right"| 280
|align="right"| -1700
|-
| NT
| Cutter's Cry
|align="right"| 173
|align="right"| 25
|align="right"| 280
|align="right"| -1675
|-
| NT
| Hidden Gorge
|align="right"| 173
|align="right"| -625
|align="right"| 280
|align="right"| -1800
|-
| NT
| Cutter's Pass
|align="right"| 173
|align="right"| -700
|align="right"| 280
|align="right"| -2200
|-
| NT
| Sea of Spires
|align="right"| 173
|align="right"| 450
|align="right"| 260
|align="right"| -2150
|-
| NT
| Mor Dhona
|align="right"| 173
|align="right"| 0
|align="right"| 270
|align="right"| -2825
|}

==== Copperbell Mines ====
==== Nanawa Mines ====

=== Coerthas ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | Coerthas Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| CCH
| Gates of Judgment
|align="right"| 143
|align="right"| -200
|align="right"| 290
|align="right"| -300
|-
| CCH
| Camp Dragonhead
|align="right"| 143
|align="right"| 200
|align="right"| 300
|align="right"| -250
|-
| CCH
| Prominence Point
|align="right"| 143
|align="right"| 200
|align="right"| 365
|align="right"| -650
|-
| CCH
| Natalan
|align="right"| 143
|align="right"| 500
|align="right"| 305
|align="right"| -200
|-
| CCH
| Feathergorge
|align="right"| 143
|align="right"| 950
|align="right"| 290
|align="right"| -20
|-
| CCH
| Dzemael Darkhold
|align="right"| 143
|align="right"| -75
|align="right"| 250
|align="right"| 400
|-
| CCH
| Boulder Downs
|align="right"| 143
|align="right"| -525
|align="right"| 210
|align="right"| 550
|-
| CCH
| Griffin Crossing
|align="right"| 143
|align="right"| 735
|align="right"| 240
|align="right"| 640
|-
| CCH
| Gargoyle Crossing
|align="right"| 143
|align="right"| -1175
|align="right"| 245
|align="right"| 0
|-
| CWH
| Camp Riversmeet
|align="right"| 148
|align="right"| -1750
|align="right"| 270
|align="right"| -200
|-
| CWH
| Dusk Vigil
|align="right"| 148
|align="right"| -1835
|align="right"| 370
|align="right"| -705
|-
| CWH
| Wyrmking's Perch
|align="right"| 148
|align="right"| -1740
|align="right"| 285
|align="right"| -835
|-
| CWH
| The Lance
|align="right"| 148
|align="right"| -2375
|align="right"| 340
|align="right"| -1050
|-
| CWH
| Twinpool
|align="right"| 148
|align="right"| -2800
|align="right"| 260
|align="right"| -275
|-
| CWH
| Falcon's Nest
|align="right"| 148
|align="right"| -1660
|align="right"| 310
|align="right"| 825
|-
| CEH
| Camp Crooked Fork
|align="right"| 144
|align="right"| 1120
|align="right"| 270
|align="right"| -1150
|-
| CEH
| Dawn Vigil
|align="right"| 144
|align="right"| 675
|align="right"| 255
|align="right"| -955
|-
| CEH
| Gwyr-Aen
|align="right"| 144
|align="right"| 650
|align="right"| 300
|align="right"| -1400
|-
| CEH
| Maiden Glen
|align="right"| 144
|align="right"| 1725
|align="right"| 180
|align="right"| -1250
|-
| CEH
| Hushed Boughs
|align="right"| 144
|align="right"| 1400
|align="right"| 225
|align="right"| -725
|-
| CEH
| Scarwing Fall
|align="right"| 144
|align="right"| 1800
|align="right"| 165
|align="right"| -825
|-
| CCL
| Camp Ever Lakes
|align="right"| 147
|align="right"| -150
|align="right"| 225
|align="right"| 1150
|-
| CCL
| The Aurum Vale
|align="right"| 147
|align="right"| -375
|align="right"| 245
|align="right"| 1400
|-
| CCL
| Teriggan's Stand
|align="right"| 147
|align="right"| 0
|align="right"| 145
|align="right"| 1375
|-
| CCL
| Shepherd Peak
|align="right"| 147
|align="right"| -50
|align="right"| 180
|align="right"| 1935
|-
| CCL
| Fellwood
|align="right"| 147
|align="right"| -900
|align="right"| 195
|align="right"| 2150
|-
| CCL
| Mor Dhona
|align="right"| 147
|align="right"| 150
|align="right"| 135
|align="right"| 2725
|-
| CEL
| Camp Glory
|align="right"| 145
|align="right"| 1500
|align="right"| 205
|align="right"| 775
|-
| CEL
| Ixali Encampment
|align="right"| 145
|align="right"| 1125
|align="right"| 220
|align="right"| 1050
|-
| CEL
| Weeping Vale
|align="right"| 145
|align="right"| 1400
|align="right"| 230
|align="right"| 425
|-
| CEL
| Clearwater
|align="right"| 145
|align="right"| 2150
|align="right"| 145
|align="right"| 625
|-
| CEL
| Clearwater Lake
|align="right"| 145
|align="right"| 2375
|align="right"| 145
|align="right"| 550
|-
| CEL
| The Black Shroud
|align="right"| 145
|align="right"| 1825
|align="right"| 150
|align="right"| 1850
|}

=== Mor Dhona ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | Mor Dhona Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| MD
| Camp Reveant's Toll
|align="right"| 190
|align="right"| -220
|align="right"| 20
|align="right"| -675
|-
| MD
| Coerthas
|align="right"| 190
|align="right"| 275
|align="right"| 45
|align="right"| -925
|-
| MD
| The Black Shroud
|align="right"| 190
|align="right"| 900
|align="right"| 35
|align="right"| -200
|-
| MD
| Singing Shards
|align="right"| 190
|align="right"| 575
|align="right"| 60
|align="right"| 200
|-
| MD
| Camp Brittlebark
|align="right"| 190
|align="right"| 475
|align="right"| 20
|align="right"| 675
|-
| MD
| Thanalan
|align="right"| 190
|align="right"| -400
|align="right"| 10
|align="right"| 850
|-
| MD
| Silvertear Lake
|align="right"| 190
|align="right"| 125
|align="right"| 20
|align="right"| 375
|-
| MD
| Jagged Crest Cave
|align="right"| 190
|align="right"| -350
|align="right"| -15
|align="right"| -25
|-
| MD
| Castrum Novum
|align="right"| 190
|align="right"| -600
|align="right"| 0
|align="right"| -75
|-
| MD
| Fogfens
|align="right"| 190
|align="right"| -450
|align="right"| -40
|align="right"| -325
|}

== Duties ==
=== Instanced Dungeons ===
==== The Thousand Maws of Toto-Rak ====
==== Cutter's Cry ====
==== Dzemael Darkhold ====
==== The Aurum Vale ====
=== Trials ===
{| class="wikitable sortable"
|+ Trials
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| MD
| Castrum Novum Transmission Tower
| 251 (use 190 until instances are ready)
| 0
| -100
| 0
|-
| R
| Rivenroad
| 257
| 0
| 0
| 0
|}

{| class="wikitable sortable"
|+ Primals
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| S
| Thornmarch
|align="right"| 238
|align="right"| -2370
|align="right"| -22
|align="right"| -890
|-
| T
| The Bowl of Embers
|align="right"| 240
|align="right"| 2360
|align="right"| 260
|align="right"| 2200
|-
| C
| The Howling Eye
|align="right"| 239
|align="right"| 1400
|align="right"| 310
|align="right"| -295
|}

{| class="wikitable sortable"
|+ The Cieldalaes
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| L
| Hope's Bourn
|align="right"| 128
|align="right"| 2035
|align="right"| 50
|align="right"| 1450
|-
| L
| Turtleback Island
|align="right"| 237
|align="right"| 3050
|align="right"| 40
|align="right"| 500
|-
| L
| Locke's Lie
|align="right"| 236
|align="right"| 950
|align="right"| 1
|align="right"| 1040
|}

{| class="wikitable sortable"
|+ Hamlet Defense
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| L
| the Battle for Aleport
|
|
|
|
|-
| S
| the Battle for Hyrstmill
|
|
|
|
|-
| T
| the Battle for the Golden Bazaar
|
|
|
|
|}

== Other ==
=== Special Regions ===
{| class="wikitable sortable"
|+ Ocean
! Name
! ZoneID
! RegionID
! X
! Y
! Z
|-
| "Limsa Boat"
|align="right"| 139
|align="right"| 112
|align="right"| -608
|align="right"| 12
|align="right"| -608
|-
| "Large Ship"
|align="right"| 139
|align="right"| 112
|align="right"| 608
|align="right"| 15
|align="right"| 600
|-
| "Large War Ship"
|align="right"| 139
|align="right"| 112
|align="right"| 1823
|align="right"| 15
|align="right"| 1815
|-
| "Fishing Boat"
|align="right"| 139
|align="right"| 112
|align="right"| -1824
|align="right"| 10
|align="right"| -1838
|-
| "Sahagin Boat"
|align="right"| 139
|align="right"| 112
|align="right"| -3040
|align="right"| 12
|align="right"| -3040
|-
| "Pirate Boat"
|align="right"| 139
|align="right"| 112
|align="right"| 3040
|align="right"| 16
|align="right"| 3054
|-
| "Dinghy"
|align="right"| 139
|align="right"| 112
|align="right"| 608
|align="right"| 5
|align="right"| -608
|}

=== Unfinished/Beta Content ===
{| class="wikitable sortable"
|+ Unfinished Trials
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| L
| "The Navel"
|align="right"| 128
|align="right"| 385
|align="right"| -20
|align="right"| -3040
|-
| L
| "Copy of Turtleback Island?"
|align="right"| 128
|align="right"| 2680
|align="right"| 45
|align="right"| 2400
|}

{| class="wikitable sortable"
|+ Unfinished Dungeons
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| S
| "Unused Tam Tara Map?"
|align="right"| 150
|align="right"| 1585
|align="right"| 25
|align="right"| -400
|-
| C
| "The Aery"
|align="right"| 143
|align="right"| -2085
|align="right"| 310
|align="right"| -1215
|-
| C
| "Hengr's Crucible"
|align="right"| 143
|align="right"| 1570
|align="right"| 340
|align="right"| -2050
|-
| C
| "The Fesse"
|align="right"| 143
|align="right"| 1760
|align="right"| 180
|align="right"| 180
|}

=== Others ===
{| class="wikitable sortable"
|+ The Twelve
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| MD
| "Thaliak's Rune"
|align="right"| 190
|align="right"| -540
|align="right"| -40
|align="right"| 225
|}

{| class="wikitable sortable"
|+ Misc
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| S
| "Farm"
|align="right"| 150
|align="right"| 465
|align="right"| 15
|align="right"| -2022
|-
| S
| "Clearing"
|align="right"| 150
|align="right"| 465
|align="right"| 12
|align="right"| -2350
|}

Points of interest

2019-06-19T19:10:02Z

Unnamed mercenary: Adjusted Castrum Novum Transmission Tower to zone 190

<div style="float:right;">__TOC__</div>
== Towns ==
=== Limsa Lominsa ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Adventurers' Guild
|align="right"| 133
|align="right"| -466
|align="right"| 40
|align="right"| 200
|-
| Musketeers' Guild
|align="right"| 230
|align="right"| -600
|align="right"| 42
|align="right"| -50
|-
| Arcanists' Guild
|align="right"| 230
|align="right"| -786
|align="right"| 12
|align="right"| 217
|-
| Marauders' Guild
|align="right"| 230
|align="right"| -753
|align="right"| 8
|align="right"| 370
|-
| Culinairians' Guild
|align="right"| 230
|align="right"| -502
|align="right"| 44
|align="right"| 47
|-
| Fishermens' Guild
|align="right"| 230
|align="right"| -624
|align="right"| 4
|align="right"| 361
|-
| Blacksmiths' Guild
Armorers' Guild
|align="right"| 230
|align="right"| -487
|align="right"| 42
|align="right"| 425
|-
| Airship Landing
|align="right"| 230
|align="right"| -460
|align="right"| 91
|align="right"| 177
|-
| Ferry Docks
|align="right"| 230
|align="right"| -856
|align="right"| 4
|align="right"| 238
|}

=== Gridania ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Adventurers' Guild
|align="right"| 155
|align="right"| 69
|align="right"| 4
|align="right"| -1208
|-
| Archers' Guild
|align="right"| 206
|align="right"| 228
|align="right"| 12
|align="right"| -1268
|-
| Conjurers' Guild
|align="right"| 206
|align="right"| -334
|align="right"| 8
|align="right"| -1678
|-
| Lancers' Guild
|align="right"| 206
|align="right"| 175
|align="right"| 27
|align="right"| -1580
|-
| Carpenters' Guild
|align="right"| 206
|align="right"| 18
|align="right"| 9
|align="right"| -1265
|-
| Leatherworkers' Guild
|align="right"| 206
|align="right"| 91
|align="right"| 20
|align="right"| -1455
|-
| Botanists' Guild
|align="right"| 206
|align="right"| -206
|align="right"| 20
|align="right"| -1460
|-
| The Lotus Stand
|align="right"| 155
|align="right"| 25
|align="right"| 10
|align="right"| -2140
|-
| Airship Landing
|align="right"| 155
|align="right"| 60
|align="right"| -7
|align="right"| -1212
|}

=== Ul'dah ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Adventurers' Guild
|align="right"| 175
|align="right"| -65
|align="right"| 196
|align="right"| 47
|-
| Pugilists' Guild
|align="right"| 175
|align="right"| -178
|align="right"| 190
|align="right"| 105
|-
| Thaumaturges' Guild
|align="right"| 209
|align="right"| -292
|align="right"| 206
|align="right"| 229
|-
| Gladiators' Guild
|align="right"| 209
|align="right"| -185
|align="right"| 194
|align="right"| 186
|-
| Goldsmiths' Guild
|align="right"| 209
|align="right"| -123
|align="right"| 201
|align="right"| 260
|-
| Weavers' Guild
|align="right"| 209
|align="right"| 45
|align="right"| 195
|align="right"| 253
|-
| Alchemists' Guild
|align="right"| 209
|align="right"| -205
|align="right"| 230
|align="right"| 283
|-
| Miners' Guild
|align="right"| 209
|align="right"| -96
|align="right"| 195
|align="right"| 320
|-
| Airship Landing
|align="right"| 209
|align="right"| -122
|align="right"| 271
|align="right"| 140
|}

=== Inns ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Limsa Inn
|align="right"| 244
|align="right"| -160
|align="right"| 0
|align="right"| -160
|-
| Gridania Inn
|align="right"| 244
|align="right"| 160
|align="right"| 0
|align="right"| 160
|-
| Ul'dah Inn
|align="right"| 244
|align="right"| 0
|align="right"| 0
|align="right"| 0
|}

=== Limsa Market Wards ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Bedroom
|align="right"|134
|align="right"|0
|align="right"|0
|align="right"|0
|-
| Building
|align="right"|134
|align="right"|-160
|align="right"|0
|align="right"|-160
|-
| Limsa Market Ward
|align="right"|134
|align="right"|160
|align="right"|0
|align="right"|160
|-
| Ul'dah Market Ward
|align="right"|134
|align="right"|320
|align="right"|0
|align="right"|320
|-
| Gridania Market Ward
|align="right"|134
|align="right"|480
|align="right"|0
|align="right"|480
|}

=== Gridania Market Wards ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Bedroom
|align="right"|160
|align="right"|0
|align="right"|0
|align="right"|0
|-
| Building
|align="right"|160
|align="right"|-160
|align="right"|0
|align="right"|-160
|-
| Gridania Market Ward
|align="right"|160
|align="right"|160
|align="right"|0
|align="right"|160
|-
| Limsa Market Ward
|align="right"|160
|align="right"|320
|align="right"|0
|align="right"|320
|-
| Ul’dah Market Ward
|align="right"|160
|align="right"|480
|align="right"|0
|align="right"|480
|}

=== Ul'dah Market Wards ===
{| class="wikitable sortable"
! Name
! ZoneID
! X
! Y
! Z
|-
| Bedroom
|align="right"|180
|align="right"|0
|align="right"|0
|align="right"|0
|-
| Building
|align="right"|180
|align="right"|-160
|align="right"|0
|align="right"|-160
|-
| Ul'dah Market Ward
|align="right"|180
|align="right"|160
|align="right"|0
|align="right"|160
|-
| Gridania Market Ward
|align="right"|180
|align="right"|320
|align="right"|0
|align="right"|320
|-
| Limsa Market Ward
|align="right"|180
|align="right"|480
|align="right"|0
|align="right"|480
|}

=== Grand Company Offices ===
{| class="wikitable sortable"
! Name
! ZoneID
! RegionID
! X
! Y
! Z
|-
| Limsa - Maelstrom Command
|align="right"|232
|align="right"|202
|align="right"|160
|align="right"|0
|align="right"|-160
|-
| Limsa - Stateroom
|align="right"|232
|align="right"|202
|align="right"|-160
|align="right"|0
|align="right"|155
|-
| Limsa - Briefing Room
|align="right"|232
|align="right"|202
|align="right"|-320
|align="right"|0
|align="right"|-320
|-
| Ul'dah - Hall of Flames
|align="right"|233
|align="right"|205
|align="right"|160
|align="right"|0
|align="right"|-160
|-
| Ul'dah - The Fragrant Chamber
|align="right"|233
|align="right"|205
|align="right"|-160
|align="right"|0
|align="right"|160
|-
| Gridania - Adders' Nest
|align="right"|234
|align="right"|204
|align="right"|160
|align="right"|0
|align="right"|-160
|}

== Outworld ==
=== La Noscea ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | La Noscea Proper
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| LL
| Limsa Lominsa
|align="right"| 128
|align="right"| -80
|align="right"| 30
|align="right"| 175
|-
| LL
| Zephyr Gate
|align="right"| 128
|align="right"| -35
|align="right"| 40
|align="right"| 150
|-
| LL
| Camp Bearded Rock
|align="right"| 128
|align="right"| 25
|align="right"| 50
|align="right"| -25
|-
| LL
| Shposhae
|align="right"| 128
|align="right"| 285
|align="right"| 25
|align="right"| 335
|-
| LL
| Moraby Bay
|align="right"| 128
|align="right"| 325
|align="right"| 25
|align="right"| 575
|-
| LL
| Oschon's Torch
|align="right"| 128
|align="right"| 130
|align="right"| 60
|align="right"| 1325
|-
| LL
| Craneperch Tower
|align="right"| 128
|align="right"| 675
|align="right"| 50
|align="right"| 550
|-
| LL
| Widow Cliffs
|align="right"| 128
|align="right"| 950
|align="right"| 50
|align="right"| 825
|-
| LL
| Cedarwood
|align="right"| 128
|align="right"| 600
|align="right"| 55
|align="right"| 0
|-
| EL
| Red Rooster Stead
|align="right"| 130
|align="right"| 1100
|align="right"| 55
|align="right"| -455
|-
| EL
| Gullperch Tower
|align="right"| 130
|align="right"| 1250
|align="right"| 50
|align="right"| -475
|-
| EL
| Tiger Helm Island
|align="right"| 130
|align="right"| 1625
|align="right"| 60
|align="right"| -450
|-
| EL
| South Bloodshore
|align="right"| 130
|align="right"| 1525
|align="right"| 0
|align="right"| -650
|-
| EL
| Cassiopeia Hollow
|align="right"| 130
|align="right"| 1125
|align="right"| 30
|align="right"| -800
|-
| EL
| Camp Bloodshore
|align="right"| 130
|align="right"| 1125
|align="right"| 50
|align="right"| -925
|-
| EL
| Wineport
|align="right"| 130
|align="right"| 625
|align="right"| 50
|align="right"| -1175
|-
| EL
| Agelyss Wise
|align="right"| 130
|align="right"| 1400
|align="right"| 55
|align="right"| -1650
|-
| WL
| Swiftperch Tower
|align="right"| 129
|align="right"| -800
|align="right"| 50
|align="right"| -675
|-
| WL
| Aleport
|align="right"| 129
|align="right"| -1318
|align="right"| 5
|align="right"| -575
|-
| WL
| Camp Skull Valley
|align="right"| 129
|align="right"| -1000
|align="right"| 60
|align="right"| -1125
|-
| WL
| Woad Whisper Canyon
|align="right"| 129
|align="right"| -625
|align="right"| 55
|align="right"| -1275
|-
| WL
| Halfstone
|align="right"| 129
|align="right"| -1800
|align="right"| 65
|align="right"| -950
|-
| WL
| The Isles of Umbra
|align="right"| 129
|align="right"| -2010
|align="right"| 60
|align="right"| -760
|-
| WL
| Camp Bald Knoll
|align="right"| 129
|align="right"| -1900
|align="right"| 55
|align="right"| -1375
|-
| WL
| Mistbeard Cove
|align="right"| 129
|align="right"| -1755
|align="right"| 30
|align="right"| -1500
|-
| UL
| Kobold Garrison
|align="right"| 135
|align="right"| -725
|align="right"| 70
|align="right"| -1650
|-
| UL
| Bronze Lake
|align="right"| 135
|align="right"| -325
|align="right"| 55
|align="right"| -1825
|-
| UL
| Zelma's Run
|align="right"| 135
|align="right"| -125
|align="right"| 60
|align="right"| -1425
|-
| UL
| Kobold Encampment
|align="right"| 135
|align="right"| 575
|align="right"| 55
|align="right"| -1700
|-
| UL
| Camp Iron Lake
|align="right"| 135
|align="right"| -275
|align="right"| 80
|align="right"| -2260
|-
| UL
| Oakwood
|align="right"| 135
|align="right"| -900
|align="right"| 40
|align="right"| -2175
|-
| UL
| U'Ghamaro Mines
|align="right"| 135
|align="right"| 100
|align="right"| 60
|align="right"| -2725
|}

==== Shposhae ====
==== Cassiopeia Hollow ====
==== Mistbeard Cove ====
==== U'Ghamaro Mines ====

=== The Black Shroud ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 250px;" | The Black Shroud Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| CS
| Gridania (29-27)
|align="right"| 150
|align="right"| -190
|align="right"| 10
|align="right"| -1070
|-
| CS
| Gridania (34-27)
|align="right"| 150
|align="right"| -315
|align="right"| 5
|align="right"| -1000
|-
| CS
| Camp Bentbranch
|align="right"| 150
|align="right"| 300
|align="right"| 5
|align="right"| -525
|-
| CS
| Humblehearth
|align="right"| 150
|align="right"| -100
|align="right"| 5
|align="right"| -550
|-
| CS
| Lifemend Stump
|align="right"| 150
|align="right"| -800
|align="right"| 20
|align="right"| -1050
|-
| CS
| Amberscale Rock
|align="right"| 150
|align="right"| -575
|align="right"| -15
|align="right"| -475
|-
| CS
| Tam Tara Deepcroft
|align="right"| 150
|align="right"| 315
|align="right"| 5
|align="right"| -250
|-
| CS
| Sorrel Haven
|align="right"| 150
|align="right"| -285
|align="right"| -25
|align="right"| -35
|-
| CS
| Five Hangs
|align="right"| 150
|align="right"| 630
|align="right"| 15
|align="right"| -300
|-
| CS
| The Mirror
|align="right"| 150
|align="right"| 700
|align="right"| 15
|align="right"| -90
|-
| ES
| Camp Nine Ivies
|align="right"| 151
|align="right"| 1700
|align="right"| 20
|align="right"| -850
|-
| ES
| The Hawthrone Hut
|align="right"| 151
|align="right"| 1950
|align="right"| 20
|align="right"| -550
|-
| ES
| Larkscall
|align="right"| 151
|align="right"| 2300
|align="right"| 30
|align="right"| -700
|-
| ES
| Verdant Drop
|align="right"| 151
|align="right"| 1525
|align="right"| 25
|align="right"| -1125
|-
| ES
| Lynxpelt Patch
|align="right"| 151
|align="right"| 1300
|align="right"| 50
|align="right"| -1525
|-
| ES
| Moonspore Grove
|align="right"| 151
|align="right"| 2215
|align="right"| 20
|align="right"| -1780
|-
| SS
| Buscarron's Fold
|align="right"| 154
|align="right"| 415
|align="right"| 5
|align="right"| 550
|-
| SS
| Camp Tranquil
|align="right"| 154
|align="right"| 725
|align="right"| -10
|align="right"| 1125
|-
| SS
| The Thousand Maws of Toto-Rak
|align="right"| 154
|align="right"| 850
|align="right"| -10
|align="right"| 645
|-
| SS
| Silent Arbor
|align="right"| 154
|align="right"| 1000
|align="right"| -10
|align="right"| 600
|-
| SS
| Quarrymill
|align="right"| 154
|align="right"| 1450
|align="right"| -15
|align="right"| 900
|-
| SS
| The Rootslake
|align="right"| 154
|align="right"| 1530
|align="right"| 0
|align="right"| 1090
|-
| SS
| Longroot
|align="right"| 154
|align="right"| 1125
|align="right"| 0
|align="right"| 1450
|-
| SS
| Snakemolt
|align="right"| 154
|align="right"| 180
|align="right"| 0
|align="right"| 1350
|-
| SS
| Thanalan
|align="right"| 154
|align="right"| 760
|align="right"| -5
|align="right"| 1850
|-
| WS
| Camp Crimson Bark
|align="right"| 153
|align="right"| -1550
|align="right"| -10
|align="right"| -550
|-
| WS
| Lichenweed
|align="right"| 153
|align="right"| -1920
|align="right"| 0
|align="right"| -1050
|-
| WS
| Murmur Rills
|align="right"| 153
|align="right"| -2150
|align="right"| -45
|align="right"| -150
|-
| WS
| Mor Dhona
|align="right"|153
|align="right"| -2800
|align="right"| -23
|align="right"| -390
|-
| WS
| Turning Leaf
|align="right"| 153
|align="right"| -1337
|align="right"| -13
|align="right"| 337
|-
| NS
| Camp Emerald Moss
|align="right"| 152
|align="right"| -1050
|align="right"| 20
|align="right"| -1750
|-
| NS
| Fallgourd Lake
|align="right"| 152
|align="right"| -1500
|align="right"| 35
|align="right"| -1925
|-
| NS
| Coerthas
|align="right"| 152
|align="right"| -1625
|align="right"| 20
|align="right"| -1925
|-
| NS
| The Mun-Tuy Cellars (24-18)
|align="right"| 152
|align="right"| -700
|align="right"| 20
|align="right"| -1925
|-
| NS
| Treespeak
|align="right"| 152
|align="right"| -900
|align="right"| 35
|align="right"| -2175
|-
| NS
| Ixali Clearing
|align="right"| 152
|align="right"| -800
|align="right"| 5
|align="right"| -2345
|-
| NS
| Hyristmill
|align="right"| 152
|align="right"| -600
|align="right"| 5
|align="right"| -2400
|-
| NS
| The Mun-Tuy Cellars (20-13)
|align="right"| 152
|align="right"| -1025
|align="right"| 5
|align="right"| -2425
|-
| NS
| Alder Springs
|align="right"| 152
|align="right"| -1575
|align="right"| 15
|align="right"| -2575
|-
| NS
| Lasthold
|align="right"| 152
|align="right"| -800
|align="right"| 30
|align="right"| -2800
|}

==== Tam-Tara Deepcroft ====
==== The Mun-Tuy Cellars ====

=== Thanalan ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | Thanalan Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| WT
| Camp Horizon
|align="right"| 172
|align="right"| -1300
|align="right"| 55
|align="right"| -150
|-
| WT
| Copperbell Mines
|align="right"| 172
|align="right"| -750
|align="right"| 120
|align="right"| -100
|-
| WT
| Nophica's Wells
|align="right"| 172
|align="right"| -875
|align="right"| 90
|align="right"| 375
|-
| WT
| Scorpion Keep
|align="right"| 172
|align="right"| -1225
|align="right"| 60
|align="right"| 200
|-
| WT
| The Silver Bazaar
|align="right"| 172
|align="right"| -1375
|align="right"| 60
|align="right"| 575
|-
| WT
| The Coffer & Coffin
|align="right"| 172
|align="right"| -1750
|align="right"| 55
|align="right"| -325
|-
| WT
| The Footfalls
|align="right"| 172
|align="right"| -1650
|align="right"| 25
|align="right"| -475
|-
| WT
| Ferry Docks
|align="right"| 172
|align="right"| -2210
|align="right"| 15
|align="right"| -400
|-
| WT
| Chocobo Stables
|align="right"| 172
|align="right"| -2200
|align="right"| 15
|align="right"| -425
|-
| CT
| Ul'dah (26-30)
|align="right"| 170
|align="right"| -25
|align="right"| 185
|align="right"| -75
|-
| CT
| Ul'dah (27-32)
|align="right"| 170
|align="right"| 125
|align="right"| 185
|align="right"| 225
|-
| CT
| Cactus Basin
|align="right"| 170
|align="right"| 625
|align="right"| 185
|align="right"| 125
|-
| CT
| Four Sisters
|align="right"| 170
|align="right"| 525
|align="right"| 220
|align="right"| 0
|-
| CT
| Camp Black Brush
|align="right"| 170
|align="right"| 35
|align="right"| 200
|align="right"| -475
|-
| CT
| Nanawa Mines
|align="right"| 170
|align="right"| 90
|align="right"| 185
|align="right"| -1050
|-
| ET
| Camp Drybone
|align="right"| 171
|align="right"| 1250
|align="right"| 265
|align="right"| -550
|-
| ET
| The Golden Bazaar
|align="right"| 171
|align="right"| 1125
|align="right"| 315
|align="right"| -1080
|-
| ET
| Thal's Respite
|align="right"| 171
|align="right"| 1675
|align="right"| 285
|align="right"| -1100
|-
| ET
| The Black Shroud
|align="right"| 171
|align="right"| 2047
|align="right"| 280
|align="right"| 1219
|-
| ET
| The Burning Wall
|align="right"| 171
|align="right"| 2000
|align="right"| 280
|align="right"| -760
|-
| ET
| Mythril Pit T-8
|align="right"| 171
|align="right"| 1355
|align="right"| 255
|align="right"| -224
|-
| ET
| Halatali
|align="right"| 171
|align="right"| 1600
|align="right"| 255
|align="right"| -225
|-
| ET
| Amalj'aa Encampment
|align="right"| 171
|align="right"| 2050
|align="right"| 265
|align="right"| -325
|-
| ET
| Little Ala Mhigo
|align="right"| 171
|align="right"| 1150
|align="right"| 250
|align="right"| 190
|-
| ET
| Amalj'aa Altar
|align="right"| 171
|align="right"| 1475
|align="right"| 250
|align="right"| 250
|-
| ET
| Sandgate
|align="right"| 171
|align="right"| 2000
|align="right"| 250
|align="right"| 75
|-
| ST
| Camp Broken Water
|align="right"| 174
|align="right"| 1700
|align="right"| 300
|align="right"| 1000
|-
| ST
| Nald's Reflection
|align="right"| 174
|align="right"| 950
|align="right"| 315
|align="right"| 700
|-
| ST
| Burnt Lizard Creek
|align="right"| 174
|align="right"| 1175
|align="right"| 280
|align="right"| 1400
|-
| ST
| Zahar'ak
|align="right"| 174
|align="right"| 2125
|align="right"| 300
|align="right"| 1025
|-
| ST
| The Red Labyrinth
|align="right"| 174
|align="right"| 1800
|align="right"| 250
|align="right"| 1850
|-
| ST
| Zanr'ak
|align="right"| 174
|align="right"| 2400
|align="right"| 250
|align="right"| 1525
|-
| NT
| Camp Bluefog
|align="right"| 173
|align="right"| -175
|align="right"| 280
|align="right"| -1700
|-
| NT
| Cutter's Cry
|align="right"| 173
|align="right"| 25
|align="right"| 280
|align="right"| -1675
|-
| NT
| Hidden Gorge
|align="right"| 173
|align="right"| -625
|align="right"| 280
|align="right"| -1800
|-
| NT
| Cutter's Pass
|align="right"| 173
|align="right"| -700
|align="right"| 280
|align="right"| -2200
|-
| NT
| Sea of Spires
|align="right"| 173
|align="right"| 450
|align="right"| 260
|align="right"| -2150
|-
| NT
| Mor Dhona
|align="right"| 173
|align="right"| 0
|align="right"| 270
|align="right"| -2825
|}

==== Copperbell Mines ====
==== Nanawa Mines ====

=== Coerthas ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | Coerthas Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| CCH
| Gates of Judgment
|align="right"| 143
|align="right"| -200
|align="right"| 290
|align="right"| -300
|-
| CCH
| Camp Dragonhead
|align="right"| 143
|align="right"| 200
|align="right"| 300
|align="right"| -250
|-
| CCH
| Prominence Point
|align="right"| 143
|align="right"| 200
|align="right"| 365
|align="right"| -650
|-
| CCH
| Natalan
|align="right"| 143
|align="right"| 500
|align="right"| 305
|align="right"| -200
|-
| CCH
| Feathergorge
|align="right"| 143
|align="right"| 950
|align="right"| 290
|align="right"| -20
|-
| CCH
| Dzemael Darkhold
|align="right"| 143
|align="right"| -75
|align="right"| 250
|align="right"| 400
|-
| CCH
| Boulder Downs
|align="right"| 143
|align="right"| -525
|align="right"| 210
|align="right"| 550
|-
| CCH
| Griffin Crossing
|align="right"| 143
|align="right"| 735
|align="right"| 240
|align="right"| 640
|-
| CCH
| Gargoyle Crossing
|align="right"| 143
|align="right"| -1175
|align="right"| 245
|align="right"| 0
|-
| CWH
| Camp Riversmeet
|align="right"| 148
|align="right"| -1750
|align="right"| 270
|align="right"| -200
|-
| CWH
| Dusk Vigil
|align="right"| 148
|align="right"| -1835
|align="right"| 370
|align="right"| -705
|-
| CWH
| Wyrmking's Perch
|align="right"| 148
|align="right"| -1740
|align="right"| 285
|align="right"| -835
|-
| CWH
| The Lance
|align="right"| 148
|align="right"| -2375
|align="right"| 340
|align="right"| -1050
|-
| CWH
| Twinpool
|align="right"| 148
|align="right"| -2800
|align="right"| 260
|align="right"| -275
|-
| CWH
| Falcon's Nest
|align="right"| 148
|align="right"| -1660
|align="right"| 310
|align="right"| 825
|-
| CEH
| Camp Crooked Fork
|align="right"| 144
|align="right"| 1120
|align="right"| 270
|align="right"| -1150
|-
| CEH
| Dawn Vigil
|align="right"| 144
|align="right"| 675
|align="right"| 255
|align="right"| -955
|-
| CEH
| Gwyr-Aen
|align="right"| 144
|align="right"| 650
|align="right"| 300
|align="right"| -1400
|-
| CEH
| Maiden Glen
|align="right"| 144
|align="right"| 1725
|align="right"| 180
|align="right"| -1250
|-
| CEH
| Hushed Boughs
|align="right"| 144
|align="right"| 1400
|align="right"| 225
|align="right"| -725
|-
| CEH
| Scarwing Fall
|align="right"| 144
|align="right"| 1800
|align="right"| 165
|align="right"| -825
|-
| CCL
| Camp Ever Lakes
|align="right"| 147
|align="right"| -150
|align="right"| 225
|align="right"| 1150
|-
| CCL
| The Aurum Vale
|align="right"| 147
|align="right"| -375
|align="right"| 245
|align="right"| 1400
|-
| CCL
| Teriggan's Stand
|align="right"| 147
|align="right"| 0
|align="right"| 145
|align="right"| 1375
|-
| CCL
| Shepherd Peak
|align="right"| 147
|align="right"| -50
|align="right"| 180
|align="right"| 1935
|-
| CCL
| Fellwood
|align="right"| 147
|align="right"| -900
|align="right"| 195
|align="right"| 2150
|-
| CCL
| Mor Dhona
|align="right"| 147
|align="right"| 150
|align="right"| 135
|align="right"| 2725
|-
| CEL
| Camp Glory
|align="right"| 145
|align="right"| 1500
|align="right"| 205
|align="right"| 775
|-
| CEL
| Ixali Encampment
|align="right"| 145
|align="right"| 1125
|align="right"| 220
|align="right"| 1050
|-
| CEL
| Weeping Vale
|align="right"| 145
|align="right"| 1400
|align="right"| 230
|align="right"| 425
|-
| CEL
| Clearwater
|align="right"| 145
|align="right"| 2150
|align="right"| 145
|align="right"| 625
|-
| CEL
| Clearwater Lake
|align="right"| 145
|align="right"| 2375
|align="right"| 145
|align="right"| 550
|-
| CEL
| The Black Shroud
|align="right"| 145
|align="right"| 1825
|align="right"| 150
|align="right"| 1850
|}

=== Mor Dhona ===
{| class="wikitable sortable mw-collapsible mw-collapsed"
|+ style="width: 200px;" | Mor Dhona Proper
!Region
!Name
!ZoneID
!X
!Y
!Z
|-
| MD
| Camp Reveant's Toll
|align="right"| 190
|align="right"| -220
|align="right"| 20
|align="right"| -675
|-
| MD
| Coerthas
|align="right"| 190
|align="right"| 275
|align="right"| 45
|align="right"| -925
|-
| MD
| The Black Shroud
|align="right"| 190
|align="right"| 900
|align="right"| 35
|align="right"| -200
|-
| MD
| Singing Shards
|align="right"| 190
|align="right"| 575
|align="right"| 60
|align="right"| 200
|-
| MD
| Camp Brittlebark
|align="right"| 190
|align="right"| 475
|align="right"| 20
|align="right"| 675
|-
| MD
| Thanalan
|align="right"| 190
|align="right"| -400
|align="right"| 10
|align="right"| 850
|-
| MD
| Silvertear Lake
|align="right"| 190
|align="right"| 125
|align="right"| 20
|align="right"| 375
|-
| MD
| Jagged Crest Cave
|align="right"| 190
|align="right"| -350
|align="right"| -15
|align="right"| -25
|-
| MD
| Castrum Novum
|align="right"| 190
|align="right"| -600
|align="right"| 0
|align="right"| -75
|-
| MD
| Fogfens
|align="right"| 190
|align="right"| -450
|align="right"| -40
|align="right"| -325
|}

== Duties ==
=== Instanced Dungeons ===
==== The Thousand Maws of Toto-Rak ====
==== Cutter's Cry ====
==== Dzemael Darkhold ====
==== The Aurum Vale ====
=== Trials ===
{| class="wikitable sortable"
|+ Trials
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| MD
| Castrum Novum Transmission Tower
| 190
| 0
| -100
| 0
|-
| R
| Rivenroad
| 257
| 0
| 0
| 0
|}

{| class="wikitable sortable"
|+ Primals
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| S
| Thornmarch
|align="right"| 238
|align="right"| -2370
|align="right"| -22
|align="right"| -890
|-
| T
| The Bowl of Embers
|align="right"| 240
|align="right"| 2360
|align="right"| 260
|align="right"| 2200
|-
| C
| The Howling Eye
|align="right"| 239
|align="right"| 1400
|align="right"| 310
|align="right"| -295
|}

{| class="wikitable sortable"
|+ The Cieldalaes
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| L
| Hope's Bourn
|align="right"| 128
|align="right"| 2035
|align="right"| 50
|align="right"| 1450
|-
| L
| Turtleback Island
|align="right"| 237
|align="right"| 3050
|align="right"| 40
|align="right"| 500
|-
| L
| Locke's Lie
|align="right"| 236
|align="right"| 950
|align="right"| 1
|align="right"| 1040
|}

{| class="wikitable sortable"
|+ Hamlet Defense
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| L
| the Battle for Aleport
|
|
|
|
|-
| S
| the Battle for Hyrstmill
|
|
|
|
|-
| T
| the Battle for the Golden Bazaar
|
|
|
|
|}

== Other ==
=== Special Regions ===
{| class="wikitable sortable"
|+ Ocean
! Name
! ZoneID
! RegionID
! X
! Y
! Z
|-
| "Limsa Boat"
|align="right"| 139
|align="right"| 112
|align="right"| -608
|align="right"| 12
|align="right"| -608
|-
| "Large Ship"
|align="right"| 139
|align="right"| 112
|align="right"| 608
|align="right"| 15
|align="right"| 600
|-
| "Large War Ship"
|align="right"| 139
|align="right"| 112
|align="right"| 1823
|align="right"| 15
|align="right"| 1815
|-
| "Fishing Boat"
|align="right"| 139
|align="right"| 112
|align="right"| -1824
|align="right"| 10
|align="right"| -1838
|-
| "Sahagin Boat"
|align="right"| 139
|align="right"| 112
|align="right"| -3040
|align="right"| 12
|align="right"| -3040
|-
| "Pirate Boat"
|align="right"| 139
|align="right"| 112
|align="right"| 3040
|align="right"| 16
|align="right"| 3054
|-
| "Dinghy"
|align="right"| 139
|align="right"| 112
|align="right"| 608
|align="right"| 5
|align="right"| -608
|}

=== Unfinished/Beta Content ===
{| class="wikitable sortable"
|+ Unfinished Trials
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| L
| "The Navel"
|align="right"| 128
|align="right"| 385
|align="right"| -20
|align="right"| -3040
|-
| L
| "Copy of Turtleback Island?"
|align="right"| 128
|align="right"| 2680
|align="right"| 45
|align="right"| 2400
|}

{| class="wikitable sortable"
|+ Unfinished Dungeons
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| S
| "Unused Tam Tara Map?"
|align="right"| 150
|align="right"| 1585
|align="right"| 25
|align="right"| -400
|-
| C
| "The Aery"
|align="right"| 143
|align="right"| -2085
|align="right"| 310
|align="right"| -1215
|-
| C
| "Hengr's Crucible"
|align="right"| 143
|align="right"| 1570
|align="right"| 340
|align="right"| -2050
|-
| C
| "The Fesse"
|align="right"| 143
|align="right"| 1760
|align="right"| 180
|align="right"| 180
|}

=== Others ===
{| class="wikitable sortable"
|+ The Twelve
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| MD
| "Thaliak's Rune"
|align="right"| 190
|align="right"| -540
|align="right"| -40
|align="right"| 225
|}

{| class="wikitable sortable"
|+ Misc
! Zone
! Name
! ZoneID
! X
! Y
! Z
|-
| S
| "Farm"
|align="right"| 150
|align="right"| 465
|align="right"| 15
|align="right"| -2022
|-
| S
| "Clearing"
|align="right"| 150
|align="right"| 465
|align="right"| 12
|align="right"| -2350
|}

Setting up the project

2018-03-06T00:36:19Z

Unnamed mercenary: /* Setting Up the Login Server */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''FFXIVClassic.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic' (5 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 5 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy all of the '''www/login_su''' folder contents from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
: 1. Confirm all WAMP/web services are running
: 2. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
: 3. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''
: 4. Run the map server: '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\FFXIVClassic World Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2018-03-06T00:33:23Z

Unnamed mercenary: /* Setting Up the Login Server */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''FFXIVClassic.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic' (5 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 5 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy all of the '''www''' folder contents from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\login_su\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
: 1. Confirm all WAMP/web services are running
: 2. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
: 3. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''
: 4. Run the map server: '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\FFXIVClassic World Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2018-03-06T00:31:42Z

Unnamed mercenary: /* Starting the servers */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''FFXIVClassic.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic' (5 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 5 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy the '''www''' folder from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
: 1. Confirm all WAMP/web services are running
: 2. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
: 3. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''
: 4. Run the map server: '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\FFXIVClassic World Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2018-03-06T00:30:50Z

Unnamed mercenary: /* Compiling Lobby and Game Server */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''FFXIVClassic.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic' (5 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 5 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy the '''www''' folder from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
</div>

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Starting the servers ===
:1. Confirm all WAMP/web services are running
:1. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
:2. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2018-03-06T00:30:28Z

Unnamed mercenary: /* Compiling Lobby and Game Server */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''FFXIVClassic.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic' (5 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 5 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy the '''www''' folder from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly

==== Setting up Lobby, World and Map Servers ====
# '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations '''<Classic Server source location>\data\(lobby/map/world)_config.ini''' '''<SQL database>\ffxiv_server\servers''' '''<SQL database>\ffxiv_server\server_zones''' *if the map servers are not on the same server as world server
# Copy '''lobby_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\'''
# Copy '''map_config.ini''', '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
# Copy world'''_config.ini''' from '''<Classic Server source location>/data/'''
#: to '''<Classic Server source location>\FFXIVClassic World Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
</div>

=== Starting the servers ===
:1. Confirm all WAMP/web services are running
:1. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
:2. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2017-10-06T16:11:32Z

Unnamed mercenary: /* Building */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.5
:2. Open '''FFXIVClassic.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic' (5 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 5 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy the '''www''' folder from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
</div>

=== Starting the servers ===
:1. Confirm all WAMP/web services are running
:1. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
:2. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2017-10-06T16:05:42Z

Unnamed mercenary: /* Compiler Requirements */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
! Notes
|-
| Visual Studio 2017
| style="background: green; color: white; text-align: center;" | Officially supported
| Users will need to manually select the NuGet and <br> .Net 4.5 modules when installing.
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|
|-
| Visual Studio 2013
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
| Users may need to install a modern compiler via NuGet,<br> or will receive errors from the source.
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.5
| style="background: green; color: white; text-align: center;" | Officially supported
|}

{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.0
:2. Open '''FFXIVClassic Map Server.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic Map Server' (3 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 3 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy the '''www''' folder from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
</div>

=== Starting the servers ===
:1. Confirm all WAMP/web services are running
:1. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
:2. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2017-10-06T16:04:58Z

Unnamed mercenary: /* Running the Server */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
|-
| Visual Studio 2013*
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| Visual Studio 15 Preview
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.0
| style="background: green; color: white; text-align: center;" | Officially supported
|}
'''Note:''' Community editions of Visual Studio are acceptable <br>
'''Note:''' In addition to the OS requirements as stated above <br>
'''*Visual Studio 2013 users may need to install a modern compiler via NuGet, or will receive errors from the source.
</span>
{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.0
:2. Open '''FFXIVClassic Map Server.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic Map Server' (3 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 3 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy the '''www''' folder from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
</div>

=== Starting the servers ===
:1. Confirm all WAMP/web services are running
:1. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
:2. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account

Setting up the project

2017-10-06T15:41:34Z

Unnamed mercenary: /* Running the Server */

<div style="float:right;">__TOC__</div>
:''Updated as of commit a4d3e91 (2016-07-27)''
== Introduction ==
: Final Fantasy XIV 1.0, like most large scale MMO's, consists of multiple servers working in unison to manage connected clients and their interactions with the game world.

=== Server Layout ===
: A working install of Classic Server installation consists of the following:
::1. '''Login Server:''' A web server that manages user accounts and the login process for the game client
::2. '''Database Server:''' Contains the user accounts, their characters, and game assets (such as item and NPC information)
::3. '''Lobby Server:''' Manages the characters associated with each user account, and their connection states, also tracks the status of the game servers
::4. '''Game Servers:''' Game Server instances (one instance per world) that tracks the player state and interacts with the client as the user plays the game

<div style="float:left; margin: 25 px;">
{| class="wikitable"
|+ Official game server layout
|-
|
1. World 1 Game Server
:* Region 1-A Game Server
:* Region 1-B Game Server
:* ...
:* Region 1-N Game Server
2. World 2 Game Server
:* Region 2-A Game Server
:* Region 2-B Game Server
:* ...
:* Region 2-N Game Server
3. World 3 Game Server <br>
... <br>
N. World N Game Server
|}
</div>

: While there can be multiple game servers to represent multiple worlds, there are only a single Login/Lobby/Database server per site. The servers do not require that they are all installed on the same machine, only that they can communicate with each other, either though the local network, or though the internet. A small installation might consist of all 4 servers being hosted on the same machine as the client, whereas a large install might have each individual server hosted on separate OS/machine instances.

: Unlike the official/retail servers, currently there can only be a single game server instance per world. Future plans are to optionally break up the game server to be per region, instead of one game server per world, similar to how the official servers run.

=== Running and installing Classic Server ===
: Unlike the game client, which mainly consists of installing, launching, and optionally patching the game as needed, setting up a working Classic Server site requires the ability to install multiple pieces of software and configuring them so that the servers can communicate with each other.

: A person interested in setting up their own Classic Server site must be able to do the following:
:# Have the ability to install software on one or more machines, and following the instructions on how to do so
:# Understand how to find their IP and what an IP is
:# Understand the basic concepts what GIT is and compiling software (actual ability to code is not required)
:# Able to read and understand tables of data/database entries (extensive SQL knowledge is not required)

{{clear}}
== Requirements ==
=== Running the Server ===
{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Operating Systems
|-
! Name
! Support Level
|-
| Windows 7
| style="background: green; color: white; text-align: center;" | Officially Supported
|-
| Windows 8.1
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1703
| style="background: green; color: black; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1607
| style="background: green; color: black; text-align: center;" | Officially Supported
|-
| Windows 10 Version 1511
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 10 Version 1507
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows Server 2016
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Windows 8
|style="background: orange; color: black; text-align: center;" | Should work/Untested
|-
| Windows XP (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|-
| Windows Vista
| style="background: red; color: white; text-align: center;" | Unsupported
|}
<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Web Server
! Name
! Support Level
|-
| style="width: 170px" | Apache 2.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| style="width: 170px" | nginx 1.10 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | SQL Engine
! Name
! Support Level
|-
| style="width: 170px" | MySQL 5.7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| MariaDB 10.1 (or newer)
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|}
{| class="wikitable"
|+ style="text-align: center;" | PHP Processor
! Name
! Support Level
|-
| style="width: 170px" | PHP 7 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|}
</span>

{{clear}}

=== Running the client ===
{| class="wikitable"
|+ style="text-align: center;" | Client Requirements
! Name
! Version
|-
| Final Fantasy XIV 1.23b
| 2012.09.19.0001
|-
| [http://seventhumbral.org/downloads.php Seventh Umbral Launcher]
| [http://seventhumbral.org/downloads/launcher/sumlauncher-1.03.exe 1.03]
|}
{{clear}}
'''Note:''' The Seventh Umbral Launcher can patch any existing client install to the latest version

{{clear}}
=== Optional Downloads/Quick-setup ===
* [http://www.wampserver.com/en/#download-wrapper WAMP All in one installer]: Quick-setup installer that includes the following:
{| class="wikitable"
|-
| '''A'''pache || '''M'''ySQL || '''P'''HP
|}

* [http://www.heidisql.com/ HeidiSQL]: A SQL manager/GUI
* [https://www.sourcetreeapp.com/ SourceTree]: A git client

== Compiling from source ==
=== Compiler Requirements ===

{| class="wikitable" style="float:left; margin: 10px;"
|+ style="text-align: center;" | Compiler/IDEs
! Name
! Support Level
|-
| Visual Studio 2013*
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| Visual Studio 2015
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| Visual Studio 15 Preview
| style="background: yellow; color: black; text-align: center;" | Works/Unsupported
|-
| Visual Studio 2012 (or older)
| style="background: red; color: white; text-align: center;" | Unsupported
|}

<span style="float:left; clear:left; margin: 10px;">
{| class="wikitable"
|+ style="text-align: center;" | Compiler Addons
! Name
! Version
|-
| NuGet 3.4 (or newer)
| style="background: green; color: white; text-align: center;" | Officially supported
|-
| NET Framework 4.0
| style="background: green; color: white; text-align: center;" | Officially supported
|}
'''Note:''' Community editions of Visual Studio are acceptable <br>
'''Note:''' In addition to the OS requirements as stated above <br>
'''*Visual Studio 2013 users may need to install a modern compiler via NuGet, or will receive errors from the source.
</span>
{{clear}}

=== Compiling ===

==== Getting the Source Code ====
<div style="padding-left:2em;">
===== Via Sourcetree =====
:1. Download and install SourceTree
:2. [sourcetree://cloneRepo/https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Clone in Sourcetree]
:3. Select folder to clone source code to
===== Manually via Bitbucket =====
:1. Go to the [https://bitbucket.org/Ioncannon/ffxiv-classic-server.git Server source code]
:2. Click the "Downloads" button on the sidebar
:3. Click "Download Repository"
:4. Extract to desired folder
</div>

==== Building ====
:1. Set up your compile environment/IDE to support compiling NET 4.0
:2. Open '''FFXIVClassic Map Server.sln''' from where the source code was copied to in the previous steps
:3. Get the dependencies via NuGet
::Select the '''Solution Explorer''' Tab
::Right Click '''Solution 'FFXIVClassic Map Server' (3 Projects)'''
::Select '''Restore NuGet Packages'''
:4. Select ''Debug''/''Release'' (as desired)
:5. Go to the '''Build''' Menu and select '''Build Solution'''
:: '''Note:''' You do not need to do this step until you have finished configuring your server below
:6. If everything compiled correctly, the output log should look like:
<code> ========== Build: 3 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== </code>

== Server Setup ==

=== Setting up with WAMP ===

==== Installing WAMP ====
:1. Download and install WAMP
:2. Start the server by clicking on the '''WampServer64''' icon created by the installer
:3. Verify all services are properly started by checking on the '''W''' Icon in the notification bar:
::* Green: All services started properly
::* Yellow: Some services started properly
::* Red: All services have stopped
'''Note:''' Start/restart/stop the WAMP server by clicking on the '''W''' icon and selecting Start/Stop/Restart All Services

==== Setting Up the Database ====
:1. Confirm all WAMP services are installed
:2. Left Click the WAMP status icon
:3. Open '''MySQL''' → '''my.ini'''
:4. Find the line containing
::<code>sql-mode="STRICT_ALL_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ZERO_DATE,NO_ZERO_IN_DATE,NO_AUTO_CREATE_USER"</code>
::and change it to
::<code>sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>
:5. Restart the MySQL service (if not already started) by left clicking the WAMP status icon and selecting '''MySQL''' → '''Service Administration''' → '''Restart Service'''
:6. Download, install, and run HeidiSQL
:7. Select the '''New''' button to create a new connection and select '''Open'''
:: '''Note:''' If the SQL server IP/username/password differ from the defaults, change them here, otherwise continue to the next step
:8. Verify you are connected:
:: A newly set up/blank mysql server should have the following databases listed:
:::{| class="wikitable"
|+ Default tables
|-
| information_schema || mysql || performance_schema || sys
|}
:9. Right Click '''Unnamed''' and go to '''Create new''' → '''Database''' and name the new database: '''ffxiv_server'''
:: '''Note:''' If you changed the name of the server in step 3, the name will be that instead of '''Unnamed'''
:10. Click the new '''ffxiv_server''' database entry
:11. Go to '''File''' → '''Run SQL File''' and navigate to the '''<Classic Server source code location>\sql\''' folder
:12. Select all SQL files in the folder, and execute them.
:: '''Note:''' HeidiSQL may warn you about mixed linebreaks, or an empty warning prompt after executing the query. Ignore them, it'll still run the query successfully.

==== Setting Up the Login Server ====
:1. Confirm all WAMP services are running
:2. Navigate to the location of the server source code
:3. Copy the '''www''' folder from the source code folder to the WAMP install location
:: The default location is: '''C:\wamp64\www'''
:4. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:5. Restart the WAMP services

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' If the server and client are on different machines, edit the server IPs in the following locations:
::* '''<Classic Server source location>\data\config.ini'''
::* '''<SQL database>\ffxiv_server\servers'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''

=== Installing Manually ===
<div style="padding-left:2em;">
==== Requirements ====
:1. Install and start desired web server
:2. Install and start desired PHP processor
:3. Install and start desired SQL engine

==== Database ====
:1. Create a database named '''ffxiv_server'''
:2. Confirm that the sql server is set with the following behavioral defaults:
sql-mode="NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
:3. Load the SQL files of '''<Classic Server source code location>\sql\''' into the database

==== Login Server ====
:1. Copy the following to web server: '''<Classic Server source location>\www'''
:2. '''OPTIONAL:''' If you have modified the database login settings, change them at:
:: '''<web server www folder>\config.php'''
:3. Restart the web server service
:4. Navigate to '''<nowiki>http://<web server ip>/create_user.php</nowiki>''' and create a new account

==== Compiling Lobby and Game Server ====
:1. Navigate to the location the game client has been installed to and copy the following file:
:: '''<FINAL FANTASY XIV client install location>\client\script\rq9q1797qvs.san'''
:2. Navigate to the location of the server source code and rename '''rq9q1797qvs.san''' to:
:: '''<Classic Server source location>\data\staticactors.bin'''
:3. '''OPTIONAL:''' You can configure the IP address, port, database name, and database password for both the lobby server and map server under:
::* '''<Classic Server source location>\data\'''
:4. Compile the server (See [[#Compiling]])
:: '''Note:''' If you had compiled it before this, use '''Rebuild Solution''' instead of '''Build Solution''' to confirm that all the data files are copied properly
:5. Copy '''staticactors.bin''' and the '''scripts''' folder from '''<Classic Server source location>/data/'''
:: to '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\'''
</div>

=== Starting the servers ===
:1. Confirm all WAMP/web services are running
:1. Run the lobby server: '''<Classic Server source location>\FFXIVClassic Lobby Server\bin\(Debug\Release)\FFXIVClassic_Lobby_Server.exe'''
:2. Run the map server: '''<Classic Server source location>\FFXIVClassic Map Server\bin\(Debug\Release)\FFXIVClassic Map Server.exe'''

== Client Setup ==
=== Configuring the client ===
:1. Install the Final Fantasy XIV client
:2. Install the Seventh Umbral launcher
:3. Open '''<Seventh Umbral launcher install location>\servers.xml'''
:4. Create a new entry:
<pre><Server Name="Localhost" Address="127.0.0.1" LoginUrl="http://localhost/login.php" /></pre>
:: '''Note:''' If the server is on a different machine then the client, change '''Address''' and '''LoginUrl''' to reflect that
:5. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:6. Go to '''Game Settings''' and enter the path to '''<FINAL FANTASY XIV client install location>'''
:7. Restart the launcher and patch client if necessary
:8. [http://localhost/create_user.php Make an account]
<pre>http://localhost/create_user.php</pre>
:: '''Note:''' If the server is on a different machine, use it's IP instead of localhost

=== Starting the client ===
:1. Run '''<Seventh Umbral launcher install location>\Launcher.exe'''
:2. Select the correct server from the '''Server''' dropdown box
:3. Log in with previously created account