ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2026-02-08 00:44:36 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: regenerate

Browse source
This commit is contained in:
goat 2021-08-21 22:57:51 +02:00
parent c864cae087
commit 1eb35f29eb
No known key found for this signature in database
GPG key ID: F18F057873895461
935 changed files with 148201 additions and 35402 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/README.html
View file

@ -8,7 +8,7 @@
<title>Dalamud </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Dalamud ">
<meta name="generator" content="docfx 2.56.6.0">
<meta name="generator" content="docfx 2.58.0.0">
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
@ -66,13 +66,36 @@
<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>.</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="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 the <a href="https://goatcorp.github.io/Dalamud/api/index.html">API documentation</a> for more details.</p>
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, in-development, will replace stable</td>
<td>.NET 5.0.6 (May 2021)</td>
</tr>
<tr>
<td><em>api3</em></td>
<td>Legacy, current stable version, to be replaced in November</td>
<td>.NET 4.7.5 (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>
@ -83,7 +106,7 @@ Please see the <a href="https://goatcorp.github.io/Dalamud/api/index.html">API d
<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>
<a href="https://github.com/goaaats/Dalamud/blob/master/README.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>