/Universalis

A crowdsourced market board API for FFXIV.

Primary LanguageC#MIT LicenseMIT

Documentation Codacy Badge Security Headers

Universalis

A crowdsourced market board aggregator for the game FINAL FANTASY XIV.

API Reference

Please refer to the documentation for basic usage information.

API Development

Developing and testing the API server requires Visual Studio 2022 Preview, as it targets .NET 6.

This application uses some F# code, which needs to be built before IntelliSense can navigate it. If you get any undefined references to F# code, just build the Universalis.DataTransformations project.

Frontend Development

The frontend is housed on our mogboard repo, where contributions are welcome.

Upload Software Development

Please see goat's ACT plugin for an example of how to collect and upload market board data.

Development

Requires .NET 6, PostgreSQL, MariaDB, and Redis. A development environment is provided as a Docker Compose specification in the devenv folder for simpler setup.

MariaDB commands:

CREATE DATABASE `dalamud`;
CREATE USER 'dalamud'@localhost IDENTIFIED BY 'dalamud';
GRANT ALL PRIVILEGES ON `dalamud`.* TO 'dalamud'@localhost IDENTIFIED BY 'dalamud';
FLUSH PRIVILEGES;