mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
44 lines
3 KiB
Markdown
44 lines
3 KiB
Markdown
# Dalamud [](https://discord.gg/3NMcUV5)
|
|
|
|
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/goatcorp/DalamudAssets/master/UIRes/logo.png" alt="Dalamud" width="200"/>
|
|
</p>
|
|
|
|
Dalamud is a plugin development framework for FFXIV that provides access to game data and native interoperability with the game itself to add functionality and quality-of-life.
|
|
|
|
It is meant to be used in conjunction with [XIVLauncher](https://github.com/goatcorp/FFXIVQuickLauncher), which manages and launches Dalamud for you. __It is generally not recommended for end users to try to run Dalamud manually as XIVLauncher manages multiple required dependencies.__
|
|
|
|
## Hold Up!
|
|
|
|
If you are just trying to **use** Dalamud, you don't need to do anything on this page - please [download XIVLauncher](https://goatcorp.github.io/) from its official page and follow the setup instructions.
|
|
|
|
## Building and testing locally
|
|
|
|
Please check the [docs page on building Dalamud](https://dalamud.dev/building) for more information and required dependencies.
|
|
|
|
## Plugin development
|
|
Dalamud features a growing API for in-game plugin development with game data and chat access and overlays.
|
|
Please see our [Developer FAQ](https://goatcorp.github.io/faq/development) and the [API documentation](https://dalamud.dev) for more details.
|
|
|
|
If you need any support regarding the API or usage of Dalamud, please [join our discord server](https://discord.gg/3NMcUV5).
|
|
|
|
<br>
|
|
|
|
Thanks to Mino, whose work has made this possible!
|
|
|
|
## Components & Pipeline
|
|
|
|
These components are used in order to load Dalamud into a target process.
|
|
Dalamud can be loaded via DLL injection, or by rewriting a process' entrypoint.
|
|
|
|
| Name | Purpose |
|
|
|-------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
|
| *Dalamud.Injector.Boot* (C++) | Loads the .NET Core runtime into a process via hostfxr and kicks off Dalamud.Injector |
|
|
| *Dalamud.Injector* (C#) | Performs DLL injection on the target process |
|
|
| *Dalamud.Boot* (C++) | Loads the .NET Core runtime into the active process and kicks off Dalamud, or rewrites a target process' entrypoint to do so |
|
|
| *Dalamud* (C#) | Core API, game bindings, plugin framework |
|
|
| *Dalamud.CorePlugin* (C#) | Testbed plugin that can access Dalamud internals, to prototype new Dalamud features |
|
|
|
|
<br>
|
|
|
|
##### Final Fantasy XIV © 2010-2021 SQUARE ENIX CO., LTD. All Rights Reserved. We are not affiliated with SQUARE ENIX CO., LTD. in any way.
|