Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goatcorp/Dalamud
FFXIV plugin framework and API
https://github.com/goatcorp/Dalamud
ffxiv
Last synced: 3 months ago
JSON representation
FFXIV plugin framework and API
- Host: GitHub
- URL: https://github.com/goatcorp/Dalamud
- Owner: goatcorp
- License: agpl-3.0
- Created: 2019-09-21T13:27:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T12:28:30.000Z (3 months ago)
- Last Synced: 2024-10-29T14:54:25.781Z (3 months ago)
- Topics: ffxiv
- Language: C#
- Homepage:
- Size: 40.4 MB
- Stars: 1,181
- Watchers: 28
- Forks: 272
- Open Issues: 185
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-buttplug - Dalamud
- AiTreasureBox - goatcorp/Dalamud - 02-01_1285_0](https://img.shields.io/github/stars/goatcorp/Dalamud.svg)|FFXIV plugin framework and API| (Repos)
README
# Dalamud [](https://github.com/goatcorp/Dalamud/actions) [](https://discord.gg/3NMcUV5)
Dalamud is a plugin development framework for FINAL FANTASY XIV 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 [FFXIVQuickLauncher](https://github.com/goatcorp/FFXIVQuickLauncher), which manages and launches Dalamud for you. __It is generally not recommended for users to try to run Dalamud manually as there are multiple dependencies and assumed folder paths.__
## 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.
## 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).
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 |
## Branches
We are currently working from the following branches.
| Name | API Level | Purpose | .NET Version | Track |
|----------|-----------|------------------------------------------------------------|----------------------------|-------------------|
| *master* | **9** | Current release branch | .NET 8.0.0 (November 2023) | Release & Staging |
| *api10* | **10** | Next major version, slated for release alongside Patch 7.0 | .NET 8.0.0 (November 2023) | api10 |
##### Final Fantasy XIV © 2010-2021 SQUARE ENIX CO., LTD. All Rights Reserved. We are not affiliated with SQUARE ENIX CO., LTD. in any way.