Command-line support

From PCSX2 Wiki
Revision as of 17:45, 7 May 2015 by DoctorMuerte (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

You can specify certain options when launching pcsx2.exe from the command-line under Windows, or the terminal in Linux environment. This guide will give you the list of these options.

Introduction

PCSX2 versions 0.9.7 and higher have full command-line support, announced on The return of the Commandline! blog entry.


Syntax

The following format can be used to launch PCSX2:

pcsx2.exe "IsoFile" --OptionName="OptionParameter" --Option2Name="Option2Parameter" ...
  • IsoFile is the image file of the PS2 game to be loaded (with full path and extension).
  • OptionName specifies the option to be activated.
  • OptionValue is used for the options that require some additional parameters. Do not forget to include these parameters inside quote signs (").

Example:
c:\PCSX2\pcsx2.exe "c:\PS2\Final Fantasy X.iso" --fullscreen --cfgpath="c:\My Configs\FFX"

The ISO file Final Fantasy X.iso will be launched in full screen mode automatically after PCSX2 is started. The plugin configuration files will to be loaded from the specified folder (c:\My Configs\FFX).

Lightbulb.png Tip:
It is possible to make a short-cut with predefined command-line parameters and place in on desktop to launch your current PS2 game directly from your desktop.


Options list

Note that you can only specify ISO image name in the first command-line option. But you can also skip ISO image name altogether and, for instance, use --usecd, --nodisk or --elf="ELFFileName" options.

At this time you can only use the following options:

General Options

  • --cfgpath="Path": Specifies the configuration files path.
  • --cfg="CFGFile": Specifies the PCSX2 configuration file to use.
  • --forcewiz: Forces PCSX2 to start in the first time wizard mode.
  • --portable: Enables portable mode to store ini and cfg the data to local PCSX2 paths instead of current user's documents path (This requires admin/root access).
  • --console: Forces PCSX2 log console to be visible.
  • --fullscreen: Starts in fullscreen mode.
  • --windowed: Starts in windowed mode (default).
  • --nogui: Disables display of the graphical user interface (you can combine it with --fullscreen when loading an ISO file, so PCSX2 presence will be hidden from the user)
  • -h or --help: Displays full list of command-line options (this list).

Auto-run Options

  • --elf="ELFFile": Executes the specified ELF image on start.
  • --nodisc: Boots PS2 BIOS without DVD image; It is usedful to enter the PS2 system menu.
  • --usecd: Boots from the CDVD plugin on start (overrides IsoFile parameter). You can use this option to play directly from your DVD but you will need to set up CDVD plugin first.

Compatibility Options

  • --nohacks: Disables all speedhacks.
  • --gamefixes=[fix1,fix2,...]: Enables the specific gamefixes for the current PCSX2 session. Valid names are: VuAddSub, VuClipFlag, FpuCompare, FpuMul, FpuNeg, EETiming, SkipMpeg, OPHFlag, DMABusy, VIFFIFO, VI, FMVinSoftware (see PCSX2 for more information).
  • --fullboot: Disables fast booting (does not skip PS2 BIOS when booting an ISO, this may require by some games relying on BIOS to get start-up parameters)

Plugin Overrides

  • --gs="DLLpath": Specifies the file to use as the GS plugin.
  • --pad="DLLpath": Specifies the file to use as the PAD plugin.
  • --spu2="DLLpath": Specifies the file to use the SPU2 plugin.
  • --cdvd="DLLpath": Specifies the file to use as the CDVD plugin.
  • --usb="DLLpath": Specifies the file to use as the USB plugin.
  • --fw="DLLpath": Specifies the file to use as the FW plugin.
  • --dev9="DLLpath": Specifies the file to use as the DEV9 plugin.


Command-line options and shortcuts

The ordinary user may use command-line feature to create a shortcut to his/her game on the desktop so that PCSX2 will run without showing PCSX2 GUI at all. To do this make a link to PCSX2 main executable (pcsx2.exe) and update the target field of this link to something like this "C:\PS2\pcsx2.exe" -skipbios "C:\PS2\yourgame.iso". Now you are able to start C:\PS2\yourgame.iso right from your desktop!

Lightbulb.png Tip:
If you have different games that need different emulation settings and/or plugins configuration, consider making as many shortcuts as you need with custom settings, or use an external launcher as described on this guide.


Command-line options and Steam

Click to enlarge.

Command-line options are the key if you want to use Steam as an external launcher for your PS2 games.
Below is a step by step guide on how to do this (you may repeat this process to add as many games as you want):

 
1) Go to Games => Add a non-steam game in the Steam user interface main menu.
Steam guide 1.png
2) Click on Browse and locate pcsx2.exe. Click on Add selected program. It is important that you add pscx2.exe this way (rather than picking it from the list) so you can add more shortcuts later on.
3) Now that pcsx2 is added to your game library, open its properties.
Steam guide 2.png
4) You can specify all described options and your ISO file name in the Target field. Do not remove quote signs (") from pcsx2.exe specification part (automatically added by Steam).
Steam guide 3.png

Optional steps:

5) You can choose custom icons for the shortcuts. These icons should be embedded on an .exe/.dll file, or have to be a PNG image (with preferably square resolution proportion).
6) If you use Big Picture mode or grid display, you can set a custom banner for the game.
It has to be a PNG image with 460 x 215 resolution.
Lightbulb.png Tip:

You can find custom banners on the following sites:

7) By default, games added to Steam client in this manner do not have background images on their details pages. But any screenshots you take while playing a game using Steam (F12 Steam hotkey), are automatically used later as the background image for that game. Bear in mind though that F12 key is also the movie capture shortcut in GSdx PCSX2 plugin, so you additionally will need to click Cancel when the movie capture dialog appears.
8) You can also create a custom category like Playstation 2, to group your PS2 games.
9) If you use the big picture mode, you can also assign hot-keys to your controller (for example, to close the emulator). Learn more in this forum post

The following image shows the result of the above manipulations for Shinobido: Way Of The Ninja (click to enlarge):

Steam guide 5.png
Lightbulb.png Tip:

There is an open source project called ICE, that allows you to easily add your PS2/console games to Steam library. You can find it at http://scottrice.github.io/Ice

Please read its documentation carefully before using it.


Commandline options and XBMC

Information on using XBMC as an external PCSX2 launcher can be found in the following forum thread.