-
-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed 00db747 with MkDocs version: 1.4.3
- Loading branch information
Showing
7 changed files
with
75 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -848,7 +848,7 @@ | |
| <h1 id="developing-chiaki4deck-updates-on-steam-deck">Developing chiaki4deck updates on Steam Deck<a class="headerlink" href="#developing-chiaki4deck-updates-on-steam-deck" title="Permanent link">¶</a></h1> | ||
| <p>This is for contributors that want to make/test updates to the codebase without building a new flatpak each time.</p> | ||
| <div class="admonition info"> | ||
| <p class="admonition-title">Addding Dependencies</p> | ||
| <p class="admonition-title">Adding Dependencies</p> | ||
| <p>If you want to add new dependencies that aren't already included in the flatpak modules or SDK, then you will need to create a new flatpak build adding that module or install the module locally and it to your PATH. However, this would only be needed in rare circumstances.</p> | ||
| </div> | ||
| <h2 id="setup-environment">Setup Environment<a class="headerlink" href="#setup-environment" title="Permanent link">¶</a></h2> | ||
|
|
@@ -878,6 +878,11 @@ <h2 id="setup-environment">Setup Environment<a class="headerlink" href="#setup-e | |
| </code></pre></div> | ||
| </li> | ||
| <li> | ||
| <p>Install the SDK</p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>install<span class="w"> </span>org.kde.Sdk//5.15-23.08 | ||
| </code></pre></div> | ||
| </li> | ||
| <li> | ||
| <p>Install the <code>Debug</code> extensions for the SDK</p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>install<span class="w"> </span>org.kde.Sdk.Debug//5.15-23.08 | ||
| </code></pre></div> | ||
|
|
@@ -892,11 +897,11 @@ <h2 id="setup-environment">Setup Environment<a class="headerlink" href="#setup-e | |
| <div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">HTTPS</label><label for="__tabbed_1_2">SSH</label><label for="__tabbed_1_3">GitHub cli</label></div> | ||
| <div class="tabbed-content"> | ||
| <div class="tabbed-block"> | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/streetpea/chiaki4deck.git | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>--recurse-submodules<span class="w"> </span>https://github.com/streetpea/chiaki4deck.git | ||
| </code></pre></div> | ||
| </div> | ||
| <div class="tabbed-block"> | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>[email protected]:streetpea/chiaki4deck.git<span class="w"> </span> | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>--recurse-submodules<span class="w"> </span>[email protected]:streetpea/chiaki4deck.git<span class="w"> </span> | ||
| </code></pre></div> | ||
| </div> | ||
| <div class="tabbed-block"> | ||
|
|
@@ -905,34 +910,26 @@ <h2 id="setup-environment">Setup Environment<a class="headerlink" href="#setup-e | |
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="admonition question"> | ||
| <p class="admonition-title">What if I'm testing changes from my branch?</p> | ||
| <p>Clone that branch or pull it into the git repo cloned above</p> | ||
| </div> | ||
| </li> | ||
| </ol> | ||
| <h2 id="creating-and-debugging-builds-without-new-flatpak-build">Creating and Debugging Builds without New Flatpak Build<a class="headerlink" href="#creating-and-debugging-builds-without-new-flatpak-build" title="Permanent link">¶</a></h2> | ||
| <ol> | ||
| <li> | ||
| <p>Set your Chiaki code dir as an environment variable (can add to <code>~/.bashrc</code> to persist across restarts)</p> | ||
| <div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">chiaki_code_dir</span><span class="o">=</span><span class="s2">"path_to_chiaki_code_dir"</span> | ||
| </code></pre></div> | ||
| <p>where <code>path_to_chiaki_code_dir</code> is the path to the directory you created with the <code>git clone</code> in the last step.</p> | ||
| <details class="- example"> | ||
| <summary>Example Code Directory</summary> | ||
| <div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">chiaki_code_dir</span><span class="o">=</span><span class="s2">"~/Documents/chiaki-code"</span> | ||
| </code></pre></div> | ||
| </details> | ||
| </li> | ||
| <li> | ||
| <p>Enter the development version of the flatpak with the chiaki4deck source code mounted with:</p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>run<span class="w"> </span>--filesystem<span class="o">=</span><span class="s2">"</span><span class="si">${</span><span class="nv">chiaki_code_dir</span><span class="si">}</span><span class="s2">"</span><span class="w"> </span>--env<span class="o">=</span><span class="nv">PKG_CONFIG_PATH</span><span class="o">=</span>/app/lib/pkgconfig<span class="w"> </span>--command<span class="o">=</span>bash<span class="w"> </span>--devel<span class="w"> </span>io.github.streetpea.Chiaki4deck-devel | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>run<span class="w"> </span>--command<span class="o">=</span>bash<span class="w"> </span>--devel<span class="w"> </span>io.github.streetpea.Chiaki4deck-devel | ||
| </code></pre></div> | ||
| <p>and <code>--env</code> is to set your pkgconfig path to pick up flatpak modules (done by default by flatpak-builder)</p> | ||
| </li> | ||
| <li> | ||
| <p>Create a build using cmake as per usual</p> | ||
| <div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">Debug build</label><label for="__tabbed_2_2">Release build</label></div> | ||
| <div class="tabbed-content"> | ||
| <div class="tabbed-block"> | ||
| <ol> | ||
| <li>Change into the git directory you mounted</li> | ||
| <li>Change into the git directory for your cloned project</li> | ||
| <li> | ||
| <p>Make a directory for your debug build</p> | ||
| <div class="highlight"><pre><span></span><code>mkdir<span class="w"> </span>Debug | ||
|
|
@@ -1051,7 +1048,7 @@ <h2 id="debug-coredump-from-a-flatpak">Debug Coredump From a flatpak<a class="he | |
| <small> | ||
|
|
||
| Last update: | ||
| <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 21, 2023</span> | ||
| <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 17, 2023</span> | ||
|
|
||
| <br> | ||
| Created: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3028,6 +3028,11 @@ <h2 id="updates-releases-updating-chiaki4deck">Updating <code>chiaki4deck</code> | |
| </li> | ||
| </ul> | ||
| <h2 id="updates-releases-releases-newest-first">Releases (Newest First)<a class="headerlink" href="#updates-releases-releases-newest-first" title="Permanent link">¶</a></h2> | ||
| <h3 id="updates-releases-151">1.5.1<a class="headerlink" href="#updates-releases-151" title="Permanent link">¶</a></h3> | ||
| <p>Small patch release</p> | ||
| <ul> | ||
| <li>Workaround for gamescope bug (in Steam Deck Preview channel) causing HDR surface swapchain creation to hang.</li> | ||
| </ul> | ||
| <h3 id="updates-releases-150">1.5.0<a class="headerlink" href="#updates-releases-150" title="Permanent link">¶</a></h3> | ||
| <p>HDR support</p> | ||
| <ul> | ||
|
|
@@ -3451,8 +3456,8 @@ <h2 id="diy-buildit-building-the-flatpak">Building the Flatpak<a class="headerli | |
| <h3 id="diy-buildit-get-flatpak-dependencies">Get Flatpak Dependencies<a class="headerlink" href="#diy-buildit-get-flatpak-dependencies" title="Permanent link">¶</a></h3> | ||
| <ol> | ||
| <li> | ||
| <p>Install the necessary <a href="https://docs.flatpak.org/en/latest/basic-concepts.html#runtimes" rel="noopener" target="_blank">flatpak runtime</a> and associated <a href="https://docs.flatpak.org/en/latest/building-introduction.html#software-development-kits-sdks" rel="noopener" target="_blank">sdk</a></p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>flathub<span class="w"> </span>org.kde.Platform//5.15-23.08<span class="w"> </span>flathub<span class="w"> </span>org.kde.Sdk//5.15-23.08 | ||
| <p>Install the necessary <a href="https://docs.flatpak.org/en/latest/basic-concepts.html#runtimes" rel="noopener" target="_blank">flatpak runtime</a>, associated <a href="https://docs.flatpak.org/en/latest/building-introduction.html#software-development-kits-sdks" rel="noopener" target="_blank">sdk</a>, and base app.</p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>flathub<span class="w"> </span>org.kde.Platform//5.15-23.08<span class="w"> </span>flathub<span class="w"> </span>org.kde.Sdk//5.15-23.08<span class="w"> </span>flathub<span class="w"> </span>io.qt.qtwebengine.BaseApp/x86_64/5.15-23.08 | ||
| </code></pre></div> | ||
| </li> | ||
| <li> | ||
|
|
@@ -3581,7 +3586,7 @@ <h2 id="diy-builddocs-installing-necessary-pre-requisites">Installing Necessary | |
| </div></section><section class="print-page" id="diy-steamdeckdev"><h1 id="diy-steamdeckdev-developing-chiaki4deck-updates-on-steam-deck">Developing chiaki4deck updates on Steam Deck<a class="headerlink" href="#diy-steamdeckdev-developing-chiaki4deck-updates-on-steam-deck" title="Permanent link">¶</a></h1> | ||
| <p>This is for contributors that want to make/test updates to the codebase without building a new flatpak each time.</p> | ||
| <div class="admonition info"> | ||
| <p class="admonition-title">Addding Dependencies</p> | ||
| <p class="admonition-title">Adding Dependencies</p> | ||
| <p>If you want to add new dependencies that aren't already included in the flatpak modules or SDK, then you will need to create a new flatpak build adding that module or install the module locally and it to your PATH. However, this would only be needed in rare circumstances.</p> | ||
| </div> | ||
| <h2 id="diy-steamdeckdev-setup-environment">Setup Environment<a class="headerlink" href="#diy-steamdeckdev-setup-environment" title="Permanent link">¶</a></h2> | ||
|
|
@@ -3611,6 +3616,11 @@ <h2 id="diy-steamdeckdev-setup-environment">Setup Environment<a class="headerlin | |
| </code></pre></div> | ||
| </li> | ||
| <li> | ||
| <p>Install the SDK</p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>install<span class="w"> </span>org.kde.Sdk//5.15-23.08 | ||
| </code></pre></div> | ||
| </li> | ||
| <li> | ||
| <p>Install the <code>Debug</code> extensions for the SDK</p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>install<span class="w"> </span>org.kde.Sdk.Debug//5.15-23.08 | ||
| </code></pre></div> | ||
|
|
@@ -3625,11 +3635,11 @@ <h2 id="diy-steamdeckdev-setup-environment">Setup Environment<a class="headerlin | |
| <div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="diy-steamdeckdev-__tabbed_1_1" name="diy-steamdeckdev-__tabbed_1" type="radio" /><input id="diy-steamdeckdev-__tabbed_1_2" name="diy-steamdeckdev-__tabbed_1" type="radio" /><input id="diy-steamdeckdev-__tabbed_1_3" name="diy-steamdeckdev-__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="diy-steamdeckdev-__tabbed_1_1">HTTPS</label><label for="diy-steamdeckdev-__tabbed_1_2">SSH</label><label for="diy-steamdeckdev-__tabbed_1_3">GitHub cli</label></div> | ||
| <div class="tabbed-content"> | ||
| <div class="tabbed-block"> | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/streetpea/chiaki4deck.git | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>--recurse-submodules<span class="w"> </span>https://github.com/streetpea/chiaki4deck.git | ||
| </code></pre></div> | ||
| </div> | ||
| <div class="tabbed-block"> | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>[email protected]:streetpea/chiaki4deck.git<span class="w"> </span> | ||
| <div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>--recurse-submodules<span class="w"> </span>[email protected]:streetpea/chiaki4deck.git<span class="w"> </span> | ||
| </code></pre></div> | ||
| </div> | ||
| <div class="tabbed-block"> | ||
|
|
@@ -3638,34 +3648,26 @@ <h2 id="diy-steamdeckdev-setup-environment">Setup Environment<a class="headerlin | |
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="admonition question"> | ||
| <p class="admonition-title">What if I'm testing changes from my branch?</p> | ||
| <p>Clone that branch or pull it into the git repo cloned above</p> | ||
| </div> | ||
| </li> | ||
| </ol> | ||
| <h2 id="diy-steamdeckdev-creating-and-debugging-builds-without-new-flatpak-build">Creating and Debugging Builds without New Flatpak Build<a class="headerlink" href="#diy-steamdeckdev-creating-and-debugging-builds-without-new-flatpak-build" title="Permanent link">¶</a></h2> | ||
| <ol> | ||
| <li> | ||
| <p>Set your Chiaki code dir as an environment variable (can add to <code>~/.bashrc</code> to persist across restarts)</p> | ||
| <div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">chiaki_code_dir</span><span class="o">=</span><span class="s2">"path_to_chiaki_code_dir"</span> | ||
| </code></pre></div> | ||
| <p>where <code>path_to_chiaki_code_dir</code> is the path to the directory you created with the <code>git clone</code> in the last step.</p> | ||
| <details class="- example"> | ||
| <summary>Example Code Directory</summary> | ||
| <div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">chiaki_code_dir</span><span class="o">=</span><span class="s2">"~/Documents/chiaki-code"</span> | ||
| </code></pre></div> | ||
| </details> | ||
| </li> | ||
| <li> | ||
| <p>Enter the development version of the flatpak with the chiaki4deck source code mounted with:</p> | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>run<span class="w"> </span>--filesystem<span class="o">=</span><span class="s2">"</span><span class="si">${</span><span class="nv">chiaki_code_dir</span><span class="si">}</span><span class="s2">"</span><span class="w"> </span>--env<span class="o">=</span><span class="nv">PKG_CONFIG_PATH</span><span class="o">=</span>/app/lib/pkgconfig<span class="w"> </span>--command<span class="o">=</span>bash<span class="w"> </span>--devel<span class="w"> </span>io.github.streetpea.Chiaki4deck-devel | ||
| <div class="highlight"><pre><span></span><code>flatpak<span class="w"> </span>run<span class="w"> </span>--command<span class="o">=</span>bash<span class="w"> </span>--devel<span class="w"> </span>io.github.streetpea.Chiaki4deck-devel | ||
| </code></pre></div> | ||
| <p>and <code>--env</code> is to set your pkgconfig path to pick up flatpak modules (done by default by flatpak-builder)</p> | ||
| </li> | ||
| <li> | ||
| <p>Create a build using cmake as per usual</p> | ||
| <div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="diy-steamdeckdev-__tabbed_2_1" name="diy-steamdeckdev-__tabbed_2" type="radio" /><input id="diy-steamdeckdev-__tabbed_2_2" name="diy-steamdeckdev-__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="diy-steamdeckdev-__tabbed_2_1">Debug build</label><label for="diy-steamdeckdev-__tabbed_2_2">Release build</label></div> | ||
| <div class="tabbed-content"> | ||
| <div class="tabbed-block"> | ||
| <ol> | ||
| <li>Change into the git directory you mounted</li> | ||
| <li>Change into the git directory for your cloned project</li> | ||
| <li> | ||
| <p>Make a directory for your debug build</p> | ||
| <div class="highlight"><pre><span></span><code>mkdir<span class="w"> </span>Debug | ||
|
|
||
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.