Difference between revisions of "Help:Frequently Asked Questions"

From RPCS3 Wiki
m (wording fixes)
(Add short explanation on CLI)
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:


==Running VSH/XMB in RPCS3==
==Running VSH/XMB in RPCS3==
We are happy to report that starting July 2021, VSH (VirtualShell, aka. XMB or [https://en.wikipedia.org/wiki/XrossMediaBar XrossMediaBar]) has been possible to get working on the official mainline builds of the emulator, bearing in mind some quirks and limitations.
Since July 2021, it has been possible to run VSH/[https://en.wikipedia.org/wiki/XrossMediaBar XMB]) on the official master builds of the emulator, bearing in mind some quirks and limitations. The initial set-up is as follows:


===Getting it to work===
===Configuration===
Assuming the global settings are in their [[Help:Default Settings|default state]], you'll only need to make sure of the following:
Ensure you have '''Firmware 4.46 (or older)''' installed.
* you have firmware 4.46 (or older) installed
* you have the following options set to '''enabled''' in the '''global settings''':
** '''Write Color Buffers''' (<code>Config > GPU > Write Color Buffers</code>)
** '''Force CPU blit emulation''' (<code>Config > Debug > Force CPU blit emulation</code>, see [[#Enabling Debug tab|enabling the debug tab]])


For a smoother experience, you may also want to apply the following:
Make the following modifications to the ''Global'' configuration.
* <code>Config > CPU > PPU Decoder</code> set to '''Interpreter (fast)''', until you're done with the initial setup
{{config
* <code>Config > GPU > Default Resolution</code> set to '''1920x1080''', for a FullHD presentation (if you prefer)
<!-- CPU configuration -->
 
|ppu decoder                          = Interpreter (fast) <!-- Interpreter (precise), Interpreter (fast), Recompiler (LLVM) -->
With all this set, all that's left is to boot it up! Select <code>File > Boot VSH/XMB</code> to get started.
|ppu decoder notes                    = Can be used for a smoother experience during initial setup.
<!-- GPU configuration -->
|default resolution                    = 1920x1080 <!-- 1920x1080, 1280x720, 720x480, 720x576, 1600x1080, 1440x1080, 1280x1080, 960x1080 -->
|default resolution notes              = Can be used if you prefer a Full HD presentation.
|write color buffers                  = On <!-- On, Off -->
|write color buffers notes            = Fixes background wave effect
<!-- Debug configuration -->
|force cpu blit emulation              = On <!-- On, Off -->
|force cpu blit emulation notes        = Fixes background wave effect
}}


===Initial Setup===
===Initial Setup===
The initial setup consists of two phases. First, VSH will have to rebuild its [https://www.psdevwiki.com/ps3/XRegistry.sys XRegistry] database from scratch. You may notice that the image output is low resolution, and has an old-school 4:3 aspect ratio - this is completely normal and expected behavior.
[[File:VSH database.jpg|300px|thumb|right|Time to rebuild the XRegistry database]]
 
[[File:Xregistry_rebuild.png]]
 
As soon as the progress bar hastily completes, you'll be met with an empty black screen. This is also expected behavior as of now. Simply quit VSH manually, like you'd quit any game, and then start it back up again (remember: <code>File > Boot VSH/XMB</code>). This puts us into the ''second phase'' of the setup process.
 
After a successful restart, the logo videos will show, and you'll be presented with the language select menu:
 
[[File:Vsh_language_select.png]]
 
Select your desired language and press X.
 
Next, you'll be met with a message, saying that an HDMI display was detected. Currently, the HDMI related parts of the code are broken, so trying to use HDMI will hang VSH. Please select no, and press X.
 
[[File:Hdmi_no.png]]
 
Following this, you'll be asked to put in your timezone and the current time. You can just spam X to get through these, especially the current time selection part (it will autofill, if you hit X a couple times). Having set them, press Right. If you've done everything correctly (the summary page looks correct), hit X to finish the setup.
 
Before letting you in to the main menu, VSH will ask you if you want to set up a network connection. It is recommended that you don't.
 
And just a quick user profile confirmation later...
 
[[File:Welcome_to_vsh.png]]
 
... welcome to the PS3!
 
Lastly, we'll look at fixing the resolution and the aspect ratio. Navigate to <code>Settings > Display Settings > Video Output Settings</code> on the XMB.
 
[[File:Displaysettings.png]]


Here, you'll want to select '''Component / D-Terminal'''. As explained above, HDMI won't work yet, so selecting that would hang VSH.
The initial setup consists of two phases. The first phase is as follows:
# Select <code>File > Boot VSH/XMB</code> to get started. VSH will have to rebuild its [https://www.psdevwiki.com/ps3/XRegistry.sys XRegistry] database. You may notice that the image output is low resolution, and has a 4:3 aspect ratio. This is completely normal and the expected behavior.
# As soon as the progress bar hastily completes, you'll be met with an empty black screen. This is also the expected behavior for now. Simply quit VSH manually (like you'd quit any game).


Press Right, and then have the change accepted (will ask you twice). On the list, select '''1080p''' (or '''720p''' if you prefer), and have it accepted. Click on '''Finish''' to end the configuration.
Now you can proceed to the second phase:
# Select <code>File > Boot VSH/XMB</code>. You will be greeted by the intro logo.
# You'll be presented with the language selection menu. Select your desired language and '''Press X'''.
# Next, you'll be met with a message, saying that an HDMI display was detected. Currently, HDMI is not supported and will hang VSH if used. Choose '''No''', and '''Press X'''.
# Following this, you'll be asked to select your Timezone and the current time. You can just spam X to get through these, especially the current time selection part (it will autofill, if you hit X a couple times).
# Once done, '''Press Right'''. If you've done everything correctly (the summary page looks correct), '''Press X''' to finish the setup.


This concludes the initial setup of the VSH / XMB. Use the <code>Users > Turn Off System</code> option to turn off VSH cleanly (''will'' pester you on the next boot if you don't shut it down this way).
<gallery widths=300px heights=200px mode="packed">
File:VSH language.jpg|Select your desired language
File:VSH HDMI.jpg|HDMI detection prompt
File:VSH time.jpg|Select your Timezone and current time
</gallery>


[[File:Vsh_off.png]]
# Before letting you in to the main menu, VSH will ask you if you want to set up a network connection. It is recommended that you don't.
# Confirm the new user profile creation and... Welcome to the PS3!
# To fix the resolution and the aspect ratio, navigate to <code>Settings > Display Settings > Video Output Settings</code> on the XMB.
## Select '''Component / D-Terminal'''. As explained above, HDMI won't work yet, so selecting that would hang VSH.
## '''Press Right''', and then have the change accepted (will ask you twice). On the list, select '''1080p''' (or '''720p''' if you prefer), and have it accepted. Click on '''Finish''' to end the configuration.
# This concludes the initial setup of the VSH / XMB.  


After selecting the option, the screen will turn black. You can then proceed to manually exit VSH by that point.
<gallery widths=300px heights=200px mode="packed">
File:VSH Intro.jpg|Welcome to the PS3!
File:VSH display.jpg|Fixing the Resolution and Aspect Ratio
File:VSH exit.jpg|Correctly turning off VSH
</gallery>


(Bonus: It is recommended to boot VSH up back again after this, to ensure everything worked correctly, and to collect some extra PPU module cache.)
To correctly turn off VSH,
# Navigate to <code>Users > Turn Off System</code> option (VSH ''will'' throw a database corruption prompt on the next boot if you don't shut it down this way).
# After selecting the option, the screen will turn black. You can then proceed to manually exit VSH at this point.


(Note: Make sure to revert the <code>PPU Decoder</code> to '''Recompiler (LLVM)''' after you're done, in case you've set it to '''Interpreter (fast)''' for the duration of the setup process.)
<u>Notes</u>:
# It is recommended to boot VSH up back again after this, to ensure everything worked correctly, and to collect some extra PPU module cache.
# Make sure to revert the <code>PPU Decoder</code> option to '''Recompiler (LLVM)''' after you're done, in case you've set it to '''Interpreter (fast)''' for the duration of the setup process.


===Limitations===
===Limitations===
At its current stage, VSH has several quirks and limitations:
At its current stage, VSH has several quirks and limitations:
* there's no multi-process support yet, meaning you can't use XMB as a frontend to boot into games or other applications
* there's no multi-process support yet, meaning you can't use XMB as a frontend to boot into games or other applications
* due to encryption related reasons, it will display several instances of ''Corrupted Data'' erroneously in place of Game Data)
* due to encryption related reasons, it will display several instances of ''Corrupted Data'' erroneously in place of Game Data
* firmware newer than 4.46 are broken, for currently unknown reasons
* firmware newer than 4.46 currently does not work
* restarting and shutting down doesn't work automatically (hence why you have to do that manually as explained above)
* restarting and shutting down doesn't work automatically (hence why you have to do that manually as explained above)
* HDMI output doesn't work (hence why the fiddling with Component)
* HDMI output doesn't work (as explained above)
* there's no audio support yet (misses rsxaudio)
* there's no audio support yet (misses rsxaudio)


Line 95: Line 96:
:# Open the file using any text editor
:# Open the file using any text editor
:# Scroll through the list of settings available to find the one you wish to modify (don't forget to hit save after you've changed the necessary option)
:# Scroll through the list of settings available to find the one you wish to modify (don't forget to hit save after you've changed the necessary option)
==List of CLI commands==
If you want to use RPCS3 through CLI, you can type <code>--help</code> to view the full list of commands available.

Latest revision as of 10:49, 1 August 2021

This is a page meant to address common questions and issues faced by users.

Running VSH/XMB in RPCS3

Since July 2021, it has been possible to run VSH/XMB) on the official master builds of the emulator, bearing in mind some quirks and limitations. The initial set-up is as follows:

Configuration

Ensure you have Firmware 4.46 (or older) installed.

Make the following modifications to the Global configuration. Only options that deviate from the default configuration to ensure best performance are listed below. The full list of default options is available here.

CPU configuration

Setting Option Notes
PPU decoder Interpreter (fast) Can be used for a smoother experience during initial setup.

GPU configuration

Setting Option Notes
Default resolution 1920x1080 Can be used if you prefer a Full HD presentation.
Write color buffers On Fixes background wave effect

Debug configuration

This tab is hidden by default. For instructions on how to enable the Debug tab in the settings window, click here.

Setting Option Notes
Force CPU blit emulation On Fixes background wave effect

Initial Setup

Time to rebuild the XRegistry database

The initial setup consists of two phases. The first phase is as follows:

  1. Select File > Boot VSH/XMB to get started. VSH will have to rebuild its XRegistry database. You may notice that the image output is low resolution, and has a 4:3 aspect ratio. This is completely normal and the expected behavior.
  2. As soon as the progress bar hastily completes, you'll be met with an empty black screen. This is also the expected behavior for now. Simply quit VSH manually (like you'd quit any game).

Now you can proceed to the second phase:

  1. Select File > Boot VSH/XMB. You will be greeted by the intro logo.
  2. You'll be presented with the language selection menu. Select your desired language and Press X.
  3. Next, you'll be met with a message, saying that an HDMI display was detected. Currently, HDMI is not supported and will hang VSH if used. Choose No, and Press X.
  4. Following this, you'll be asked to select your Timezone and the current time. You can just spam X to get through these, especially the current time selection part (it will autofill, if you hit X a couple times).
  5. Once done, Press Right. If you've done everything correctly (the summary page looks correct), Press X to finish the setup.
  1. Before letting you in to the main menu, VSH will ask you if you want to set up a network connection. It is recommended that you don't.
  2. Confirm the new user profile creation and... Welcome to the PS3!
  3. To fix the resolution and the aspect ratio, navigate to Settings > Display Settings > Video Output Settings on the XMB.
    1. Select Component / D-Terminal. As explained above, HDMI won't work yet, so selecting that would hang VSH.
    2. Press Right, and then have the change accepted (will ask you twice). On the list, select 1080p (or 720p if you prefer), and have it accepted. Click on Finish to end the configuration.
  4. This concludes the initial setup of the VSH / XMB.

To correctly turn off VSH,

  1. Navigate to Users > Turn Off System option (VSH will throw a database corruption prompt on the next boot if you don't shut it down this way).
  2. After selecting the option, the screen will turn black. You can then proceed to manually exit VSH at this point.

Notes:

  1. It is recommended to boot VSH up back again after this, to ensure everything worked correctly, and to collect some extra PPU module cache.
  2. Make sure to revert the PPU Decoder option to Recompiler (LLVM) after you're done, in case you've set it to Interpreter (fast) for the duration of the setup process.

Limitations

At its current stage, VSH has several quirks and limitations:

  • there's no multi-process support yet, meaning you can't use XMB as a frontend to boot into games or other applications
  • due to encryption related reasons, it will display several instances of Corrupted Data erroneously in place of Game Data
  • firmware newer than 4.46 currently does not work
  • restarting and shutting down doesn't work automatically (hence why you have to do that manually as explained above)
  • HDMI output doesn't work (as explained above)
  • there's no audio support yet (misses rsxaudio)

Troubleshooting

In case you somehow manage to brick it, you can try removing the dev_flash2 and dev_flash3 folders from the RPCS3 directory. This will put you back at square one (you'll need to do the initial setup all over again).

Enabling Debug tab

To enable RPCS3's debug tab in the settings window,

  1. Navigate to:
    RPCS3\GuiConfigs on Windows
    ~/.config/rpcs3/GuiConfigs on Linux
  2. Open CurrentSettings.ini with a text editor
  3. Change showDebugTab=false to showDebugTab=true

Modifying settings through config.yml

In most cases, users should use the Settings tab available in the GUI to modify configurations present in RPCS3. However, the GUI interface does not expose all settings available. This is done to prevent users from accidentally modifying sensitive settings. In the event users need to modify one of these settings, the following guide will demonstrate how:

First, a custom configurations for the particular game must be created. This is done to ensure that changes made only affect one game and not every game present in the emulator:
  1. Launch RPCS3
  2. Right-click on the game and press Create Custom Configuration
  3. When the Settings Menu opens, hit Save and close the emulator
This will create a custom configuration for this game
The next step is navigate to the location where the custom (per-game) configuration is saved:
  1. Right click on the game in the gamelist and click on Open custom config folder (or)
    Navigate to RPCS3\config\custom_configs\ on Windows or ~/.config/rpcs3/custom_configs/ on Linux
  2. Locate the file config_GAMEID.yml where GAMEID is the Title ID of your particular game
  3. Open the file using any text editor
  4. Scroll through the list of settings available to find the one you wish to modify (don't forget to hit save after you've changed the necessary option)

List of CLI commands

If you want to use RPCS3 through CLI, you can type --help to view the full list of commands available.