Skip to content

Commit

Permalink
Deployed e4ce72e with MkDocs version: 1.4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
streetpea committed Mar 16, 2024
1 parent 797062d commit 6bacfbd
Show file tree
Hide file tree
Showing 20 changed files with 195 additions and 105 deletions.
3 changes: 2 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -986,7 +986,8 @@ <h2 id="acknowledgements">Acknowledgements<a class="headerlink" href="#acknowled
<li>Chiaki Authors (including but not limited to Florian Märkl)</li>
<li>Reddit users and others who have helped me in my personal Chiaki journey such as u/mintcu7000 with his getting started guide on Reddit</li>
<li>Egoistically for the RGB update patch</li>
<li>Florian Grill for his gracious help with adding mic support</li>
<li>Florian Grill for his gracious help with reverse engineering the PlayStation remote play protocols</li>
<li>SageLevi and Superwormy for creating Chiaki4deck artwork</li>
</ul>
</li>
<li>
Expand Down
104 changes: 64 additions & 40 deletions print_page/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

9 changes: 4 additions & 5 deletions setup/automation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -774,10 +774,9 @@


<h1 id="automating-chiaki4deck-launch">Automating <code>chiaki4deck</code> Launch<a class="headerlink" href="#automating-chiaki4deck-launch" title="Permanent link">&para;</a></h1>
<p>Now that you have <code>chiaki4deck</code> configured, it's time to make it wake up your PlayStation and connect to it automatically. </p>
<div class="admonition info">
<p class="admonition-title">So Why Should I Care?</p>
<p>This is especially convenient for the Steam Deck's <code>Game Mode</code> where an automated launch eliminates both the need to tap furiously at your touchscreen to launch the application and the glitches that would arise (flashes on your screen) when it would switch between the 2 open Chiaki windows (since only 1 window is opened with the automated launch). It also gives a default game mode option to launch in fullscreen, stretch or zoomed mode, making it <a href="../../updates/done/#3-view-modes-for-non-standard-screen-sizes" rel="noopener" target="_blank">easier to use the 3 games modes</a>. Finally, it allows for passing your login passcode automatically instead of manually typing in each time (for those of you with a login passcode set on your PlayStation console).</p>
<div class="admonition tip">
<p class="admonition-title">Use the Auto Connect Feature Instead if it Meets Your Needs</p>
<p>Now that you have <code>chiaki4deck</code> configured, it's time to make it wake up your PlayStation and connect to it automatically. Note: If you only have 1 console please try the <a href="../configuration/#auto-connect">autoconnect feature</a>. Otherwise, proceed with this guide to setup a script to automatically launch your different systems.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Sleep Mode Required</p>
Expand Down Expand Up @@ -1376,7 +1375,7 @@ <h1 id="automating-chiaki4deck-launch">Automating <code>chiaki4deck</code> Launc
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 20, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 16, 2024</span>

<br>
Created:
Expand Down
23 changes: 20 additions & 3 deletions setup/configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,13 @@
HDR (High Dynamic Range)
</a>

</li>

<li class="md-nav__item">
<a href="#auto-connect" class="md-nav__link">
Auto Connect
</a>

</li>

</ul>
Expand Down Expand Up @@ -869,6 +876,13 @@
HDR (High Dynamic Range)
</a>

</li>

<li class="md-nav__item">
<a href="#auto-connect" class="md-nav__link">
Auto Connect
</a>

</li>

</ul>
Expand Down Expand Up @@ -1337,8 +1351,8 @@ <h2 id="choosing-your-remote-play-settings">Choosing your Remote Play Settings<a
</div>
</li>
<li>
<p><strong>Audio Settings</strong> for Steam Deck</p>
<p><img alt="Audio Settings" src="../images/AudioSettings.png" /></p>
<p><strong>Audio/WiFi Settings</strong> for Steam Deck</p>
<p><img alt="Audio/Wifi Settings" src="../images/AudioSettings.png" /></p>
</li>
<li>
<p>Below are the <strong>Video Settings</strong> you'll want to try first with your PlayStation console (choose the <strong>PS5/1080p HDR</strong> tab if you have a PS5 connected to a HDR TV/monitor (<a href="#hdr-high-dynamic-range">see HDR section below for more details</a>), <strong>PS5/1080p</strong> if you have a PS5 not connected to an HDR TV/monitor, and <strong>PS4/720p</strong> if you have a PS4). If you are having issues with your PS5 connection, please try the <strong>PS4/720p</strong> settings with your PS5 since they require significantly less bandwidth from your wireless router.</p>
Expand Down Expand Up @@ -1399,6 +1413,9 @@ <h3 id="hdr-high-dynamic-range">HDR (High Dynamic Range)<a class="headerlink" hr
<p>You can adjust the PS5 HDR settings for optimal viewing on the Steam Deck via the system-wide PS5 settings (need to be connected directly to your PS5 and not via remote play to access this menu) by going to <code>Settings -&gt; Screen and Video -&gt; Video Output -&gt; Adjust HDR</code>. You'll want to do this if your display brightness (i.e., nits) is different from the Steam Deck OLED's 1000 nits. According to the folks over at HDTVTest (via <a href="https://github.com/arshiatn" rel="noopener" target="_blank">arshiatn</a>) for an 1000 nits display you want to use 15-15-0 for the HDR settings. To set this in the <code>Adjust HDR set</code> move 15 steps (15 presses of the right key on the dpad of the PlayStation controller) for the first test screen, 15 steps from the beginning for the 2<sup>nd</sup> test screen and 0 steps from the beginning on the last test screen. </p>
<p>Please note that this will also affect the settings for your connected display so if you are switching between remote play and TV play often keep that in mind. Certain games also have their own HDR settings you can adjust while remote playing in their respective game menus or when beginning the game.</p>
</div>
<h3 id="auto-connect">Auto Connect<a class="headerlink" href="#auto-connect" title="Permanent link">&para;</a></h3>
<p>If you have one console you want to connect to remotely or locally you can use the auto-connect feature to launch it automatically on launch. If you have multiple consoles to launch into you can instead use the <a href="../automation/">automation section</a>.</p>
<p><img alt="Auto-Connect Settings" src="../images/AutoConnect.png" /></p>
<h2 id="performance-of-chiakichiaki4deck">Performance of Chiaki/<code>chiaki4deck</code><a class="headerlink" href="#performance-of-chiakichiaki4deck" title="Permanent link">&para;</a></h2>
<h3 id="my-experience">My Experience<a class="headerlink" href="#my-experience" title="Permanent link">&para;</a></h3>
<p>Ultimately, the performance will depend on the capability of your wireless router and which system (<span class="arithmatex">\(PS5 &gt; PS4 Pro &gt; PS4\)</span>) you are using. Here are some notes from my experience using <code>chiaki4deck</code> on my Steam Deck with a PS5 console and a relatively good (<span class="arithmatex">\(450 Mbps\)</span> for <span class="arithmatex">\(2.4GHz\)</span> / <span class="arithmatex">\(1,300 Mbps\)</span> for <span class="arithmatex">\(5GHz\)</span>) wireless router.</p>
Expand Down Expand Up @@ -1489,7 +1506,7 @@ <h2 id="chiakichiaki4deck-via-internet-outside-of-home-connection">Chiaki/<code>
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 16, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 16, 2024</span>

<br>
Created:
Expand Down
6 changes: 5 additions & 1 deletion setup/controlling/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1090,6 +1090,10 @@


<h1 id="configuring-steam-deck-controller-profile">Configuring Steam Deck Controller Profile<a class="headerlink" href="#configuring-steam-deck-controller-profile" title="Permanent link">&para;</a></h1>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>If you created the Steam Shortcut through the menu, it automatically adds the correct chiaki4deck+ mic controller profile for you on Steam Deck.</p>
</div>
<p>Get all of the shortcuts mapped to Steam Deck controls. Start by going to the <code>chiaki4deck</code> game menu and selecting the controller layout to configure controller options.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Game Mode</label><label for="__tabbed_1_2">Desktop Mode</label></div>
<div class="tabbed-content">
Expand Down Expand Up @@ -1500,7 +1504,7 @@ <h3 id="enabling-chiaki4deck-to-work-with-dualsense-dualshock-4">Enabling <code>
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 16, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 16, 2024</span>

<br>
Created:
Expand Down
Binary file modified setup/images/1080P_Settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified setup/images/1080P_SettingsHDR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified setup/images/720P_Settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added setup/images/AddSteamShortcut.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified setup/images/AudioSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added setup/images/AutoConnect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified setup/images/OpenSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified setup/images/PS5Connected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added setup/images/SteamShortcutMenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 38 additions & 2 deletions setup/steaming/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -820,14 +820,47 @@


<h1 id="adding-chiaki4deck-to-steam">Adding Chiaki4Deck to Steam<a class="headerlink" href="#adding-chiaki4deck-to-steam" title="Permanent link">&para;</a></h1>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Automatic Process for Auto-connect or Standard Launch</label><label for="__tabbed_1_2">Manual Process for Automation Script</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<ol>
<li>
<p>Choose <code>Add Create Steam Shortcut from Main Menu</code></p>
<p><img alt="Choose Create Steam Shortcut" src="../images/AddSteamShortcut.png" /></p>
</li>
<li>
<p>Fill in name for Steam Shortcut and optional launch options</p>
<ol>
<li>
<p>Fill in name for Steam Shortcut and optional launch options</p>
<div class="admonition note">
<p class="admonition-title">Launch Options</p>
<p>In most cases, you can leave this blank. One scenario where you would fill this out is if you have multiple users on the same Steam Deck. In this case you can use <code>--profile user1</code> for one shortcut and <code>--profile user2</code> for another.</p>
</div>
</li>
<li>
<p>Create Steam Shortcut by hitting <code>Create</code> button</p>
</li>
</ol>
<p><img alt="Fill in Steam Shortcut" src="../images/SteamShortcutMenu.png" /></p>
</li>
</ol>
<div class="admonition success">
<p class="admonition-title"><img alt="🎮" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/1f3ae.svg" title=":video_game:" /> Game (Mode) Time!</p>
<p>You have successfully added <code>chiaki4deck</code> to Steam with pictures and (if on Steam Deck) set the <code>chiaki4deck+ mic</code> Steam Deck controller shortcut. <img alt="🎆" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/1f386.svg" title=":fireworks:" /></p>
<p>You can now close any open applications and or terminals (forcing them to close if necessary) and then switch to <strong>Game Mode</strong> by clicking on the <code>Return to Gaming Mode</code> desktop icon.</p>
<p><img alt="Go to Game Mode" src="../images/ReturnToGamingMode.png" /></p>
</div>
</div>
<div class="tabbed-block">
<div class="admonition info">
<p class="admonition-title">Another Non-Steam Game</p>
<p>This is the same process as with other non-Steam games, tailored to the <code>chiaki4deck</code> script and images.</p>
</div>
<ol>
<li>
<p>Open the <code>Add a Non-Steam Game</code> prompt</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Via user interface / application (GUI)</label><label for="__tabbed_1_2">Via <code>konsole</code></label></div>
<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">Via user interface / application (GUI)</label><label for="__tabbed_2_2">Via <code>konsole</code></label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<ol>
Expand Down Expand Up @@ -1013,14 +1046,17 @@ <h2 id="configuring-name-and-game-icons">Configuring Name and Game Icons<a class
<p>You have successfully added <code>chiaki4deck</code> to Steam with pictures. <img alt="🎆" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/1f386.svg" title=":fireworks:" /></p>
<p>You can now close any open applications and or terminals (forcing them to close if necessary) and then switch to <strong>Game Mode</strong> by clicking on the <code>Return to Gaming Mode</code> desktop icon.</p>
<p><img alt="Go to Game Mode" src="../images/ReturnToGamingMode.png" /></p>
</div>
</div>
</div>
</div>

<hr>
<div class="md-source-file">
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 3, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 16, 2024</span>

<br>
Created:
Expand Down
30 changes: 15 additions & 15 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,77 +2,77 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://streetpea.github.io/chiaki4deck/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/diy/builddocs/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/diy/buildit/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/diy/steamdeckdev/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/setup/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/setup/automation/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/setup/configuration/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/setup/controlling/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/setup/installation/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/setup/remoteconnection/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/setup/steaming/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/updates/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/updates/done/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/updates/planned/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streetpea.github.io/chiaki4deck/updates/releases/</loc>
<lastmod>2024-02-06</lastmod>
<lastmod>2024-03-16</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
Binary file not shown.
Loading

0 comments on commit 6bacfbd

Please sign in to comment.