ablaise/meteion

Meteion is a straightforward PHP tool that loads FFXIV client data into a relational database.

0.1.2 2022-05-02 17:00 UTC

Requires

• php: ^7.1|^8.0
• doctrine/annotations: ^1.0
• doctrine/doctrine-bundle: ^2.5
• doctrine/orm: ^2.10
• symfony/property-access: ^5.3|^6.0
• symfony/serializer: ^5.3|^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpunit/phpunit: ^9.0

MIT

• Alexis BLAISE

README

Meteion is a straightforward PHP tool that loads FFXIV client data into a relational database.

Compatibility

Meteion is compatible with Endwalker patch 6.1 Newfound Adventure.

Getting Started

First, you need to extract the FFXIV client using SaintCoinach.

You can simply extract the client in the language you are interested in using the following command.

./SaintCoinach.Cmd.exe "C:\Program Files (x86)\SquareEnix\FINAL FANTASY XIV - A Realm Reborn" "lang English" rawexd

For more information, please refer to the SaintCoinach documentation.

Requirement

Meteion works with PHP 7.1 and above.

Installation

composer require ablaise/meteion

Usage

You can use the following code to start loading the data.

<?php

include './vendor/autoload.php';

use Meteion\Meteion;

$rawexd = '/path/to/rawexd';
$connection = [
	'dbname' => 'xiv',
	'user' => 'username',
	'password' => 'password',
	'host' => 'localhost',
	'port' => '5432',
	'driver' => 'pdo_pgsql',
];

$meteion = new Meteion($rawexd, $connection);
$meteion->run();

Please note that this may take some time depending on your server configuration. For now, only PostgreSQL is fully supported.

Symfony Integration

See MeteionBundle.

Known issues

At the moment, tables chara_make_type and story cannot be created.

What's next?

• Multiple DBMS support
• Symfony integration (MeteionBundle)
• Speed improvement
• Better tests
• Error handling
• Bugfixes

This is still an alpha version under development, some serious changes may occur.