From da3a3c0d1172be9c8dfcbde36e554166bd72ff83 Mon Sep 17 00:00:00 2001 From: cadihowley Date: Mon, 2 Nov 2020 12:35:27 +1300 Subject: [PATCH] DOCS: adds first draft Other platforms pages --- doc/docportal/other_platforms/android.rst | 59 +++++ doc/docportal/other_platforms/ios.rst | 226 ++++++++++++++++++ .../other_platforms/nintendo_switch.rst | 167 +++++++++++++ doc/docportal/other_platforms/ps_vita.rst | 191 +++++++++++++++ doc/docportal/other_platforms/psp.rst | 137 +++++++++++ 5 files changed, 780 insertions(+) create mode 100644 doc/docportal/other_platforms/android.rst create mode 100644 doc/docportal/other_platforms/ios.rst create mode 100644 doc/docportal/other_platforms/nintendo_switch.rst create mode 100644 doc/docportal/other_platforms/ps_vita.rst create mode 100644 doc/docportal/other_platforms/psp.rst diff --git a/doc/docportal/other_platforms/android.rst b/doc/docportal/other_platforms/android.rst new file mode 100644 index 00000000000..d2db264574a --- /dev/null +++ b/doc/docportal/other_platforms/android.rst @@ -0,0 +1,59 @@ + +=============== +Android +=============== + +Installing ScummVM +==================================== + +There are multiple ways to install ScummVM on your Android device depending on what version of Android you have. + + +Google Play Store +********************* +For Android 7 (Nougat) or earlier, the easiest way to install ScummVM is by downloading it from the Google Play Store. You will be guided through the installation. + +.. caution:: + + Currently the Google Play version of ScummVM will not work on Android versions 8.0 and later. If your version of Android is not compatible with the app on the Google Play store, follow the instructions for installing ScummVM using the APK package. + +APK package install +********************** + +On your device, use a web browser app to navigate to the `ScummVM downloads page `_. The recommended download section on the page should suggest the correct ``.apk`` package, however if it does not, scroll down to select the correct package. + +.. tip:: + + To find the correct package for your device, you will need to know whether you are running a 32 or 64-bit operating system, and which chipset your device has. A quick internet search using your device model number should allow you to find these details. + +Click on the correct package to start the download. Once it has downloaded, go to the file and tap on it to start the install process. Do this by using either a file manager app and navigating to the Downloads folder, or by selecting the file directly from the web browser downloads. The file manager or the web browser will ask for permission to install the package, and once permission has been granted, will return you to the install. + +.. note:: + + The downloaded APK package is treated as an app from an unknown source, since it doesn't originate in the Google Play store. If you are having any problems with the install, you will need to allow unknown apps. + + - For Android 7 or earlier, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**. + - For Android 8 or later, go to **Settings > Apps and Notification** and select **Install Unknown Apps**. + +Transferring game files +======================================== + +You need to transfer all the required game data files to your device, into a folder accessible by the ScummVM app. + +ScummVM has built-in Cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../settings/cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../settings/lan` page. + +There are a few other options for transferring the game files: + + - Copying the files directly onto the microSD card, if your device has one. + - USB transfer from a computer. To complete file transfer via USB cable, tap the **Charging this device via USB notification** when the device is connected. Select **Use USB for** and then **File Transfer**. An Android File Transfer window will open. + - Downloading games such as freeware games or those from digital distributors such `GOG.com `_ or `Steam `_ directly to your device. + +For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games `_. + + + + + + + + diff --git a/doc/docportal/other_platforms/ios.rst b/doc/docportal/other_platforms/ios.rst new file mode 100644 index 00000000000..07609f57bca --- /dev/null +++ b/doc/docportal/other_platforms/ios.rst @@ -0,0 +1,226 @@ + +============== +iOS +============== + +Installing ScummVM +===================== +There are two methods to install ScummVM onto your iOS device, and the method you use depends on whether or not your device is jailbroken. + +No Jailbreak +^^^^^^^^^^^^^^^^ + +This method is a little complex, however it is currently the only way to install ScummVM to an iOS device that is not jailbroken. While a rudimentary knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone. + +Prerequisites +**************** + +- A Mac computer with Xcode installed. Xcode is a free App, available from the Mac App Store. +- An Apple Developer account. You can sign up for a free account on the `Apple Developer Member Center `_ with your Apple ID. +- The ScummVM `iOS Libraries `_ downloaded. + +.. note:: + + If you have a free Apple developer account, each build will only be valid for 7 days, which means you will need to repeat these steps and re-install ScummVM every week. + +Creating the Xcode project +*************************** + +The first step is to download the repository containing the code we'll need to build the app with. The easiest way to do this is from the command line. Go to **Applications > Utilities > Terminal** and enter the following: + +.. code-block:: bash + + git clone https://github.com/scummvm/scummvm.git + +.. note:: + The default branch of the ScummVM repository will be the master branch. To build a specific version, checkout the appropriate branch. For example, to build version 2.2.0, use the following command: + + .. code-block:: + + git checkout branch-2-2-0 + +If you haven't done so before now, open Xcode from the Applications folder, and accept the End User License Agreement. Starting Xcode for the first time will also install the command line tools we require for the next steps. + +The next step changes our present working directory and then generates the tools we need to create the Xcode project. + +.. code-block:: bash + + cd scummvm/devtools/create_project/xcode + xcodebuild + +Now we move back a few directories, to create a new build directory at the same level as the repository. + +.. code-block:: bash + + cd ../../../.. + mkdir build + cd build + +Your present working directory will now be the new ``build`` directory. Unzip the downloaded iOS libraries package into the build folder by using the following command: + +.. code-block:: bash + + unzip ~/Downloads/scummvm-ios7-libs-v2.zip + + +Generating the Xcode project +***************************** + +It's time to generate the Xcode project. Ensure your present working directory is still the ``build`` directory, and then run the following on the command line: + +.. code:: + + ../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --enable-fluidsynth --disable-nasm --disable-opengl --disable-theora --disable-taskbar --disable-tts --disable-fribidi + +The resulting directory structure will look like this: + +.. code-block:: bash + + Home + |--scummvm + '--build + |-- include + |-- lib + |-- engines + '-- scummvm.xcodeproj + +.. tip:: + + To view the Home directory in the Finder, click on **Go** in the top menu bar, and then click **Home**, or alternatively use the keyboard shortcut :kbd:`shift` + :kbd:`command` + :kbd:`H`. + +Open the ``scummvm.xcodeproj`` file from the Finder, or via the command line: + +.. code-block:: bash + + open scummvm.xcodeproj + +Building ScummVM +***************** + +Once Xcode is open, connect the device you are installing ScummVM onto. At the top of the window, select **ScummVM-iOS** and then the device you connected. You will need to trust the device before it will show up on the list of connected devices. + +.. figure:: ../images/ios/choose_device.gif + + +The last step before building the app is to change the bundle identifier and manage signing. Click on the **scummvm** project in the left pane, and then click on **ScummVM - iOS** under **TARGETS**. On the menu bar above, click on **General**. Under **Identity** you should see a field labeled **Bundle Identifier**. Here you will need to input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*. + +.. figure:: ../images/ios/identifier.gif + + +Next to **General**, click on **Signing & Capabilities**. Under **Signing**, tick the **Automatically manage signing** box, and select your developer account from the **Team** dropdown menu. + +.. figure:: ../images/ios/signing.gif + + + +If you have not added your developer account to Xcode, do this now by clicking **Add an Account...** in the dropdown menu. + +In the upper left-hand corner, press the play button to start building ScummVM. When the build has finished, it will launch on your connected device. + + +Jailbreak +^^^^^^^^^^^^ + +How to jailbreak an iOS device is outside the scope of this documentation. However, should you have a device that is jailbroken, iOS .deb and .ipa packages are available for install from the `ScummVM downloads page `_. + +Prerequisites +*************** + +- A jailbroken iOS device +- A file manager app such as Filza on your iOS device + + +Installing ScummVM +******************* + +Go to the `ScummVM downloads page `_ and download the recommended .deb package. Your device will ask how to open the file. Choose Filza. + +Ensure the .deb package is saved somewhere in the ``/var/mobile`` directory. It should default to ``/var/mobile/Documents``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM. + +The .ipa package can be installed in the same way. + +You will need to restart your device for the install to complete. + +Transferring game files +======================================= + +There are multiple ways to transfer game files to your iOS device. + +ScummVM has built-in Cloud functionality, which allows you to connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../settings/cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../settings/lan` page. + +.. note: + + ScummVM's Cloud functionality does not currently support iCloud, however it is possible to upload game folders to your iCloud and then use the Files app on your iOS device to copy these folders into the local ScummVM folder. + +Another way to transfer files (for macOS Catalina and newer) to your device is by using the Finder while your device is connected to your Mac. In the Finder app on your Mac, navigate to **Locations** in the left pane, and click on the connected device. Click on **Files**, then drag and drop the folder containing the game files into the **ScummVM** folder. + +.. image:: ../images/ios/ios_transfer_files.gif + +For older versions of macOS, and for Windows users, file transfer can be done in iTunes. + +For more information on which files ScummVM requires, and how to add and play games, see `adding and playing games `_. + +Controls +============ + +.. csv-table:: + :widths: 40 60 + :header-rows: 2 + + Game Controller Mapping, + Action,Touch screen control + Left click,Single tap + Right click,"Hold one finger on screen where you want to click, single tap another" + Arrow keys,Use a three finger swipe in the direction of the arrow key you want. You can also use the arrow buttons in the bar above the keyboard. You may need to scroll across on smaller screens to see these. + ESC,"Hold one finger on screen, double tap another, or use the Esc key in the bar above the keyboard." + Tab,The Tab button in the bar above the keyboard. + Return,The Return button in the bar above the keyboard. + Global Main Menu,"Swipe two fingers down from top to bottom, or the left-most button in the bar above the keyboard." + Enable/disable keyboard,"The pinch gesture enables or disables the keyboard. If no external keyboard is connected, this shows and hides the On Screen keyboard. When an external keyboard is connected, instead of showing/hiding the On Screen keyboard this enables/disables inputs from the external keyboard." + F 0-9 keys,The F-bar above the keyboard. + Pause,Keyboard spacebar + Toggle `Click and drag mode`_,Swipe two fingers up from bottom to top. + Toggle `Touchpad mode`_,Swipe two fingers from left to right. + +Click and drag mode +^^^^^^^^^^^^^^^^^^^^ + +In this mode, a mouse click is sent immediately when you touch the screen, drags to wherever you slide your finger, and releases where you lift your finger. If you press down a second finger in this mode, you effectively release the left mouse button, and press down the right one, which is then released when you lift your finger again. + +This is especially useful for Monkey Island 3: The Curse of Monkey Island and Full Throttle. + +Touchpad mode +^^^^^^^^^^^^^^^^ + +In this mode, the cursor doesn't stay underneath your finger, but is rather moved around from its current position depending on the direction of your finger movement, just like a touchpad on a laptop. + +Settings +============ + + +Paths +======= + +Saved games +^^^^^^^^^^^^^^^^^ + +``/var/mobile/Library/ScummVM/Savegames/`` or ``/ScummVM/Savegames/`` for a sandboxed version. + +Configuration file +^^^^^^^^^^^^^^^^^^^^^^^ + +``/var/mobile/Library/ScummVM/Preferences`` or ``/Preferences`` for a sandboxed version. + +Known issues +=============== + + + + + + + + + + + diff --git a/doc/docportal/other_platforms/nintendo_switch.rst b/doc/docportal/other_platforms/nintendo_switch.rst new file mode 100644 index 00000000000..8e05ccbfaaf --- /dev/null +++ b/doc/docportal/other_platforms/nintendo_switch.rst @@ -0,0 +1,167 @@ +============================= +Nintendo Switch +============================= + +Installing ScummVM +=================== + +Prerequisites +**************** + +- A homebrew-enabled Nintendo Switch console. How to enable homebrew is outside the scope of this documentation. +- At least one ScummVM supported game. See the `compatibility page `_ on our website for a list of compatible games. + +Installing ScummVM +******************* + +The Nintendo Switch package is available for download on our website's `Downloads page `_. + +Download the ``.zip`` archive to a computer, and extract the files. + +Copy the extracted ``scummvm`` folder to your Nintendo Switch microSD card, into the ``/switch/`` folder. + + +Transferring game files +======================= + +Copy the folders containing game files into the ``/switch/scummvm/`` folder on the microSD card. + +ScummVM on the Nintendo switch supports :ref:`Cloud functionality `. + +For more information on how to add and play games, see the :doc:`../using_scummvm/adding_games` page. + +Controls +================= + +Default control mapping +********************************* + +These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. + +See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts. + +.. csv-table:: + :widths: 40 60 + :header-rows: 1 + + Button,Action + Left stick,Mouse + R + Left stick,Slow Mouse + B,Left mouse button + A,Right mouse button + DPad,"Keypad 'Cursor' Keys" + R + DPad,"Diagonal Keypad 'Cursor' Keys" + L Trigger,Game menu (F5) + R Trigger,Shift + Y,Period + R + Y,Space + X,Escape + R + X,Return + Plus,Global main menu (GMM) + Minus,Toggle virtual keyboard + R + Minus,AGI predictive input dialog + +.. csv-table:: + :widths: 40 60 + :header-rows: 2 + + "Touch Controls (Touchpad Mouse Mode Off, Default)", + Touch,Action + Short single finger tap,Move pointer to finger position and left mouse button click + Short second finger tap while holding one finger,Move pointer to first finger position and right mouse button click + Single finger drag,Move pointer directly with finger + `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed. + `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed. + +.. csv-table:: + :widths: 40 60 + :header-rows: 2 + + Touch Controls (Touchpad Mouse Mode On), + Touch,Action + Short single finger tap,Left mouse button click + Short second finger tap while holding one finger,Right mouse button click + Single finger drag,"Move pointer indirectly with finger, pointer speed can be adjusted in control settings" + `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed. + `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed. + +Keyboard and mouse support +**************************** +Physical USB mice and keyboards work on the Switch and are supported by ScummVM. + +- All keyboards work. +- Not all mice work. A mouse compatibility list is available on this `Google Sheet `_. + +Touch support +*************** + +For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch will not erroneously recognize them as a single finger, otherwise the pointer will jump around. + +The touch control scheme can be switched in the global settings. Go to **Options > Controls > Touchpad mouse mode**. + + - When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to the finger. + + - When touchpad mouse mode is on, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad. + - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement. + +Two finger drag +^^^^^^^^^^^^^^^^^^^ + +The two finger drag works in the following way: holding down two fingers for a while initiates a drag and drop feature, where the left mouse button is being held down. + +- The first finger affects mouse motion during the drag, the second finger can be removed without affecting the drag. +- When the last finger is removed, the left mouse button is released and the drag is over. +- The second finger can be anywhere, it doesn't have to be close to the first finger, and it doesn't have to be put down simultaneously with the first finger. + +Typical usage of the two finger drag and drop in Full Throttle: + - Hold down one finger over an object. + - Hold down a second finger somewhere on the screen for a little bit to initiate a two finger drag. This brings up the action menu. + - Let go of the second finger. The two finger drag continues since one finger is still down. + - Select an action with the first finger, and let go of the first finger to end the drag. + +Three finger drag +^^^^^^^^^^^^^^^^^^^^ +The three finger drag works in a similar way to the `Two finger drag`_, except that instead of holding down a single second finger, you hold down two extra fingers. Holding down the three fingers for a while initiates a drag and drop feature, where the right mouse button is being held down. + + +Paths +======= + +Saved games +******************* +``/switch/scummvm/saves`` + +Configuration file +************************** +``/switch/scummvm/scummvm.ini`` + + +Settings +========== + +For more information, see the Settings section of the documentation. Only platform-specific differences are listed here. + +Audio +****** + +Supported devices: + +- MT-32 emulator +- FluidSynth (General MIDI emulator) +- AdLib emulator + +Supported audio file formats: + +- ``.mp3`` +- ``.ogg`` +- ``.flac`` +- Uncompressed audio + +Controls +********* + +See the `Touch support`_ section. + +Known issues +============== + diff --git a/doc/docportal/other_platforms/ps_vita.rst b/doc/docportal/other_platforms/ps_vita.rst new file mode 100644 index 00000000000..44c3aaf5298 --- /dev/null +++ b/doc/docportal/other_platforms/ps_vita.rst @@ -0,0 +1,191 @@ +===================== +Playstation Vita +===================== + +Installing ScummVM +======================= + +Prerequisites +******************* + +- A homebrew-enabled PS Vita console with `Vitashell `_ installed. How to enable homebrew is outside the scope of this documentation. +- At least one ScummVM supported game. See the `compatibility page `_ on our website for a list of compatible games. + +Installing ScummVM +******************* + +The PS Vita package is available for download on our website's `Downloads page `_. + +Copy the ``.vpk`` to the PS Vita and install it using VitaShell. + + +Transferring game files +======================= + +There are a few ways to transfer game files to the PS Vita. + +Using VitaShell: + + - Transfer over FTP + - Transfer via USB + +If you're using SD2Vita: + + - Transfer the files directly to the microSD card. + +Folders containing game files can be copied into any folder. + +ScummVM on the PS Vita supports :ref:`Cloud functionality `. + +For more information on how to add and play games, see the :doc:`../using_scummvm/adding_games` page. + + +Controls +================= + +Default control mapping +********************************* + +These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. + +See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts. + +.. csv-table:: + :widths: 40 60 + :header-rows: 2 + + Game Controller Mapping, + Button,Action + Left stick,Mouse + R + Left stick,Slow Mouse + Cross,Left mouse button + Circle,Right mouse button + DPad,Keypad 'Cursor' Keys + R + DPad,Diagonal Keypad 'Cursor' Keys + L Trigger,Game menu (F5) + R Trigger,Shift + Square,Period + R + Square,Space ' + Triangle,Escape + R + Triangle,Return + Start,Global main menu (GMM) + Select,Toggle virtual keyboard + R + Select,AGI predictive input dialog + +.. csv-table:: + :widths: 40 60 + :header-rows: 2 + + "Front Touchscreen Controls, always enabled", + Touch,Action + Short single finger tap,Move pointer to finger position and left mouse button click + Short second finger tap while holding one finger,Move pointer to first finger position and right mouse button click + Single finger drag,Move pointer directly with finger + `Two finger drag`_ ,Move pointer while left mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed. + `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer directly follows the first finger. The drag is ended when the last finger is removed. + +.. csv-table:: + :widths: 40 60 + :header-rows: 2 + + "Back Touchpad Controls, enabled via settings", + Touch,Action + Short single finger tap,Left mouse button click + Short second finger tap while holding one finger,Right mouse button click + Single finger drag,"Move pointer indirectly with finger, pointer speed can be adjusted in control settings" + `Two finger drag`_,Move pointer while left mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed. + `Three finger drag`_ ,Move pointer while right mouse button is held down (drag and drop). The pointer motion is affected by the first finger. The drag is ended when the last finger is removed. + +Keyboard and mouse support +**************************** + +Real bluetooth mice and keyboards work on the Vita and are supported by ScummVM. Go to **Settings > Devices** on the Vita home screen to pair your devices. + +.. note:: + + Not all bluetooth keyboards or mice pair successfully with the Vita. + + We tested the Jelly Bean BT keyboard and mouse combo (ASIN:B06Y56BBYP) and with the standalone Jelly Comb Bluetooth Wireless Mouse (ASIN:B075HBDWCF). + +Touch support +**************** + +For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch will not erroneously recognize them as a single finger, otherwise the pointer will jump around. + +The touch control scheme can be switched in the global settings. Go to **Options > Controls**: + + - When **Touchpad mouse mode** is off: + + - The touch controls are direct, which means the pointer always jumps to the finger position. + - The rear touchpad is disabled. + + - When **Touchpad mouse mode** is on: + + - The touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad. + - The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement. + - The rear touchpad is enabled. + + +The front touchscreen uses the direct mode by default, but this can be changed by editing the :doc:`configuration file <../advanced_options/configuration_file>` with the following keyword: + +.. _frontpanel: + +*frontpanel_touchpad_mode* + +When set to true, this forces the front touchscreen into an indirect mode similar to the rear touchpad. + +Two finger drag +^^^^^^^^^^^^^^^^^^^ + +The two finger drag works in the following way: holding down two fingers for a while initiates a drag and drop feature, where the left mouse button is being held down. + +- The first finger affects mouse motion during the drag, the second finger can be removed without affecting the drag. +- When the last finger is removed, the left mouse button is released and the drag is over. +- The second finger can be anywhere, it doesn't have to be close to the first finger, and it doesn't have to be put down simultaneously with the first finger. + +Typical usage of the two finger drag and drop in Full Throttle: + - Hold down one finger over an object. + - Hold down a second finger somewhere on the screen for a little bit to initiate a two finger drag. This brings up the action menu. + - Let go of the second finger. The two finger drag continues since one finger is still down. + - Select an action with the first finger, and let go of the first finger to end the drag. + +Three finger drag +^^^^^^^^^^^^^^^^^^^^ +The three finger drag works in a similar way to the `Two finger drag`_, except that instead of holding down a single second finger, you hold down two extra fingers. Holding down the three fingers for a while initiates a drag and drop feature, where the right mouse button is being held down. + +Paths +============================ + +Saved games +******************* +``ux0:/data/scummvm/saves`` + +Configuration file +************************** +``ux0:/data/scummvm/scummvm.ini`` + + +Settings +=========================== + +For more information, see the Settings section of the documentation. Only platform-specific differences are listed here. + +Audio +****** + +Supported audio file formats: + +- ``.mp3`` +- ``.ogg`` +- ``.flac`` +- Uncompressed audio + +Controls +********* + +See the `Touch support`_ section. + +Known Issues +=============== + +MT-32 emulation is not available on the PS Vita. \ No newline at end of file diff --git a/doc/docportal/other_platforms/psp.rst b/doc/docportal/other_platforms/psp.rst new file mode 100644 index 00000000000..7568794a3d6 --- /dev/null +++ b/doc/docportal/other_platforms/psp.rst @@ -0,0 +1,137 @@ +===================== +Playstation Portable +===================== + +Installing ScummVM +=================== + +Prerequisites +**************** + +- A homebrew-enabled PSP. How to enable homebrew is outside the scope of this documentation. +- At least one ScummVM supported game. See the `compatibility page `_ on our website for a list of compatible games. + +Installing ScummVM +******************* + + +The PSP package is available for download on our website's `Downloads page `_. + +Download the ``.zip`` archive to a computer, and extract the files. + +Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. The computer should automatically open the root folder of the PSP. Alternatively, if you have a Memory Stick adapter, copy the files directly to the Memory Stick. + +Copy the extracted ``scummvm`` folder to your PSP, into the ``/PSP/GAME/`` folder. + +Go to **Game > Memory Stick** and choose **ScummVM** to launch ScummVM! + +Transferring game files +========================== + +Transfer game files onto the PSP as described in the installation section above. They can be copied to any folder; location doesn't matter. + +For more information, see :doc:`../using_scummvm/adding_games`. + +Controls +================= + +Default control mapping +********************************* + +These controls can also be manually configured in the :doc:`Keymaps tab<../settings/keymaps>`. + +See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts. + +.. csv-table:: + :widths: 40 60 + :header-rows: 2 + + Game Controller Mapping, + Button,Action + Right trigger,Modifier key + Left trigger,ESC + Analog,Mouse movement + Right trigger + Analog,Fine mouse movement + D-Pad,Arrow keys + D-Pad + Right Trigger,Diagonal arrow keys + Triangle,Enter + Cross,Left Mouse Button + Circle,Right Mouse Button + Square,Period + Right trigger + Square,Spacebar + Right trigger + Start,F5 + Select,Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with D-Pad). + Right trigger + Select,Show Image Viewer + Start,Global main menu + +.. csv-table:: + :widths: 40 60 + :header-rows: 1 + + Virtual Keyboard Mode, + Start,Enter. Also exits virtual keyboard mode + Select,Exit the virtual keyboard mode + Right trigger,Input: lowercase/uppercase letters (press to toggle) + Left trigger,Input: numbers/symbols (press to toggle) + D-Pad,"Select square of characters (up, down, left or right)" + Buttons/Triggers,Choose a specific character in the square. The four center characters are chosen by the button in the corresponding position. The 2 top characters are chosen by the triggers. + Analog,Moves in a direction (left/right/up/down) + +.. csv-table:: + :widths: 40 60 + :header-rows: 1 + + Image Viewer, + Left/Right,Previous/next image + Up/down,Zoom in/out + Analog,Move around the image + "Triggers, Start",Exit image viewer + +.. csv-table:: + :widths: 40 60 + :header-rows: 1 + + 1st Person Game Mode , + Right Trigger + Left Trigger + Square,Enable 1st Person Mode + Square,Modifier key (instead of Right Trigger) + Left/Right Trigger,Strafe left/right + D-Pad Left/Right,Turn left/right + Square + D-Pad,F1/F2/F3/F4 + Square + Select,Image Viewer + Square + Start,Esc + +Settings +=========================== + +For more information, see the Settings section of the documentation. Only platform-specific differences are listed here. + +Audio +******* +Supported audio file formats: + +- ``.mp3`` +- ``.ogg`` +- Uncompressed audio + +Games will generally run faster if audio files are in the ``.mp3`` file format. + + +Paths +======================== + +Saved games +************ + +``ms0://scummvm_savegames/`` + +Configuration file +******************** + +``ms0:/scummvm.ini`` + +Known issues +============== + +- Plugin files are not interchangeable between ScummVM versions. You must copy all the plugin files found in the ``PSP/GAME/scummvm/plugin/`` folder for every new version you install. If ScummVM crashes on startup, delete the existing plugin files in the plugin directory and copy the new ones again. + +- The PSP does not support audio files in the ``.flac`` file format. For games with voice (talkies), ensure the ``monster.sou`` file is not compressed to ``monster.sof``. \ No newline at end of file