docs
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Dalamud </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Dalamud ">
<meta name="generator" content="docfx 2.59.0.0">
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="dalamud--actions-status-discord-shield">Dalamud <a href="https://github.com/goatcorp/Dalamud/actions"><img src="https://github.com/goatcorp/Dalamud/workflows/Build%20Dalamud/badge.svg" alt="Actions Status"></a> <a href="https://discord.gg/3NMcUV5"><img src="https://discordapp.com/api/guilds/581875019861328007/widget.png?style=shield" alt="Discord Shield"></a></h1>
<p align="center">
<img src="https://raw.githubusercontent.com/goatcorp/DalamudAssets/master/UIRes/logo.png" alt="Dalamud" width="200">
</p>
<p>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.</p>
<p>It is meant to be used in conjunction with <a href="https://github.com/goatcorp/FFXIVQuickLauncher">FFXIVQuickLauncher</a>, which manages and launches Dalamud for you. <strong>It is generally not recommended for users to try to run Dalamud manually as there are multiple dependencies and assumed folder paths.</strong></p>
<h2 id="hold-up">Hold Up!</h2>
<p>If you are just trying to <strong>use</strong> Dalamud, you don't need to do anything on this page - please <a href="https://goatcorp.github.io/">download XIVLauncher</a> from its official page and follow the setup instructions.</p>
<h2 id="plugin-development">Plugin development</h2>
<p>Dalamud features a growing API for in-game plugin development with game data and chat access and overlays.
Please see our <a href="https://goatcorp.github.io/faq/development">Developer FAQ</a> and the <a href="https://goatcorp.github.io/Dalamud/api/index.html">API documentation</a> for more details.</p>
<p>If you need any support regarding the API or usage of Dalamud, please <a href="https://discord.gg/3NMcUV5">join our discord server</a>.</p>
<br>
<p>Thanks to Mino, whose work has made this possible!</p>
<h2 id="branches">Branches</h2>
<p>We are currently working from the following branches.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Purpose</th>
<th>.NET Version</th>
</tr>
</thead>
<tbody>
<tr>
<td><em>master</em></td>
<td>.NET Core rework, replaced api3 on 10/08/21</td>
<td>.NET 5.0.6 (May 2021)</td>
</tr>
<tr>
<td><em>api3</em></td>
<td>Legacy version, no longer in active use</td>
<td>.NET Framework 4.7.2 (April 2017)</td>
</tr>
</tbody>
</table>
<br>
<h5 id="final-fantasy-xiv--2010-2021-square-enix-co-ltd-all-rights-reserved-we-are-not-affiliated-with-square-enix-co-ltd-in-any-way">Final Fantasy XIV © 2010-2021 SQUARE ENIX CO., LTD. All Rights Reserved. We are not affiliated with SQUARE ENIX CO., LTD. in any way.</h5>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goatcorp/Dalamud/blob/master/README.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>
