Skip to content

Commit

Permalink
update site
Browse files Browse the repository at this point in the history
  • Loading branch information
jagt committed Aug 1, 2023
1 parent bea0ce8 commit 52f6643
Show file tree
Hide file tree
Showing 6 changed files with 92 additions and 8 deletions.
6 changes: 6 additions & 0 deletions dataconfig/Advanced/UEUpgrades.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,12 @@ <h1 class="menu-title">DataConfig Book</h1>
<main>
<h1 id="unreal-engine-upgrades"><a class="header" href="#unreal-engine-upgrades">Unreal Engine Upgrades</a></h1>
<p>DataConfig is committed to support multiple UE versions with no deprecations and warnings. On this page we'll document important upgrade and migration info.</p>
<h1 id="ue53"><a class="header" href="#ue53">UE5.3</a></h1>
<ul>
<li>Introduces <code>BuildSettingsVersion.V4</code> which now defaults to C++ 20.</li>
<li><code>TRemoveConst</code> is deprecated over <code>std::remove_const</code>.</li>
<li><code>FScriptDelegate</code> etc now has additional checkers based on threading model and debug/release build. Thus we change how <code>FScriptDelegateAccess</code> works.</li>
</ul>
<h1 id="ue52"><a class="header" href="#ue52">UE5.2</a></h1>
<ul>
<li><code>TIsSame</code> is deprecated over <code>std::is_same</code>.</li>
Expand Down
14 changes: 13 additions & 1 deletion dataconfig/Changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,14 +148,26 @@ <h1 class="menu-title">DataConfig Book</h1>
<main>
<h1 id="changes"><a class="header" href="#changes">Changes</a></h1>
<p>All notable changes to this project will be documented in this file.</p>
<h2 id="142---2023-8-1"><a class="header" href="#142---2023-8-1">1.4.2 - 2023-8-1</a></h2>
<ul>
<li>UE 5.3 support.
<ul>
<li>See: <a href="Advanced/UEUpgrades.html#ue53">UE version upgrade 5.3</a></li>
</ul>
</li>
</ul>
<h2 id="141---2023-2-15"><a class="header" href="#141---2023-2-15">1.4.1 - 2023-2-15</a></h2>
<ul>
<li>Fix compilation on <code>!WITH_EDITORONLY_DATA</code>.
<ul>
<li>See <a href="Advanced/NoMetaData.html">No MetaData</a>.</li>
</ul>
</li>
<li>Initial UE 5.2 support.</li>
<li>UE 5.2 support.
<ul>
<li>See: <a href="Advanced/UEUpgrades.html#ue52">UE version upgrade 5.2</a></li>
</ul>
</li>
</ul>
<h2 id="140---2022-11-17"><a class="header" href="#140---2022-11-17">1.4.0 - 2022-11-17</a></h2>
<p>Checkout blog post <a href="/blog/dataconfig-1-4/">&quot;DataConfig 1.4 Released with UE 5.1 Support&quot;</a>.</p>
Expand Down
28 changes: 26 additions & 2 deletions dataconfig/Integration.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,16 +149,40 @@ <h1 class="menu-title">DataConfig Book</h1>
<h1 id="integration"><a class="header" href="#integration">Integration</a></h1>
<p>At the moment it supports these the engine versions below:</p>
<ul>
<li>UE 5.3 </li>
<li>UE 5.2 </li>
<li>UE 5.1 </li>
<li>UE 5.0 </li>
<li>UE 4.27</li>
<li>UE 4.26</li>
<li>UE 4.25</li>
</ul>
<h2 id="integrate-dataconfig-plugin"><a class="header" href="#integrate-dataconfig-plugin">Integrate <code>DataConfig</code> Plugin</a></h2>
<p>The easiest way to try out DataConfig is to add it as a plugin into your C++ project. In this section we'll walk through the steps of integrating DataConfig plugin into a empty UE C++ Project.</p>
<p>The easiest way to try out DataConfig is to add it as a plugin into your C++ project. In this section we'll walk through these steps.</p>
<h3 id="download-dataconfig-plugin"><a class="header" href="#download-dataconfig-plugin">Download DataConfig Plugin</a></h3>
<p>The quickest way to try out DataConfig is to download the latest release at <a href="https://github.com/slowburn-dev/DataConfig/releases">DataConfig releases</a> page.</p>
<ol>
<li>
<p>Download the zip files on the <a href="https://github.com/slowburn-dev/DataConfig/releases">releases page</a>. Note there're UE4 and UE5 plugin respectively.</p>
</li>
<li>
<p>Unzip it into your Unreal Engine project's <code>Plugin</code> folder. The layout should be like this:</p>
</li>
</ol>
<pre><code>&lt;Your project root&gt;
|- &lt;Your project&gt;.uproject
|- Content
|- Source
|- ...
|- Plugins
|- DataConfig
|- DataConfig.uplugin
</code></pre>
<ol start="3">
<li><a href="#validate-integration">Validate DataConfig plugin is integrated corrrectly</a>.</li>
</ol>
<h3 id="generate-dataconfig-plugin-for-ue4ue5"><a class="header" href="#generate-dataconfig-plugin-for-ue4ue5">Generate DataConfig Plugin for UE4/UE5</a></h3>
<p>DataConfig now uses separated <code>uplugin</code> files for UE4 and UE5 so that we can try out new features in UE5 without dropping support for UE4. We bundled scripts to generate clean plugins for UE4 and UE5. You can also find these on <a href="https://github.com/slowburn-dev/DataConfig/releases">DataConfig releases</a> page.</p>
<p>DataConfig now uses separated <code>uplugin</code> files for UE4 and UE5 so that we can try out new features in UE5 without dropping support for UE4. We bundled scripts to generate clean plugins for UE4 and UE5. This is how the <a href="https://github.com/slowburn-dev/DataConfig/releases">DataConfig releases</a> are built.</p>
<pre><code class="language-shell">git clone https://github.com/slowburn-dev/DataConfig
# requires python 3.6+
python ./DataConfig/Misc/Scripts/make_dataconfig_ue4.py
Expand Down
48 changes: 45 additions & 3 deletions dataconfig/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -387,16 +387,40 @@ <h2 id="json-deserialization"><a class="header" href="#json-deserialization">JSO
<div style="break-before: page; page-break-before: always;"></div><h1 id="integration"><a class="header" href="#integration">Integration</a></h1>
<p>At the moment it supports these the engine versions below:</p>
<ul>
<li>UE 5.3 </li>
<li>UE 5.2 </li>
<li>UE 5.1 </li>
<li>UE 5.0 </li>
<li>UE 4.27</li>
<li>UE 4.26</li>
<li>UE 4.25</li>
</ul>
<h2 id="integrate-dataconfig-plugin"><a class="header" href="#integrate-dataconfig-plugin">Integrate <code>DataConfig</code> Plugin</a></h2>
<p>The easiest way to try out DataConfig is to add it as a plugin into your C++ project. In this section we'll walk through the steps of integrating DataConfig plugin into a empty UE C++ Project.</p>
<p>The easiest way to try out DataConfig is to add it as a plugin into your C++ project. In this section we'll walk through these steps.</p>
<h3 id="download-dataconfig-plugin"><a class="header" href="#download-dataconfig-plugin">Download DataConfig Plugin</a></h3>
<p>The quickest way to try out DataConfig is to download the latest release at <a href="https://github.com/slowburn-dev/DataConfig/releases">DataConfig releases</a> page.</p>
<ol>
<li>
<p>Download the zip files on the <a href="https://github.com/slowburn-dev/DataConfig/releases">releases page</a>. Note there're UE4 and UE5 plugin respectively.</p>
</li>
<li>
<p>Unzip it into your Unreal Engine project's <code>Plugin</code> folder. The layout should be like this:</p>
</li>
</ol>
<pre><code>&lt;Your project root&gt;
|- &lt;Your project&gt;.uproject
|- Content
|- Source
|- ...
|- Plugins
|- DataConfig
|- DataConfig.uplugin
</code></pre>
<ol start="3">
<li><a href="Integration.html#validate-integration">Validate DataConfig plugin is integrated corrrectly</a>.</li>
</ol>
<h3 id="generate-dataconfig-plugin-for-ue4ue5"><a class="header" href="#generate-dataconfig-plugin-for-ue4ue5">Generate DataConfig Plugin for UE4/UE5</a></h3>
<p>DataConfig now uses separated <code>uplugin</code> files for UE4 and UE5 so that we can try out new features in UE5 without dropping support for UE4. We bundled scripts to generate clean plugins for UE4 and UE5. You can also find these on <a href="https://github.com/slowburn-dev/DataConfig/releases">DataConfig releases</a> page.</p>
<p>DataConfig now uses separated <code>uplugin</code> files for UE4 and UE5 so that we can try out new features in UE5 without dropping support for UE4. We bundled scripts to generate clean plugins for UE4 and UE5. This is how the <a href="https://github.com/slowburn-dev/DataConfig/releases">DataConfig releases</a> are built.</p>
<pre><code class="language-shell">git clone https://github.com/slowburn-dev/DataConfig
# requires python 3.6+
python ./DataConfig/Misc/Scripts/make_dataconfig_ue4.py
Expand Down Expand Up @@ -3027,6 +3051,12 @@ <h2 id="running-automation-in-the-editor"><a class="header" href="#running-autom
<p><img src="Advanced/../Images/Integration-DataConfigAutomations.png" alt="Integration-DataConfigAutomations" /></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="unreal-engine-upgrades"><a class="header" href="#unreal-engine-upgrades">Unreal Engine Upgrades</a></h1>
<p>DataConfig is committed to support multiple UE versions with no deprecations and warnings. On this page we'll document important upgrade and migration info.</p>
<h1 id="ue53"><a class="header" href="#ue53">UE5.3</a></h1>
<ul>
<li>Introduces <code>BuildSettingsVersion.V4</code> which now defaults to C++ 20.</li>
<li><code>TRemoveConst</code> is deprecated over <code>std::remove_const</code>.</li>
<li><code>FScriptDelegate</code> etc now has additional checkers based on threading model and debug/release build. Thus we change how <code>FScriptDelegateAccess</code> works.</li>
</ul>
<h1 id="ue52"><a class="header" href="#ue52">UE5.2</a></h1>
<ul>
<li><code>TIsSame</code> is deprecated over <code>std::is_same</code>.</li>
Expand Down Expand Up @@ -3060,14 +3090,26 @@ <h1 id="ue4"><a class="header" href="#ue4">UE4</a></h1>
</ul>
<div style="break-before: page; page-break-before: always;"></div><h1 id="changes"><a class="header" href="#changes">Changes</a></h1>
<p>All notable changes to this project will be documented in this file.</p>
<h2 id="142---2023-8-1"><a class="header" href="#142---2023-8-1">1.4.2 - 2023-8-1</a></h2>
<ul>
<li>UE 5.3 support.
<ul>
<li>See: <a href="Advanced/UEUpgrades.html#ue53">UE version upgrade 5.3</a></li>
</ul>
</li>
</ul>
<h2 id="141---2023-2-15"><a class="header" href="#141---2023-2-15">1.4.1 - 2023-2-15</a></h2>
<ul>
<li>Fix compilation on <code>!WITH_EDITORONLY_DATA</code>.
<ul>
<li>See <a href="Advanced/NoMetaData.html">No MetaData</a>.</li>
</ul>
</li>
<li>Initial UE 5.2 support.</li>
<li>UE 5.2 support.
<ul>
<li>See: <a href="Advanced/UEUpgrades.html#ue52">UE version upgrade 5.2</a></li>
</ul>
</li>
</ul>
<h2 id="140---2022-11-17"><a class="header" href="#140---2022-11-17">1.4.0 - 2022-11-17</a></h2>
<p>Checkout blog post <a href="/blog/dataconfig-1-4/">&quot;DataConfig 1.4 Released with UE 5.1 Support&quot;</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion dataconfig/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dataconfig/searchindex.json

Large diffs are not rendered by default.

0 comments on commit 52f6643

Please sign in to comment.