What's New in Dalamud v9 | Dalamud (2024)

Dalamud v9 is the next major version of Dalamud, to be released together withPatch 6.5. This is a high-level overview of changes. You can see a code diff ofall of these changeshere.

Key Information

  • Branch: v9(view on GitHub)
  • Release Date: Targeted to release alongside Patch 6.5 (estimatedSeptember/October 2023).
  • API Level: 9
  • .NET Version: .NET 7.0
    • .NET 8 is due for official release in November 2023. Due to release timing,we will be targeting .NET 7.0 for v9, and will upgrade to .NET 8 in a futurerelease, when we can confirm that it is stable on all platforms (Windows,Wine, OS X).

New Features

  • The console (/xllog) has been redone, and now lets you create filters thatcan filter to specific plugins.
  • Added a new plugin-specific logging class that you can receive as a serviceinstance via the IPluginLog type.
    • Static functions in PluginLog have been deprecated, and we recommend thatyou move to the new service. They were slow and unreliable, due to having tolook up the calling plugin via reflection, and won’t support new filteringfeatures in the improved console.
    • We are planning to remove the static functions in a future API cycle.
  • Extended DtrBarEntry to now allow for a tooltip, and an OnClick event, toadd even more functionality to your DTR bar entries.
  • Added IAddonLifecycle and IAddonEventManager services which simplifyaccess to addons greatly.
  • Added comprehensive new service to acquire ImGui textures from gameicons/textures via ITextureProvider, detailed below.
  • Added various new functions to manipulate colors for UI work inDalamud.Interface.ColorHelpers.

Major Changes


  • All services must be used via interfaces, their implementations are nowprivate.
    • This allows us to create per-plugin implementations of services, which willbe able to safely dispose of plugin-specific resources - something we havenever been able to do before reliably - and opens up the possibility ofcreating mocks that allow for testing outside of the game.
    • We can also now build features that rely on detecting what plugin is using aservice, like plugin-scoped logs and reliable command lists.
    • To migrate, you only have to change the type used to the interfaceequivalent in the Dalamud.Plugin.Services namespace (e.g. DataManager =>IDataManager)
  • IDataManager.ClientOpcodes and IDataManager.ServerOpcodes have beenremoved. Dalamud systems that use opcodes directly will now use hooks instead.We recommend any plugin that has been using these opcodes to switch to hooks.

UI and ImGui

  • The UiBuilder.OpenMainUi event has been added, which you should subscribe toto open your plugin's "main interface", if applicable
    • This is shown as a separate, highlighted button in the plugin installer, inaddition to the already existing OpenConfigUi button
  • Texture- and Icon-related functions on DataManager have been removed and arenow available in a new service, ITextureProvider.
    • API has been simplified in a major way and now properly supportshigh-resolution textures
    • Icons and textures are now only loaded once globally when requesting themusing this service, reducing memory usage
    • Icons and textures are now automatically unloaded if not drawn for more than2 seconds, and will be reloaded transparently if they are accessed again byyour plugin
    • An API that allows plugins to replace paths to tex files has been added.This means that you no longer manually have to implement this functionalityto make your plugin compatible with e.g. UI mods.
    • ITextureProvider is designed for ImGui specific use cases. Plugins that needto work with raw tex files should implement their own logic.
  • All Dalamud APIs that interact with textures now return IDalamudTextureWrap,and IDalamudTextureWrap no longer inherits from the TextureWrap type inImGuiScene. This has been done to decouple the public API from ImGuiScene, andto remove the need for plugins to reference it.
    • To migrate, you merely need to switch the types used. The exposed API isexactly the same.
    • IDalamudTextureWrap.Size (Vector2) has been added, finally.
  • IDisposable ImGui-helpers have been moved to the main Dalamud assembly and arenow accessible via the Dalamud.Interface.Utility namespace
    • We recommend using these for any new UI, as they are much safer andreduce the chance of crashes caused by misbehaving UI code


  • Obsolete constructors for Hook<T> and the static Hook<T>.FromX() functionshave been removed.
    • Please use the equivalent functions in the IGameInteropProvider service
    • IGameInteropProvider.HookFromSignature() has been added
  • SignatureHelper.Initialize() has been removed. Please useIGameInteropProvider.InitializeFromAttributes().

Minor Changes

  • Util.HttpClient has been removed in favor of allowing plugins to managetheir own HTTP lifecycles.
    • You can use Dalamud.Networking.Http.HappyEyeballsCallback as yourSocketsHttpHandler.ConnectCallback to enable improved IPv6 connectionhandling to dual-stack servers.
  • SeStringManager has been removed. Please use SeStringBuilder instead.
  • ChatHandlers has been removed.
    • ChatHandlers.IsAutoUpdateComplete is now available asDalamudPluginInterface.IsAutoUpdateComplete
    • ChatHandlers.MakeItalics() can be accessed via SeStringBuilder
  • Util.CopyTo() has been removed, as it has been added to the standard libraryas Stream.CopyTo().
  • DalamudPluginInterface.PluginNames and PluginInternalNames have beenreplaced in favor of InstalledPlugins, which provides more context.
  • Obsolete/non-functional icons in FontAwesomeIcon have been removed.
  • DataManager.IsDataReady has been removed, as it is always true when pluginsare loaded.
  • SeStringBuilder.AddItemLink() now correctly adds a full item link, insteadof only adding an ItemPayload.
  • Util.IsLinux() has been changed to Util.IsWine(). Util.GetHostPlatform()has been added to get the actual platform the game is running on - this relieson a special env var that may not be present on all environments Dalamud canrun under yet.
  • The Serilog property SourceContext is no longer used for Dalamud systems.Plugins implementing their own logging systems should write their plugininternal name to the Dalamud.PluginName property instead, otherwise,filtering in the new console will not work.
  • UIBuilder.GposeActive has been moved to IClientState.IsGPosing, and is nowmore reliable/will only be true if the user is actually in GPose.
  • IDalamudPlugin.Name has been removed. This has not been shown anywhere inmore than 2 years.
  • Dev-Plugins without a manifest are no longer supported. Please have a manifestor use DalamudPackager!
  • Most FlyTextKind enum members have been renamed, see commithere.


These changes have been made after the official stabilization.

  • SigScanner was mistakenly made internal, making it impossible for plugins tocreate their own scanners
    • SigScanner was made public with the same API, and the internal serviceimplementation was decoupled


We want to thank the following people for their contributions to Dalamud duringthis patch cycle:

  • MidoriKami
  • Haselnussbomber
  • kalilistic
  • Soreepeong
  • nebel
  • Caraxi
  • Ottermandias
  • Aireil

FFXIVClientStructs changes

These are relevant changes made to FFXIVClientStructs, listed here forreference. We want to thank aers, Pohky, WildWolf and the otherFFXIVClientStructs contributors for their work.

From a593cb163e1c5d33b27d34df4d1ccc57d1e67643, as of commit0af185ef155cf03f24c2dee8f50f3973a7d417aa:


  • Changed UseAction to take a ulong instead of long for targetID
  • Changed UseActionLocation to take a ulong instead of long for targetID
  • Changed GetActionStatus to take a ulong instead of long for targetID


  • Added Parent character pointer
  • Added GetHeightAdjustActionTimelineRowId


  • Changed ActionRecipientsObjectIdArray to be ulong instead of long
  • Added EmoteController
  • Added CalculateHeight


  • Changed LookupBattleCharaByObjectId to take a uint instead of int


  • Changed GetCurrentTargetID to return ulong instead of uint
  • Changed GameObjectArray.Objects to be ulong instead of long


  • Added HandleEnterContentInfoPacket


  • Changed MoveItemSlot to use ushort instead of uint for slot


  • Removed long operators


  • Removed Obsolete fields and structs


  • Removed Obsolete fields and structs
  • Changed RetainerList.Retainer to Retainer
  • Changed functions from RetainerList.Retainer to Retainer


  • Added MarkerInfo.ShouldRender field
  • Removed obsolete fields and structs


  • Changed namespace to match file location


  • Changed namespace to match file location


  • Changed ColorSetTextures to ColorTableTextures
  • Changed ColorSetTexturesSpan to ColorTableTexturesSpan


  • Added TaskManager field


  • Added Unknown0A field
  • Added Expansion field
  • Added UserData field
  • Added LoadState field
  • Added LoadIntoKernel method
  • Added Load method
  • Added GetUserData method


  • Changed ResourceCategory to be a ushort


  • Added RelayPartyFinderInfoButton field
  • Added CategoryImageNode field


  • Changed many Unk fields to AtkTextNode*


  • Changed ItemsData to Items with a fixed size array


  • Changed ContextMenu.EventParams to be a fixed array


  • Added SelectedPlayerName, SelectedContentId and SelectedIndex fields


  • Changed namespace to FFXIVClientStructs.FFXIV.Client.UI.Agent


  • Changed ReadyCheckEntries from FixedArray to FixedSizeArray


  • Changed Retainers to fixed array


  • Changed DesynthResult to DesynthResults and changed FixedArray toFixedSizeArray


  • Changed Data to CharData
  • Changed ContentID to ulong
  • Changed GetContentIDForEntry to return ulong
  • Removed CharIndex field from InfoProxyCommonList
  • Removed CharacterDict and CharacterArray from InfoProxyCommonList
  • Moved OnlineStatus, MentorState, PartyStatus, DutyStatus to singleOnlineStatus enum linked to bitflag of OnlineStatus.exd
  • Added Sort field
  • Added ExtraFlags field


  • Was InfoProxyItemSearch


  • Was InfoProxy11
  • Changed SelectedItemId to SearchItemId
  • Changed GlobalItemId to ListingId
  • Added RetainerListings
  • Added RetainerListingsCount
  • Added PlayerRetainers


  • Changed DirectionalLightingVerticalAngle andDirectionalLightingHorizontalAngle to be signed


  • Changed RetainerSorter to be aStdMap<ulong, Pointer<ItemOrderModuleSorter>>
  • Removed RetainerSorterCount


  • Changed Gearset to be a fixed array named Entries
  • Changed IsValidGearset to return bool instead of byte
  • Changed CreateGearset to return sbyte instead of uint
  • Changed HasLinkedGlamourPlate to return bool instead of byte
  • Changed IsGearsetLinkedWithBanner to HasLinkedBanner
  • Changed GetBannerIndexByGearsetIndex to GetBannerIndex
  • Changed SetBannerIndexForGearsetIndex to SetBannerIndex
  • Added FindGearsetIDByName
  • Added GearsetItem.Flags field
  • Changed GearsetEntry.RightLeft to be named RingLeft


  • Changed Instance to be a method instead of a property
  • Changed Individual and Shared to be fixed arrays
  • Added RaptureTextModule and TextChecker fields


  • Changed Retainers to fixed array
  • Changed SetComment to return void instead of void*


  • Changed Instance to be a method instead of a property


  • Changed GetUIInputData to return UIInputData*


  • Added AtkDragDropInterface field


  • Added AtkDragDropInterface field


  • Added DragDrop1, DragDrop2 and DragDropS pointer fields
  • Added IsDragging, ReclickToDrop, MouseMoved and IsNotDiscarding boolfields


  • Obsoleted AtkLinkedList in favor of StdLinkedList


  • Added AtkTextureResourceManager field
  • Changed DefaultTextureVersion toAtkTextureResourceManager.DefaultTextureVersion
  • Changed ExdModule to AtkTextureResourceManager.ExdModule


  • Added AtkTextureResourceManager field


  • Changed Count_1 to Count
  • Changed Count_2 to Version
  • Added ShareCount field


  • Added ShowHideFlags field
  • Changed Show and Hide paramenters to match the game


  • Changed AtkUnitEntries to fixed array named Entries;
  • Changed Count to ushort


  • Added Deconstruct method to StdPair

New Files Added:

  • Component/GUI/AtkDragDropInterface.cs
  • Component/GUI/AtkTextureResourceManager.cs
  • Client/UI/UIInputData.cs
  • Client/UI/Agent/AgentScenarioTree.cs
  • Client/UI/Agent/AgentMycBattleAreaInfo.cs
  • Client/UI/Agent/AgentMiragePrismPrismItemDetail.cs
  • Client/UI/Agent/AgentItemDetail.cs
  • Client/System/Framework/TaskManager.cs
  • Client/System/Framework/Task.cs
  • Client/System/Framework/RootTask.cs
  • Application/Network/WorkDefinitions/EnterContentInfo.cs
  • Client/Game/Control/EmoteController.cs
  • Client/Game/Conditions.cs

Changed All Agents to use the new AgentGettersGenerator

Changed All VTable to vtbl

What's New in Dalamud v9 | Dalamud (2024)


Top Articles
Latest Posts
Article information

Author: Mrs. Angelic Larkin

Last Updated:

Views: 6295

Rating: 4.7 / 5 (67 voted)

Reviews: 82% of readers found this page helpful

Author information

Name: Mrs. Angelic Larkin

Birthday: 1992-06-28

Address: Apt. 413 8275 Mueller Overpass, South Magnolia, IA 99527-6023

Phone: +6824704719725

Job: District Real-Estate Facilitator

Hobby: Letterboxing, Vacation, Poi, Homebrewing, Mountain biking, Slacklining, Cabaret

Introduction: My name is Mrs. Angelic Larkin, I am a cute, charming, funny, determined, inexpensive, joyous, cheerful person who loves writing and wants to share my knowledge and understanding with you.