madcow/scummvm-cursorfix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Leon Krieg
2026-02-02 04:50:13 +01:00
commit 5b11698731
22592 changed files with 7677434 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
doc/docportal/other_platforms/amigaos_4.rst Normal file
View File

@@ -0,0 +1,73 @@
=============================
AmigaOS 4
=============================
This page contains all the information you need to get ScummVM up and running on AmigaOS 4.
What you'll need
===================
- A system running Amiga OS 4
Installing ScummVM
=====================================
ScummVM is available for download from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_ or the `OS4 Depot <http://www.os4depot.net>`_.
Download and extract the ``.lha`` file.
Optional: Run the extracted ``ScummVM_Install`` script. This installer guides you through the installation process.
.. figure:: ../images/amigaos_4/installer.png
The ScummVM installer.
Note: AmiUpdate is already aware of ScummVM and will automatically keep ScummVM up to date through its ``Autoinstall`` script.
Transferring game files
=========================
For games on PC or Mac formatted discs, use the original platform to access the data files, and then transfer these to Amiga. Alternatively, if you have external hardware such as a Catweasel Mk4(+) floppy disc controller, you might be able to use this to access the files.
ScummVM for Amiga OS has Cloud and LAN functionality, to help manage the transfer of files. See :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common default keyboard shortcuts.
Paths
=======
See below for the default location of saved games and scummvm.ini.
They can be changed in the Settings.
Saved games
*******************
``Path-to:ScummVM/saves``
Configuration file
**************************
``Path-to:ScummVM/scummvm.ini``
Settings
==========
For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
******
The CAMD driver allows the use of MIDI hardware. Select CAMD as the :ref:`Preferred device <device>`.
Known issues
==============
Due to the big-endian nature of Amiga OS, there can sometimes be graphics and sounds issues with games. Check out the Platform Overview `wiki page <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ for a list of compatible engines.
If a game crashes and it's listed as compatible, please report it as a :doc:`bug <../help/report_bugs>`.

236
doc/docportal/other_platforms/android.rst Normal file
View File

@@ -0,0 +1,236 @@
===============
Android
===============
This page contains all the information you need to get ScummVM up and running on an Android device.
What you'll need
================
- An Android device running Android 4.1 (Jelly Bean) or newer.
.. note::
ScummVM has been tested to work up to Android 16.
Installing ScummVM
====================================
There are two ways to install ScummVM on an Android device; install it from the Google Play Store, or manually download and install the APK package from the ScummVM downloads page.
Installing from the Google Play Store
***************************************
The latest supported version of ScummVM is on the Google Play Store; search for ScummVM on the Google Play Store and select **Install**.
Manually installing the APK package
*************************************
On your device, use a web browser app to navigate to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_. The recommended download section on the page suggests 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, find out whether the device has a 32 or 64-bit operating system, and which chipset the device has. Do an internet search using the device model number to find these details.
Click on the correct package to start the download. After it has downloaded, go to the file and tap on it to start the install process. Use either a file manager app, or select the file directly from the web browser downloads. The file manager or the web browser asks for permission to install the package, and after permission is granted, returns to the install.
.. note::
The downloaded APK package is treated as an app from an unknown source, because it doesn't originate in the Google Play store. To allow unknown apps:
- For Android 7 or lower, go to **Settings > Security > Device Administration**, scroll down to **Device Administration** and enable **Unknown Sources**.
- For Android 8 or higher, go to **Settings > Apps and Notification** and select **Install Unknown Apps**.
Transferring game files
========================================
ScummVM has built-in Cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
There are a few other options to transfer the game files:
- Copy the files directly onto the microSD card, if the device has one.
- USB transfer from a computer. To complete file transfer by 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 opens.
- Download games such as freeware games or those from digital distributors directly to your device.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Adding games
================
1. Select **Add Game...** from the launcher.
2. Inside the ScummVM file browser, select **Go Up** until you reach the root folder which has the **<Add a new folder>** option.
.. figure:: ../images/android/browser-root.png
Root folder with <Add a new folder> option
3. Double-tap **<Add a new folder>**. In your device's file browser, navigate to the folder containing all your game folders. For example, **SD Card > ScummVMgames**
.. figure:: ../images/android/fs-root.png
Android file browser root
.. figure:: ../images/android/fs-folder.png
Android file browser selectable folder with **Use this folder** button
4. Select **Use this folder**.
5. Select **ALLOW** to give ScummVM permission to access the folder.
.. figure:: ../images/android/fs-permission.png
Android file browser request to grant ScummVM directory access permission
6. In the ScummVM file browser, double-tap to browse through your added folder. Add a game by selecting the sub-folder containing the game files, then tap **Choose**.
To add more games, repeat Steps 1 and 6.
.. _addSAFpath:
.. note::
Starting with version 2.7.0 of ScummVM for Android, significant changes were made to the file access system to allow support for modern versions of the Android Operating System.
If existing added games or custom paths no longer work, go to **Game Options > Paths**, select the path to update, then follow steps 2 through 6 above.
.. _addSAFpathRestrictedFilesProfile:
.. note::
If the Android device's **Files** app has been manually deactivated, please re-activate it, if possible, because it is used by ScummVM as the native File explorer.
Furthermore, an Android user with a **restricted profile** might not be able to run the device's **Files** app with full access rights, so it will be impossible to browse the list of folders and files on external storage (SD Card) of their device to choose a folder to grant ScummVM the SAF access permission.
.. _addSAFpathAndroidStudioDeviceExplorerKnownIssue:
.. note::
On a few devices it was observed that when Android Studio's "Device Explorer" utility is used to browse the device's folders and upload files from a PC to the Android device then, upon re-launching ScummVM on that device, it may behave as all granted SAF access permissions are lost and cannot be granted again. In this case, a device restart should fix this odd "hiccup"; after the restart, ScummVM will properly acknowledge any previously configured SAF-accessible folders.
Removing permissions
************************
To remove any folder permissions granted to ScummVM, go to the **Global Options > Backend** tab.
.. figure:: ../images/android/gui-remove-permissions.png
Backend tab with "Remove folder authorizations..." button
.. figure:: ../images/android/gui-remove-list.png
Dialog with list of permissions to remove
If any permissions are removed in error, see :ref:`this note <addSAFpath>` for instructions to reinstate them.
Controls
=============
Default control mapping
****************************
Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. csv-table::
:header-rows: 1
:class: controls
Touch screen control, Action
One finger tap, Left mouse button click
One finger tap + movement, Mouse movement
One finger tap and hold for >0.5s, Right mouse button click
One finger tap and hold for >1s, Middle mouse button click
Double tap + movement, "Left mouse button hold and drag, such as for selection from action wheel in Curse of Monkey Island"
Two finger tap, Right mouse button click
Two finger tap + movement of second finger, "Right mouse button hold and drag, such as for selection from action wheel in Tony Tough"
Two finger slide up/down, Scroll (reverse mouse wheel)
Three finger tap, Middle mouse button click
Three finger tap + movement of third finger, Middle mouse button hold and drag
Long press system Back button, Opens Global Main Menu
Short press system Back button, "Skip, or Cancel/Quit in the Launcher"
Long press system Menu button, Opens/closes Virtual keyboard
Short press system Menu button, Opens Global Main Menu
D-pad up/down/left/right, Mouse movement
D-pad center, Left mouse button click
Trackball movement, Mouse movement
Trackball click, Left mouse button click
Touch controls
****************
The touch control scheme can be configured in the global settings. From the Launcher, go to **Options > Backend > Choose the preferred touch mode**.
It's possible to configure the touch mode for three situations (ScummVM menus, 2D games and 3D games) and choose one of the three possible modes:
- Direct mouse, the touch controls are direct. The pointer jumps to where the finger touches the screen (default for menus).
- Touchpad emulation, the touch controls are indirect. The finger can be far away from the pointer and still move it, like on a laptop touchpad.
- Gamepad emulation, the touch controls don't move any mouse. The fingers must be placed on lower left and right of the screen and respectively emulate a directional pad and action buttons.
- The pointer speed setting in the :doc:`Controls tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
The touch mode can be switched at anytime by tapping on the controller icon, next to the menu icon at the top right of the screen.
To display or hide the small controller icon, from the Launcher select **Options** and then the **Backend** tab. Tick the **Show on-screen control** box to enable the controller icon.
Two finger tap
^^^^^^^^^^^^^^^^^
To perform a two finger tap, hold one finger down and then tap with a second finger.
Three finger tap
^^^^^^^^^^^^^^^^^^
To perform a three finger tap, start with holding down one finger and progressively touch down the other two fingers, one at a time, while still holding down the previous fingers. Imagine you are impatiently tapping your fingers on a surface, but then slow down that movement so it is rhythmic, but not too slow.
Two finger slide
^^^^^^^^^^^^^^^^^
To perform a two finger slide, place two fingers on the touch screen (typically the index and middle finger) and slide them upwards or downwards.
Immersive Sticky fullscreen mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ScummVM for Android uses the Immersive Sticky fullscreen mode, which means that the Android system bar is hidden until the user swipes from an edge with a system bar. Swipe from the edge to reveal the system bars. They remain semi-transparent and disappear after a few seconds unless you interact with them. Your swipe also registers in the game, so if you need to swipe from an edge with system bars, your game play is not interrupted.
Global Main Menu
^^^^^^^^^^^^^^^^^^
To open the Global Main Menu, tap on the small menu icon at the top right of the screen.
To display or hide the small menu icon, from the Launcher select **Options** and then the **Backend** tab. Tick the **Show on-screen control** box to enable the menu icon.
Virtual keyboard
^^^^^^^^^^^^^^^^^^^^^
To open the virtual keyboard, long press on the small controller icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the small controller icon (which became a keyboard one) again, or tap outside the text field.
Paths
=======
Saved games
**************
By default, the saved games are saved in the internal app folder. To change the path, go to the :doc:`../settings/paths` tab in either the global or game-specific settings.
Configuration file
************************
The configuration file is in the internal app folder, and this path cannot be changed.
Accessing the internal app folder
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To access the internal app folder, use ScummVM's built-in LAN functionality:
1. From the Launcher, select **Options** and then the **LAN** tab.
2. Select **/root/Path**.
3. Use the file browser to **Go up** to the root of the ScummVM file browser.
4. Select the **ScummVM data (Internal)** folder, and tap **Choose**.
5. Run the server to access the ``scummvm.ini`` configuration file.
For more information, see the :doc:`../use_scummvm/LAN` page.
Known issues
===============
- If ScummVM is uninstalled or downgraded, its internal and external app spaces are fully deleted. If you want to keep the saved games, use ScummVM's :doc:`cloud <../use_scummvm/connect_cloud>` or LAN functionality to keep those files. Alternatively, change the saved game path to a shared location such as an SD card.

87
doc/docportal/other_platforms/atari.rst Normal file
View File

@@ -0,0 +1,87 @@
=============================
Atari/FreeMiNT
=============================
This page contains all the information you need to get ScummVM up and running on an Atari system.
What you'll need
=================
- A powerful Atari system or clone; recommended minimum CPU 68060.
- FreeMiNT, TOS or MagiC operating system.
Installing ScummVM
=====================================
Binary packages are provided for the m68000 CPU, the m68020 to m68060 range of CPUs, and the Coldfire (FireBee) CPU. All are available for download from the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_. To install ScummVM, extract the selected ScummVM archive into a folder on the hard disk.
Run ``scummvm.gtp`` to start Scummvm. The ``scummvm.gtp`` command will take :doc:`command line options <../advanced_topics/command_line>` to set parameters for the ScummVM session.
To run ScummVM from a FreeMiNT Command Line Interface, make the program executable with the following command:
.. code-block:: bash
chmod +x scummvm.gtp
For the best performance, run ScummVM under FreeMiNT, from the command line, and without the AES started.
Transferring game files
=========================
Transfer files to the Atari as you normally would, such as through a network connection or by optical disc.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
Paths
=======
FreeMiNT
***************
Saved games and the configuration file are found in the user’s defined home directory.
MagiC/TOS
***************
Saved games and the configuration file are found in the ScummVM installation directory.
Settings
==========
For more information, see the Settings section of the documentation. Only platform-specific differences are listed here.
Graphics
************
For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. This is not a ScummVM setting, but rather a system-wide setting.
.. tip::
XBIOS works better than GEM, because GEM rendering is generally slower.
Audio
*******
Supported audio file formats:
- MP3
- OGG
- FLAC
- Uncompressed audio
Known issues
==============
- There is no cloud/LAN functionality.
- The Atari built-in MIDI driver (STMIDI) does not work.
- FLAC, OGG and MP3 decoding libraries are extremely CPU intensive and greatly slow down the user experience. ScummVM is best run with uncompressed audio, when available.
- While all supported engines are included in the Atari ScummVM release, not all games will run well due to the lack of resources. For example, the Curse of Monkey Island will run on a CT60-equipped Atari Falcon, but very poorly.

141
doc/docportal/other_platforms/ios.rst Normal file
View File

@@ -0,0 +1,141 @@
==============
iOS
==============
This page contains all the information you need to get ScummVM up and running on an iOS device.
ScummVM is an open source software, which means you can get, modify, and compile the source code yourself. If you want to do so, see the :doc:`ios_build` page.
Transferring game files
========================
ScummVM comes bundled with a few games and demos, but it supports many more games. See :doc:`../use_scummvm/add_play_games` for more information.
There are multiple ways to transfer game files to your iOS device.
ScummVM has built-in cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
.. note::
ScummVM's cloud functionality does not currently support iCloud, however you can 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 the folder containing the game files into the **ScummVM** folder. For older versions of macOS, and for Windows users, file transfer can be done in iTunes.
.. image:: ../images/ios/ios_transfer_files.gif
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
============
.. csv-table::
:widths: 40 60
:header-rows: 1
:class: controls
Touch screen control, Action
One finger tap, Left mouse click
:ref:`twofinger`, Right mouse click
:ref:`twofingerdouble`, ESC
One finger press & hold for >0.5s, "Left mouse button hold and drag, such as for selection from action wheel in Curse of Monkey Island"
Two fingers press & hold for >0.5s, "Right mouse button hold and drag, such as for selection from action wheel in Tony Tough"
Two finger swipe (left to right), Toggles between touch direct mode and touchpad mode
Two finger swipe (right to left), Show/hide on-screen control (iOS 15 and later)
Two finger swipe (top to bottom), Global Main Menu
Three finger swipe, Arrow keys
Pinch gesture, Enables/disables keyboard
Keyboard spacebar, Pause
.. csv-table::
:widths: 40 60
:header-rows: 1
:class: controls
Apple Pencil control, Action
Touch, Left mouse click
Touch & hold for >0.5s, "Left mouse button hold and drag, such as for selection from action wheel in Curse of Monkey Island"
3 quick touches, Right mouse click
3 quick touches & hold for >0.5s, "Right mouse button hold and drag, such as for selection from action wheel in Tony Tough"
Touch controls
*******************
The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**. It's possible to configure the touch mode for three situations (ScummVM menus, 2D games and 3D games) and choose one of the two possible modes:
- Direct mouse, the touch controls are direct. The pointer jumps to where the finger touches the screen (default for menus).
- Touchpad emulation, 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 touch mode can be switched at anytime by tapping on the controller icon, next to the menu icon at the top right of the screen.
To display or hide the small controller icon, from the Launcher select **Options** and then the **Backend** tab. Tick the **Show on-screen control** box to enable the controller icon.
.. _twofinger:
Two finger tap
^^^^^^^^^^^^^^^^^^^^^
For a two finger tap, hold one finger down and then tap with a second finger.
.. _twofingerdouble:
Two finger double tap
^^^^^^^^^^^^^^^^^^^^^^^
For a two finger double tap, hold one finger down and then double tap with a second finger.
Keyboard
^^^^^^^^^^^^^^^^^^^^
If no external keyboard is connected, the pinch gesture shows and hides the onscreen keyboard. When an external keyboard is connected, input from the external keyboard is enabled by default.
External keyboards are supported and from iOS 13.4 most of the special keys, e.g. function keys, Home and End, are mapped.
For external keyboards missing the special keys, e.g. the Apple Magic Keyboard for iPads, the special keys can be triggered using the following key combinations:
.. csv-table::
:widths: 40 60
:header-rows: 1
:class: keyboard
Key combination, Action
CMD + 1, F1
CMD + 2, F2
"...", "..."
CMD + 0, F10
CMD + SHIFT 1, F11
CMD + SHIFT 2, F12
CMD + UP, PAGE UP
CMD + DOWN, PAGE DOWN
CMD + LEFT, HOME
CMD + RIGHT, END
Game controllers
^^^^^^^^^^^^^^^^^^^^
If running iOS 14 and later there is support for connected mouses and gamepad controllers using the Apple Game Controller framework. Only "Extended Gamepad Controllers" are supported at the moment. For more information visit https://developer.apple.com/documentation/gamecontroller/gcextendedgamepad
Paths
=======
Saved games
**************
``/var/mobile/Library/ScummVM/Savegames/`` if the device is jailbroken, or ``Savegames/`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
Configuration file
*********************
``/var/mobile/Library/ScummVM/Preferences`` if the device is jailbroken, or ``Preferences`` in the ScummVM folder for a non-jailbroken device. Access this folder through the Finder or iTunes.
Known issues
===============
- If ScummVM is uninstalled or downgraded, its internal and external app spaces are fully deleted. If you want to keep saved games use ScummVM's :doc:`cloud <../use_scummvm/connect_cloud>` or LAN functionality to keep those files. Alternatively, change the saved game path to a shared location such as an SD card.
- If closing the ScummVM application (background mode) and then killing the application (by swiping the application upwards) there is a risk that the ScummVM configuration file becomes corrupted. Make sure not to kill the application too soon after putting it in the background.
- In rare cases the ScummVM folder is not created in the "Files" application after installing ScummVM. Make sure the ScummVM folder shows up after installation. If not, uninstall ScummVM, restart the iOS device, and reinstall ScummVM.
- In rare cases the system mouse pointer on iPadOS is not hidden so both the ScummVM arrow pointer and the iPadOS system pointer are seen at the same time. It's usually fixed by restarting the iPad.

135
doc/docportal/other_platforms/ios_build.rst Normal file
View File

@@ -0,0 +1,135 @@
==========================
Build instructions for iOS
==========================
This page contains all the information you need to build and install ScummVM on your iOS device. While a basic knowledge of the command line would be useful, the following instructions, if followed carefully, can be completed by anyone.
What you'll need
^^^^^^^^^^^^^^^^^^^^
- 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 <https://developer.apple.com/membercenter/>`_ with your Apple ID.
- The ScummVM `iOS Libraries <https://downloads.scummvm.org/frs/build/scummvm-ios7-libs-v4.zip>`_ downloaded, and the zip file extracted.
.. 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 rebuild ScummVM every week.
Step 1: Setting up the Xcode project
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The first step is to download the repository containing the code required to build the app. The next steps require use of the command line. Go to **Applications > Utilities > Terminal** and copy and paste the following, then press :kbd:`return`. This downloads (clones) the source code into your Home directory, into a folder called ``scummvm``:
.. code-block:: bash
git clone https://github.com/scummvm/scummvm.git
.. tip::
To view the Home directory in the Finder, select **Go > Home** in the menu bar, or press :kbd:`command+shift+H`.
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 also installs the command line tools required.
Create a new directory called ``build`` at the same level as the repository you just cloned, using either the Finder, or the command line as follows:
.. code-block::
mkdir build
Move the contents of the ``scummvm-ios7-libs-v4`` folder you extracted earlier into the ``build`` directory, using either the Finder, or the command line as follows:
.. code-block::
mv ~/Downloads/frameworks ~/build/
If your downloaded iOS library folder is not in the Downloads folder as it is in the preceding example, change the path to where the folder actually is.
Now let's change the present working directory and then set up the tools required to create the Xcode project:
.. code-block:: bash
cd scummvm/devtools/create_project/xcode
xcodebuild
Step 2: Generating the Xcode project
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Change your present working directory to the ``build`` directory:
.. code-block::
cd ~/build
It's time to generate the Xcode project. Run the following on the command line:
.. code::
../scummvm/devtools/create_project/xcode/build/Release/create_project ../scummvm --xcode --ios --use-xcframework --enable-faad --enable-gif --enable-mikmod --enable-vpx --enable-mpc --enable-a52 --disable-taskbar --disable-tts
The resulting directory structure looks like this:
.. code-block:: bash
Home
|--scummvm
'--build
|-- frameworks
|-- engines
'-- scummvm.xcodeproj
Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
.. code-block:: bash
open scummvm.xcodeproj
Step 3: Building the ScummVM app
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When Xcode is open, connect a device to install ScummVM onto. At the top of the window, select **ScummVM-iOS** and then select the device you just connected. You will need to "Trust" the device for it to show up on the list of connected devices.
.. figure:: ../images/ios/choose_device.gif
You may need to disable bitcode generation in the build settings. This should already be disabled by default when you make a build specifically for your device, but it is enabled by default when you build for a ''Generic iOS Device''.
Unless you want to debug issues with ScummVM on iOS, you probably want to compile ScummVM in release mode to get better performances when playing games.
.. figure:: ../images/ios/ios_xcode_release.gif
The last step before building ScummVM 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** there is a field labeled **Bundle Identifier**. Enter 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. Click **Add an Account** in the dropdown menu.
In the upper left-hand corner, press the play button to build ScummVM.
.. note::
Starting with iOS 16, you may get an error message here if you haven't `enabled Developer Mode <https://developer.apple.com/documentation/xcode/enabling-developer-mode-on-a-device>`_ on your iOS device. This can be done with the **Settings > Privacy & Security > Developer Mode** switch, which will restart your device and reduce its security level.
If you can't see this option, unplug and plug your device again, and make sure that it's visible to Xcode.
When the build is finished, ScummVM launches on your connected device.
.. note::
If ScummVM does not launch and you get an error message advising that the app failed to launch due to an invalid code signature, inadequate entitlements or because its profile has not been explicitly trusted by the user, you need to trust the apps that you have built. On your iOS device, go to:
- **Settings > General > Device Management > Developer App > Trust "Apple Development:yourAppleIDhere" > Trust**
- or **Settings > General > VPN & Device Management** (iOS 15+)
Using ScummVM
==============
See the See the :doc:`ios` page.

72
doc/docportal/other_platforms/morphos.rst Normal file
View File

@@ -0,0 +1,72 @@
=============================
MorphOS
=============================
This page contains all the information you need to get ScummVM up and running on MorphOS.
What you'll need
===================
- A system running MorphOS 3.15
- SDL2 library installed, download last version : <https://www.morphos-storage.net/?find=SDL_2>
Installing ScummVM
=====================================
ScummVM is available for download from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_ or the `MorphOS Storage <https://www.morphos-storage.net/?find=scummvm>`_.
Download and extract the ``.lha`` file.
Transferring game files
=========================
For games on PC or Mac formatted discs, use the original platform to access the data files, and then transfer these to Amiga. Alternatively, if you have external hardware such as a Catweazel floppy disc controller, you might be able to use this to access the files.
ScummVM for MorphOS has Cloud and LAN functionality, to help manage the transfer of files. See :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common default keyboard shortcuts.
Paths
=======
Saved games
*******************
``PROGDIR:saves``
Configuration file
**************************
``PROGDIR:scummvm.ini``
Settings
==========
For more information about Settings, 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
- CAMD: The CAMD driver allows the use of MIDI hardware. Select CAMD as the :ref:`Preferred device <device>`.
Supported audio file formats:
- MP3
- OGG
- FLAC
- Uncompressed audio
Known issues
==============
Due to the big-endian nature of Amiga OS, there can sometimes be graphics and sounds issues with games. Check out the Platform Overview `wiki page <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ for a list of compatible engines.
If a game crashes and it's listed as compatible, report it as a :doc:`bug <../help/report_bugs>`.

148
doc/docportal/other_platforms/nintendo_3ds.rst Normal file
View File

@@ -0,0 +1,148 @@
=============================
Nintendo 3DS
=============================
This page contains all the information you need to get ScummVM up and running on a Nintendo 3DS.
What you'll need
===================
- A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
Installing ScummVM
======================================
Download the Nintendo 3DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Extract the archive.
There are two ways to install ScummVM: using the 3DSX format, or the CIA format.
Using the 3DSX format
***********************
Copy the extracted files to your SD card into the ``/3ds/scummvm`` directory.
Launch ScummVM using the Homebrew Launcher.
Using the CIA format
***********************
Use any CIA installation software to install the ``scummvm.cia`` file.
The CIA format requires a DSP binary dump saved on your SD card as ``/3ds/dspfirm.cdc``. This is not an optional step, because without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
Transferring game files
========================
Transfer game folders onto the SD card. The exact location is not important.
ScummVM for the Nintendo 3DS also has cloud functionality. See :doc:`../use_scummvm/connect_cloud`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=============
Default control mapping
****************************
Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. csv-table::
:widths: 50 50
:header-rows: 1
:class: controls
Game Controller Mapping:,
Button,Action
Circle Pad,Moves the cursor
R + Circle Pad,Slow Mouse
Ⓐ,Left mouse button
Ⓑ,Right mouse button
Ⓧ,Period (.)
Ⓨ,Escape
Control Pad,Keypad cursor keys
L Button,Toggles magnify mode on/off
R Button,Toggles between hover/drag modes
START,Opens global main menu
SELECT,Opens the virtual keyboard
.. _hover:
Hover mode
************
When using the touchscreen, hover mode simulates the movement of the mouse. You can click with taps, however you can't drag or hold down a mouse button unless you use the buttons mapped to the right/left mouse buttons.
Drag mode
**************
Simulates the click and release of the mouse buttons every time you touch and release the touchscreen. At the moment, this is only a left mouse button click.
Magnify mode
****************
Due to the low resolutions of the 3DS screens (400x240 for the top, and 320x240 for the bottom), games that run at a higher resolution will inevitably lose some visual detail from being scaled down. This can result in situations where essential information, such as text, is indiscernible.
Magnify mode increases the scale factor of the top screen back to 1, but the bottom screen remains unchanged. The touchscreen can then be used to change which part of the game display is being magnified. This can be done even in situations where the cursor is disabled, such as during full-motion video segments.
When activating magnify mode, touchscreen controls are automatically switched to :ref:`hover` mode to reduce the risk of the user accidentally inputting a click when changing the magnified area with the stylus. Clicking can still be done as in normal hover mode. Turning off magnify mode will revert controls back to what was used previously. It will also restore the top screen's previous scale factor.
Magnify mode can only be used when the following conditions are met:
- In the Backend tab in the options dialog, the **Use Screen** option is set to **Both**.
- The horizontal and/or vertical in-game resolution is greater than that of the top screen.
- You're playing a game.
Magnify mode cannot be used in the Launcher menu.
Paths
=======
Saved games
*******************
``sdmc:/3ds/scummvm/saves/``
Configuration file
**************************
``sdmc:/3ds/scummvm/scummvm.ini``
Settings
==========
For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
Backend-specific options
**************************
.. figure:: ../images/3ds/config.png
These options are specific to the 3DS port, and can be set in the :doc:`Backend tab <../settings/backend>`.
Show mouse cursor
Toggles a visible mouse cursor on/off.
Stretch to fit
Stretches the image to fit the screen
Snap to edges
The 3DS touch screen has difficulty reaching the very end of the screen. With this option enabled, if you're within a few pixels of the edge the cursor snaps to the edge.
Use Screen:
Sets whether ScummVM uses the **Top**, **Bottom** or **Both** screens.
Audio
******
Supported audio file formats:
- MP3
- OGG
- FLAC
- Uncompressed audio
Known issues
==============
Some games are not playable due to the slow CPU speed on the 3DS. If there are any games that run really slowly, this is considered a hardware limitation, not a bug.

56
doc/docportal/other_platforms/nintendo_ds.rst Normal file
View File

@@ -0,0 +1,56 @@
=============================
Nintendo DS
=============================
This page contains all the information you need to get ScummVM up and running on a Nintendo DS.
What you'll need
===================
- A homebrew-enabled Nintendo DSi or DSi XL. Note that the original DS and DS Lite are not currently supported. How to enable homebrew is outside the scope of this documentation.
Installing ScummVM
======================================
Download the Nintendo DS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Extract the archive and copy the extracted ``scummvm.nds`` file onto the SD card. The exact location is not important.
Transferring game files
========================
Transfer game folders onto the SD card. The exact location is not important.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=============
Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
Paths
=======
Saved games and the configuration file are found in the ScummVM installation directory.
Settings
==========
For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
Audio
******
Supported audio file formats:
- MP3
- Uncompressed audio
.. tip::
Games run faster if audio files are uncompressed.
Known issues
==============
- Games requiring a resolution of 512x512 or higher are not supported on the DS due to hardware limitations.
- Some games are not playable due to the slow CPU speed and limited RAM on the DS. If there are any games that run really slowly, this is considered a hardware limitation, not a bug.

163
doc/docportal/other_platforms/nintendo_switch.rst Normal file
View File

@@ -0,0 +1,163 @@
=============================
Nintendo Switch
=============================
This page contains all the information you need to get ScummVM up and running on a Nintendo Switch.
What you'll need
===================
- A homebrew-enabled Nintendo Switch console. How to enable homebrew is outside the scope of this documentation.
Installing ScummVM
=======================================
The Nintendo Switch package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
Download the zip file 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 :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Default control map
*********************************
These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |plus| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M8 2a.75.75 0 01.75.75v4.5h4.5a.75.75 0 010 1.5h-4.5v4.5a.75.75 0 01-1.5 0v-4.5h-4.5a.75.75 0 010-1.5h4.5v-4.5A.75.75 0 018 2z"></path></svg>
.. |minus| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M2 8a.75.75 0 01.75-.75h10.5a.75.75 0 010 1.5H2.75A.75.75 0 012 8z"></path></svg>
.. csv-table::
:widths: 50 50
:header-rows: 1
:class: controls
Button,Action
Left stick,Mouse
Left stick + R button,Slow Mouse
Ⓑ,Left mouse button
Ⓐ,Right mouse button
Directional buttons,"Keypad 'Cursor' Keys"
Directional buttons + R button ,"Diagonal Keypad 'Cursor' Keys"
L button,Game menu (F5)
R button,Shift
Ⓨ,Period
Ⓨ + R button,Space
Ⓧ,Escape
Ⓧ + R button,Return
|plus|,Global main menu (GMM)
|minus|,Toggle virtual keyboard
|minus| + R button,AGI predictive input dialog
Touch Controls (Touchpad Mouse Mode Off, Default)
**************************************************
.. csv-table::
:header-rows: 2
:class: touch
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.
Touch Controls (Touchpad Mouse Mode On)
***************************************
.. csv-table::
:header-rows: 1
:class: touch
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 but not all mice work. A mouse compatibility list is available on this `Google Sheet <https://docs.google.com/spreadsheets/d/1Drbo5-QuSX901MwtOytSMuqRGxeIkq2HELM806I9dj0/edit#gid=0>`_.
Touch support
****************
For multi-touch gestures, the fingers have to be far enough apart from each other that the Switch does not recognize them as a single finger, otherwise the pointer jumps around.
The touch control scheme can be switched in the global settings. From the Launcher, go to **Options > Control > Touchpad mouse mode**.
- When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to where the finger touches the screen.
- 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
^^^^^^^^^^^^^^^^^^^
Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button 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.
Three finger drag
^^^^^^^^^^^^^^^^^^^^
Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button 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.

101
doc/docportal/other_platforms/playstation_3.rst Normal file
View File

@@ -0,0 +1,101 @@
=============================
PlayStation 3
=============================
This page contains all the information you need to get ScummVM up and running on a PlayStation 3.
What you'll need
===================
- A homebrew-enabled PlayStation 3 console. How to enable homebrew is outside the scope of this documentation.
- A USB drive
- A computer
Installing ScummVM
=====================================
Download the PlayStation 3 package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_. Copy the ``.pkg`` file to a USB drive.
Plug the USB drive into the PS3. Go to the XMB, then go to **Games > Install Package** to install the ScummVM package.
To launch ScummVM, go to the XMB, then go to **Games > PlayStation 3 > ScummVM**.
Transferring game files
=======================
Games can be launched from either a USB drive, or from the internal hard drive. The hard drive has better performance.
To copy game files to the hard drive, use the USB drive, or use ScummVM's :doc:`cloud functionality <../use_scummvm/connect_cloud>`, or use LAN functionality :doc:`../use_scummvm/LAN`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
Default control map
*************************
.. |square| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="5 2 16 16" width="20" height="20"><path fill-rule="evenodd" d="M6 7.75C6 6.784 6.784 6 7.75 6h8.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0116.25 18h-8.5A1.75 1.75 0 016 16.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25h-8.5z"></path></svg>
.. |circle| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.404 3.404a6.5 6.5 0 109.192 9.192 6.5 6.5 0 00-9.192-9.192zm-1.06 10.253A8 8 0 1113.656 2.343 8 8 0 012.343 13.657z"></path></svg>
.. |x| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.72 3.72a.75.75 0 011.06 0L8 6.94l3.22-3.22a.75.75 0 111.06 1.06L9.06 8l3.22 3.22a.75.75 0 11-1.06 1.06L8 9.06l-3.22 3.22a.75.75 0 01-1.06-1.06L6.94 8 3.72 4.78a.75.75 0 010-1.06z"></path></svg>
.. |triangle| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
.. csv-table::
:widths: 50 50
:header-rows: 2
:class: controls
Touchscreen:,
Buttons/Control,Action
Left stick,Moves pointer
|x|,Left mouse button
|circle|,Right mouse button
|triangle|,Game menu
|square|,Esc
START,Global Main Menu
SELECT,Toggle virtual keyboard
L1 button,AGI predictive input dialog
Paths
=======
Saved games
*******************
``/hdd0/game/SCUM12000/USRDIR/saves/``
Configuration file
**************************
``/hdd0/game/SCUM12000/USRDIR/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

154
doc/docportal/other_platforms/playstation_portable.rst Normal file
View File

@@ -0,0 +1,154 @@
=====================
PlayStation Portable
=====================
This page contains all the information you need to get ScummVM up and running on a PSP.
What you'll need
===================
- A homebrew-enabled PSP. How to enable homebrew is outside the scope of this documentation.
- A computer to download an extract the install files.
Installing ScummVM
=======================================
The PSP package is available for download ScummVM's `Downloads page <https://www.scummvm.org/downloads>`_.
Download the zip file to a computer, and extract the files.
Connect the PSP to the computer by USB cable. Go to **Settings > USB Connection** on the PSP. Ensure the **USB Device** option is set to **Memory Stick**. The computer automatically opens 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.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Default control map
*********************************
These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="5 2 16 16" width="20" height="20"><path fill-rule="evenodd" d="M6 7.75C6 6.784 6.784 6 7.75 6h8.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0116.25 18h-8.5A1.75 1.75 0 016 16.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25h-8.5z"></path></svg>
.. |circle| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.404 3.404a6.5 6.5 0 109.192 9.192 6.5 6.5 0 00-9.192-9.192zm-1.06 10.253A8 8 0 1113.656 2.343 8 8 0 012.343 13.657z"></path></svg>
.. |x| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.72 3.72a.75.75 0 011.06 0L8 6.94l3.22-3.22a.75.75 0 111.06 1.06L9.06 8l3.22 3.22a.75.75 0 11-1.06 1.06L8 9.06l-3.22 3.22a.75.75 0 01-1.06-1.06L6.94 8 3.72 4.78a.75.75 0 010-1.06z"></path></svg>
.. |triangle| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
.. csv-table::
:widths: 50 50
:header-rows: 1
:class: controls
Button,Action
R button,Modifier key
L button,ESC
Analog stick,Mouse movement
Analog stick + R button,Fine mouse movement
Directional buttons,Arrow keys
Directional buttons + R button,Diagonal arrow keys
|triangle|,Enter
|x|,Left Mouse Button
|circle|,Right Mouse Button
|square|,Period
|square| + R button,Spacebar
SELECT,Shows/Hides the virtual Keyboard. Hold down with Directional buttons to move the keyboard.
SELECT + R button ,Shows Image Viewer
START,Global Main Menu
START + R button,F5
Virtual Keyboard Mode
**********************
.. csv-table::
:class: controls
START,Enter. Also exits virtual keyboard mode
SELECT,Exits the virtual keyboard mode
R button,Input: lowercase/uppercase letters (press to toggle)
L button,Input: numbers/symbols (press to toggle)
Directional buttons,"Selects square of characters (up, down, left or right)"
|triangle| |x| |circle| |square| and L/R buttons,Chooses 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 L/R buttons.
Analog stick,Moves in a direction (left/right/up/down)
Image Viewer
**************
.. csv-table::
:class: controls
Left/right directional buttons,Previous/next image
Up/down directional buttons ,Zooms in/out
Analog stick,Moves around the image
"L/R buttons + START",Exits image viewer
1st Person Game Mode
**************************
.. csv-table::
:class: controls
|square| + R button + L button,Enables 1st Person Mode
|square|,Modifier key (instead of R button)
L/R button,Strafes left/right
Directional buttons left/right,Turns left/right
|square| + Directional buttons,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
.. tip::
Games 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.
- If the virtual keyboard does not show up on the screen, ensure the ``kbd.zip`` file is in the ``scummvm`` folder.

200
doc/docportal/other_platforms/playstation_vita.rst Normal file
View File

@@ -0,0 +1,200 @@
=====================
PlayStation Vita
=====================
This page contains all the information you need to get ScummVM up and running on a PS Vita.
What you'll need
=======================
- A homebrew-enabled PS Vita console with `Vitashell <https://github.com/TheOfficialFloW/VitaShell/releases/tag/v2.02>`_ installed. How to enable homebrew is outside the scope of this documentation.
Installing ScummVM
======================================
The PS Vita package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
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.
Use VitaShell to transfer the files by USB or FTP, or use SD2Vita to transfer the files directly to the microSD card.
Folders containing game files can be copied anywhere on the SD card.
ScummVM on the PS Vita supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Default control map
*********************************
These controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortcuts.
.. |square| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="5 2 16 16" width="20" height="20"><path fill-rule="evenodd" d="M6 7.75C6 6.784 6.784 6 7.75 6h8.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0116.25 18h-8.5A1.75 1.75 0 016 16.25v-8.5zm1.75-.25a.25.25 0 00-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 00.25-.25v-8.5a.25.25 0 00-.25-.25h-8.5z"></path></svg>
.. |circle| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.404 3.404a6.5 6.5 0 109.192 9.192 6.5 6.5 0 00-9.192-9.192zm-1.06 10.253A8 8 0 1113.656 2.343 8 8 0 012.343 13.657z"></path></svg>
.. |x| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><path fill-rule="evenodd" d="M3.72 3.72a.75.75 0 011.06 0L8 6.94l3.22-3.22a.75.75 0 111.06 1.06L9.06 8l3.22 3.22a.75.75 0 11-1.06 1.06L8 9.06l-3.22 3.22a.75.75 0 01-1.06-1.06L6.94 8 3.72 4.78a.75.75 0 010-1.06z"></path></svg>
.. |triangle| raw:: html
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24"><path d="M11.574 3.712c.195-.323.662-.323.857 0l9.37 15.545c.2.333-.039.757-.429.757l-18.668-.006c-.385 0-.629-.422-.428-.758l9.298-15.538zm.429-2.483c-.76 0-1.521.37-1.966 1.111l-9.707 16.18c-.915 1.523.182 3.472 1.965 3.472h19.416c1.783 0 2.879-1.949 1.965-3.472l-9.707-16.18c-.446-.741-1.205-1.111-1.966-1.111z"/></svg>
.. csv-table::
:widths: 50 50
:header-rows: 2
:class: controls
Game Controller Mapping,
Button,Action
Left stick,Mouse
Left stick + R button,Slow Mouse
|x|,Left mouse click
|circle|,Right mouse click
Directional buttons,Keypad 'Cursor' Keys
Directional buttons + R button,Diagonal Keypad 'Cursor' Keys
L button,Game menu (F5)
R button,Shift
|square|,Period (.)
R button + |square|,Spacebar
|triangle|,Escape
R button + |triangle|,Return
START,Global main menu (GMM)
SELECT,Toggle virtual keyboard
SELECT + R button,AGI predictive input dialog
.. csv-table::
:header-rows: 2
"Front Touchscreen Controls, always enabled",
Touch,Action
One finger tap,Moves pointer to finger position and left mouse click
Two finger tap,Moves pointer to first finger position and right mouse click
Single finger drag,Moves pointer directly with finger
`Two finger drag`_ ,Moves pointer while left mouse button is held down (drag-and-drop).
`Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
.. csv-table::
:widths: 50 50
:header-rows: 2
"Back Touchpad Controls, enabled through settings",
Touch,Action
One finger tap,Left mouse button click
Two finger tap,Right mouse button click
Single finger drag,"Moves pointer indirectly with finger, pointer speed can be adjusted in control settings"
`Two finger drag`_,Moves pointer while left mouse button is held down (drag-and-drop).
`Three finger drag`_ ,Moves pointer while right mouse button is held down (drag-and-drop).
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 and mice pair successfully with the Vita. The ScummVM team tested the Jelly Bean BT keyboard and mouse combo (ASIN:B06Y56BBYP) and 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 Vita will not recognize them as a single finger, otherwise the pointer will jump around.
Touchpad mouse mode
^^^^^^^^^^^^^^^^^^^^^^^
The touch control scheme can be switched in the global settings. Go to **Options > Control**:
- When **Touchpad mouse mode** is off:
- The touch controls are direct, which means the pointer always jumps to the finger position.
- The rear touch pad 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:`Control tab <../settings/control>` affects how far the pointer moves in response to a finger movement.
- The rear touch pad is enabled.
The front touchscreen uses the direct mode by default, but this can be changed by editing the :doc:`configuration file <../advanced_topics/configuration_file>` with the following keyword:
.. _frontpanel:
*frontpanel_touchpad_mode*
When set to true, the touch controls on the front touchscreen are indirect.
Two finger tap
^^^^^^^^^^^^^^^^^^^^
For a two finger tap, hold one finger down and then tap with a second finger.
Two finger drag
^^^^^^^^^^^^^^^^^^^
Hold down two fingers to initiate a drag-and-drop feature. The two finger drag simulates the left mouse button 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.
Three finger drag
^^^^^^^^^^^^^^^^^^^^
Hold down the three fingers to initiate a drag-and-drop feature. The three finger drag simulates the right mouse button 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.
- ScummVM crashes when using the PS button or when suspending the console. Install the `FdFix plugin <https://github.com/TheOfficialFloW/FdFix>`_ to fix this.

69
doc/docportal/other_platforms/risc_os.rst Normal file
View File

@@ -0,0 +1,69 @@
=============================
RISC OS
=============================
This page contains all the information you need to get ScummVM up and running on the RISC OS operating system.
What you'll need
===================
- A system running RISC OS 3.6 or later.
- A minimum of 64 MB RAM. 32 MB may work in some circumstances, but is not generally recommended.
- The `SharedUnixLibrary <https://www.riscos.info/index.php/SharedUnixLibrary>`_ and `DRenderer <https://www.riscos.info/packages/LibraryDetails.html#DRendererarm>`_ modules installed. These can be installed using `PackMan <https://www.riscos.info/index.php/PackMan>`_.
- Support for long file names. On older versions of RISC OS, this can be provided using `raFS <http://atterer.org/riscos>`_.
Installing ScummVM
======================================
Download the RISC OS package from the `ScummVM Downloads page <https://www.scummvm.org/downloads/>`_.
Use a tool such as SparkFS to extract the archive. It is important that the archive is not extracted on any other system, because this results in a loss of file type information. ScummVM requires the file type information to run properly.
Transferring game files
=======================
Copy data files directly from the original discs on machines that have CD and/or floppy drives, or use a USB drive to transfer the files from another system.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Controls can be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`. See the :doc:`../use_scummvm/keyboard_shortcuts` page for common default keyboard shortcuts.
Paths
=======
Saved games
*******************
``<Choices$Write>.ScummVM.Saves``
The save path needs to be in a path that supports long file names, so it may be necessary to change the default location to one that does.
Configuration file
**************************
``<Choices$Write>.ScummVM.scummvmrc``
The ``<Choices$Write>`` environment variable is usually ``$.!Boot.Choices``.
Settings
==========
For more information about settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
.. _reporter:
There is one additional configuration option, *enable_reporter*. When set to true in :doc:`../advanced_topics/configuration_file`, log messages are sent to the `!Reporter <http://www.avisoft.force9.co.uk/Reporter.htm>`_ application. This is useful mostly for developers.
Known issues
==============
- ScummVM for RISC OS does not have cloud or LAN functionality.

149
doc/docportal/other_platforms/sega_dreamcast.rst Normal file
View File

@@ -0,0 +1,149 @@
=============================
Sega Dreamcast
=============================
This page contains all the information you need to get ScummVM up and running on a Sega Dreamcast.
What you'll need
=================
- A CD-R disc (80min/700mb).
- A CD-RW drive.
- A computer running Windows.
- Software to create a bootable disc image, such as `BootDreams <https://dcemulation.org/index.php?title=BootDreams>`_
- CD burning software such as Nero Burning ROM, ImgBurn or Alcohol120%.
Running ScummVM
==================================
There are two ways to get ScummVM running on the Dreamcast:
1. Download the ready-to-go Nero Image and Demos package and burn the extracted ``.nrg`` image to a CD-R using Nero Burning ROM.
2. Download the Dreamcast plain files package and use the extracted files to create a custom disc image to burn to a CD-R.
Both packages are available from the ScummVM `Downloads page <https://www.scummvm.org/downloads/>`_
Creating a disc from the Dreamcast Nero Image and Demos package
********************************************************************
Use Nero Burning ROM to burn the ``.nrg`` file contained in the package to a CD-R disc.
Creating a disc from the Dreamcast plain files package
********************************************************
Create a directory on your computer. In this example, the directory is called ``ScummVMDC``.
Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ``ScummVMDC`` directory. These are the main boot and engine files required for ScummVM to run.
The ``.PLG`` files in the plain files package are the plugins that are required to run the games. For the best performance, only include the plugins for games you want to play. For example, if you want to play LucasArts games, include ``SCUMM.PLG``.
In the plain files package there are also ``.DAT`` files. These files might be listed as required Datafiles on the `Datafiles wiki page <https://wiki.scummvm.org/index.php/Datafiles>`_.
Copy the required ``.PLG`` and ``.DAT`` files into the root of the ``ScummVMDC`` directory.
Next, make a new directory for each game. In this example, all the required Day of the Tentacle data files have been copied into a subdirectory named ``DOTT``.
Our file structure now looks like this:
::
ScummVMDC
|--DOTT
| |-- MONSTER.SOU
| |-- TENTACLE.000
| `-- TENTACLE.001
|--IP.BIN
|-- SCUMM.PLG
`-- SCUMMVM.BIN
The next step is to create a bootable disc image from the ``ScummVMDC`` folder.
Use Bootdreams to create either a Discjuggler, Nero or Alcohol120% disc image.
.. figure:: ../images/dreamcast/bootdreams.png
1. Choose the preferred disc image type by clicking on the corresponding icon at the top of the window.
2. Choose the ``ScummVMDC`` folder as the **Selfboot folder**
3. Enter a title for the disc image in the **CD label** field.
4. Leave the **Disc format** as **Audio/Data**
5. Click **Process** to create the disc image.
To burn the resulting image to disc, use any software capable of using those image formats, such as Nero Burning ROM for NRG, Alcohol120% for MDS, and Padus DiscJuggler or ImgBurn for CDI disc images.
.. tip::
The image created from the plain files package can also be used with Optical Disc Emulators and similar external hardware.
.. caution::
Use the lowest possible burning speed for best results; the Dreamcast is an older system and as such can have problems reading discs burned at high speeds. If available, the 4x speed is ideal. Ensure that you use good quality discs from a reputable manufacturer. If possible, use archival grade discs.
Transferring game files
========================
Game files can be included on the same CD as the ScummVM binary file, or on a separate disc.
The Dreamcast port does not use the normal ScummVM Launcher. It uses its own custom graphical user interface, which automatically scans the disc for games, and adds the games to a games list through ScummVM's built-in autodetection.
ScummVM for the Dreamcast supports disc swapping from the GUI. It rescans after a new disc is inserted and repopulates the games list.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
=================
Default control map
*********************
.. csv-table::
:header-rows: 2
:class: controls
Game Controller Mapping:,,
Button,Action
Joystick,Moves pointer
Directional pad,"Moves pointer slowly. Also controls the on-screen keyboard"
Ⓐ,Left Click
Ⓑ,Right Click
Ⓨ,"Pause"
START,"Load and save"
Trigger L,Toggles the virtual keyboard on/off
Ⓧ,"5 - used for boxing in Indiana Jones and the Last Crusade"
Ⓧ + Directional pad,"1, 2, 3, 4, 6, 7, 8, 9 - used for boxing in Indiana Jones and the Last Crusade"
The mouse cursor is controlled with the standard Dreamcast controller. The Dreamcast mouse and keyboard peripherals are also supported.
Paths
=======
Saved games
*****************
The Visual Memory Unit (VMU) is used to save and load games.
Autosave is enabled on the Dreamcast, so each game will use some memory blocks (between 2 and 13) for the autosave in save slot 0.
When a game is saved, the VMU beeps, and a prompt is displayed on the screen to let you know that the game has been saved.
Games are saved and loaded through the built-in game menus.
Configuration file
*********************
ScummVM for the Dreamcast does not use a configuration file.
Settings
==========
There is no way to change ScummVM settings on the Dreamcast.
Known issues
==============
- The Dreamcast has no external storage medium, and only has 16MB of RAM. As such, the Dreamcast port of ScummVM currently does not support SCUMM v7/v8 games (The Dig, Full Throttle and The Curse of Monkey Island), and any other "big" game may not run at all.
- There is currently no way to manually add games to the games list. The autodetect feature usually works well, but sometimes games will show up on the list twice, incorrect games will show up with the correct game, and, quite rarely, the game will not show up on the list at all.
- Some games, for example SPY Fox 1: Dry Cereal, use filenames which are incompatible with the ISO 9660 filesystem standard. The Dreamcast port does not support filename extensions like RockRidge or Joliet, so the CD mastering software needs to be instructed not to change the filenames to comply to ISO 9660, or the engine will not be able to open the files.

106
doc/docportal/other_platforms/tvos.rst Normal file
View File

@@ -0,0 +1,106 @@
==============
Apple TV OS
==============
.. note::
This page is under development. Only basic information is given to enable ScummVM on Apple TV.
This page contains all the information you need to get ScummVM up and running on an Apple TV.
Installing ScummVM
=====================
There are two ways to install ScummVM on an Apple TV depending on if building the project or downloading a bundle.
Building the project
************************************
Since the port for Apple TV shares the same code base as the iOS port the instructions for building the project is the same as for iOS. Follow the :doc:`./ios_build` with the difference that the ``ScummVM-tvOS`` target should be chosen in Xcode.
Downloading and installing ScummVM
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Instructions will be added when packages are available for download.
Transferring game files
========================
.. note::
Note that Apple TV applications doesn't have a ``Documents`` folder in which games can be stored. All games are stored in the ``cache`` folder which can be deleted when the system requires the needed space. This could happen if having limited available space and streaming high definition content or installing other applications. Please see https://developer.apple.com/library/archive/documentation/General/Conceptual/AppleTV_PG/OnDemandResources.html for more information.
Make sure to make backups of savegames.
ScummVM has built-in cloud functionality, which lets you connect your Google Drive, OneDrive, Box or Dropbox account. For more information, see the :doc:`../use_scummvm/connect_cloud` page. ScummVM also has the ability to run a local web server. For more information, see the :doc:`../use_scummvm/LAN` page.
.. note::
ScummVM's cloud functionality does not currently support iCloud, however you can 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.
See :doc:`../use_scummvm/game_files` for more information about game file requirements.
Controls
============
The Apple TV supports several controllers however no mouse support. External keyboards can be used to help entering text input. Usually the Apple TV remote controller will be used.
Game controllers
********************
If running tvOS 14 and later there is support for connected gamepad controllers using the Apple Game Controller framework. "Micro Gamepad Controllers ""Extended Gamepad Controllers" are supported at the moment. For more information visit
https://developer.apple.com/documentation/gamecontroller/gcmicrogamepad
https://developer.apple.com/documentation/gamecontroller/gcextendedgamepad
Key mappings on Apple TV remote (also remote app on iOS)
************************************************************
.. csv-table::
:widths: 40 60
:header-rows: 1
:class: controls
Button, Action
Swipe on Touch area, Controls pointer
Press Touch area, Left mouse click
Play/Pause, Right mouse click
Back/Menu in game, Global Main menu
Back/Menu in launcher, Apple TV Home
Hold Play/Pause, Show keyboard with extra keys
Touch (not press) on top of Touch area, Up arrow key
Touch (not press) on left of Touch area, Left arrow key
Touch (not press) on right of Touch area, Right arrow key
Touch (not press) on bottom of Touch area, Down arrow key
Key mappings on Extended gamepad controller
***********************************************
.. csv-table::
:widths: 40 60
:header-rows: 1
:class: controls
Button, Action
Left analog joystick, Controls pointer
D-Pad, Up/Left/Right/Down arrow buttons
A, Left mouse click
B, Right mouse click
Hold X, Show keyboard with extra keys
Menu in game, Global Main menu
Menu in launcher, Apple TV Home
L1, show game original menu
Paths
=======
Saved games
**************
``Savegames/`` in the cache root folder. Access this folder through :doc:`../use_scummvm/LAN`.
Configuration file
*********************
``Preferences`` in the cache folder. Access this folder through :doc:`../use_scummvm/LAN`.