• Stars
    star
    1,120
  • Rank 41,261 (Top 0.9 %)
  • Language
    C#
  • License
    GNU Affero Genera...
  • Created about 5 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

FFXIV plugin framework and API

Dalamud Actions Status Discord Shield

Dalamud

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 8 Current release branch .NET 7.0.0 (November 2022) Release & Staging
v9 9 Next major version, slated for release alongside Patch 6.5 .NET 7.0.0 (November 2022) v9

Final Fantasy XIV © 2010-2021 SQUARE ENIX CO., LTD. All Rights Reserved. We are not affiliated with SQUARE ENIX CO., LTD. in any way.

More Repositories

1

FFXIVQuickLauncher

Custom launcher for FFXIV
C#
2,751
star
2

DalamudPlugins

This repository hosts plugins for XIVLauncher/Dalamud
PowerShell
198
star
3

XIVLauncher.Core

Cross-platform version of XIVLauncher, optimized for Steam Deck
C#
118
star
4

SamplePlugin

Simple example plugin for XIVLauncher/Dalamud
C#
102
star
5

DalamudPluginsD17

Dalamud plugin manifests
Python
92
star
6

suggestions

Plugin suggestions for Dalamud
42
star
7

DalamudPackager

MsBuild step to generate deployment packages for Dalamud plugins
C#
31
star
8

MinSharp

Minimal .NET wrapper for TsudaKageyu's MinHook
C#
29
star
9

dalamud-distrib

Distribution packages for Dalamud
PowerShell
28
star
10

DalamudAssets

Static assets for Dalamud
16
star
11

dalamud-declarative

Configuration for Dalamud releases and tracks
11
star
12

faq

FAQ and Knowledgebase for XIVLauncher
HTML
9
star
13

DIPs

Dalamud Improvement Proposals
9
star
14

Plogon

Build system for Dalamud Plugins
C#
7
star
15

patchinfo

Metadata for FFXIV patches
6
star
16

dalamud-docs

Dalamud developer documentation site
JavaScript
6
star
17

Dalamud.CrystalTower

Plugin system abstractions for Dalamud, to aid in plugin development.
C#
5
star
18

PluginDistD17

4
star
19

XLWebServices

GitHub API and plugin download proxy for XIVLauncher
C#
4
star
20

goatcorp.github.io

HTML
4
star
21

plugin-platform

Go
4
star
22

operator

*The* goatcorp email reporting service.
Go
3
star
23

Dalamud.NET.Sdk

.NET SDK for Dalamud plugins
2
star
24

DalamudLinter

C#
2
star
25

goatcorp-infra

Python
2
star
26

xlcore-distrib

Temporary release store for XIVLauncher Core
1
star
27

bleatbot

TypeScript
1
star
28

dalamud-bugbait

Dalamud feedback submission system
JavaScript
1
star
29

DalamudWineHelper

Dalamud wine support application
C++
1
star