Dalamud

mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00

FFXIV plugin framework and API

ffxiv

Find a file

srkizer ecf8e323c4 Misc fixes (#2013 )		2024-08-15 15:22:33 +02:00
.github	fix/ci: don't reference a non-existent env var (#1975 )	2024-07-25 21:22:54 +02:00
.nuke	Reapply "emit compiler generated files for docs builds"	2024-06-29 15:30:41 +02:00
build	enable binary formatter in nuke project	2024-06-29 21:22:30 +02:00
Dalamud	Misc fixes (#2013 )	2024-08-15 15:22:33 +02:00
Dalamud.Boot	LoadingDialog: support localization, remove winforms, prevent invalid thread association errors	2024-07-21 18:41:51 +09:00
Dalamud.Common
Dalamud.CorePlugin	Bump Lumina to 4.1.1 (#1997 )	2024-08-04 17:44:25 +02:00
Dalamud.Injector	logging: limit main log file size to 100mb	2024-07-19 18:50:15 +02:00
Dalamud.Injector.Boot	boot: don't link nethost.dll implicitly	2024-07-17 22:54:34 +02:00
Dalamud.Test	actually just move the language types, don't use the one from the common assembly	2024-06-29 01:26:29 +02:00
DalamudCrashHandler	crashhandler: immediately terminate the game in release mode	2024-06-17 21:23:31 +02:00
docs
lib	Update ClientStructs (#1999 )	2024-08-08 08:49:38 -07:00
targets	upgrade packager version in Dalamud.Plugin.targets	2024-06-29 00:10:00 +02:00
tools	enable some string BannedApis	2024-07-11 00:20:00 +02:00
.editorconfig
.gitattributes
.gitignore
.gitmodules
build.cmd
build.ps1
build.sh
CreateHashList.ps1
Dalamud.sln	add solution-wide code analysis config	2024-07-11 00:14:15 +02:00
Dalamud.sln.DotSettings	chore: Remove the [InterfaceVersion] attribute (#1844 )	2024-06-16 13:01:17 +02:00
Directory.Build.props	enable some string BannedApis	2024-07-11 00:20:00 +02:00
docfx.json	ignore CS for docs altogether, for now	2024-06-30 01:28:52 +02:00
filterConfig.yml
global.json
index.md
LICENSE
README.md
sign.ps1
stylecop.json

README.md

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, 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 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 and the API documentation for more details.

If you need any support regarding the API or usage of Dalamud, please join our discord server.

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