ScummVM/scummvm
1
0
Fork 0
mirror of https://github.com/scummvm/scummvm.git synced 2026-06-20 05:45:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: final drafts all pages

Browse Source
This commit is contained in:
cadihowley
2020-11-30 17:41:26 -05:00
committed by Matan Bareket
parent 6d553eb5f9
commit 2b9bcd6d7a
30 changed files with 313 additions and 303 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/docportal/advanced_topics/command_line.rst
+1 -1
View File
@@ -3,7 +3,7 @@
Command line interface
=======================
Launching ScummVM from the command line allows you to pass a number of options, some of which override the applicable global or game-specific settings. It also allows you to launch straight into a game without going to the Launcher first.
Launching ScummVM from the command line lets you pass a number of options, some of which override the applicable global or game-specific settings. It also lets you launch straight into a game without going to the Launcher first.
Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without starting the Launcher or starting a game.
doc/docportal/advanced_topics/configuration_file.rst
+1 -1
View File
@@ -77,7 +77,7 @@ The configuration file saves to different default locations, depending on the pl
.. panels::
:column: col-lg-12 mb-2
We follow the XDG Base Directory Specification, so by default the configuration file is found at ``/~.config/scummvm/scummvm.ini``, but its location may vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
We follow the XDG Base Directory Specification, so by default the configuration file is found at ``/~.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
If ScummVM was installed using Snap, the configuration file can be found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``
doc/docportal/advanced_topics/understand_audio.rst
+16 -16
View File
@@ -12,7 +12,7 @@ The **Preferred device** in the global settings Audio tab, or the **Music device
If **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses either an MT-32 or General MIDI device automatically, the settings on the MT-32 or MIDI tabs also apply, and the devices selected on these tabs are the ones that will be used. If **Preferred device** or **Music device** is set to either an MT-32 device or a GM device, ScummVM will use that device and ignore the devices chosen on the MT-32 and MIDI tabs.
Many of the settings are highly dependent on the soundtrack(s) of the game you are playing; some offer only MIDI, while others have MP3 soundtracks, and so on.
Not all settings are applicable to all games. For example, changing the General MIDI settings will not have any effect on a game that only has CD audio.
The evolution of PC audio
@@ -59,7 +59,7 @@ To find out which emulation is compatible with the game you're playing, have a l
What is MIDI?
======================
MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them via the MIDI protocol.
MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them by the MIDI protocol.
While some older soundcards (and a few modern ones) have their own hardware-based synthesizers, this is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
@@ -79,9 +79,9 @@ General MIDI device emulation (FluidSynth)
If the ScummVM you're using has libfluidsynth support it will be able to play MIDI music by using the FluidSynth emulator if set as the **Preferred device** or **Music device**, or if specified in the MIDI tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses General MIDI output automatically.
You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from in order to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
Since the default output volume from FluidSynth can be fairly low, ScummVM will automatically set the gain to get a stronger signal. This can be further adjusted using the :ref:`MIDI gain <gain>` setting.
The default output volume from FluidSynth can be fairly low, so ScummVM automatically sets the gain to get a stronger signal. Use the :ref:`MIDI gain <gain>` setting to further adjust this.
The processor requirements for FluidSynth are quite high; a fast CPU is recommended.
@@ -109,14 +109,14 @@ You don't need to enable **True Roland MT-32** in the MT-32 tab, ScummVM does th
.. tip::
Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest exploits some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest uses some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
`This Wikipedia article <https://en.wikipedia.org/wiki/List_of_MT-32-compatible_computer_games>`_ provides a comprehensive list of MT-32 compatible games, including which games work best with which device.
The processor requirements for the MT-32 emulator are quite high; a fast CPU is strongly recommended.
Native MIDI support
Built-in MIDI support
--------------------------
All MIDI ports show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
@@ -125,7 +125,7 @@ All MIDI ports show up in the **Preferred device** or **Music device** dropdown
- Enable **Roland GS device** to tell ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
- If no options are selected, ScummVM treats the device on the port as a General MIDI device.
If you select an option that does not match the actual device, this may have unintended consequences. For example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this may work fine for some games, it really depends on how the game has made use of the MT-32.
If you select an option that does not match the actual device, this might have unintended consequences. For example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this might work fine for some games, it really depends on how the game has made use of the MT-32.
@@ -146,11 +146,11 @@ For an in-depth look at audio and MIDI device setup on a Windows computer, see t
Linux
******
MIDI device setup may vary depending on your Linux distro.
MIDI device setup might vary depending on your Linux distro.
If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity may have some lag, depending on the system.
If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity might have some lag, depending on the system.
Here are a couple of helpful articles from the Ubuntu community documentation to get you started. These instructions should work for any Debian-based distro.
Here are a couple of helpful articles from the Ubuntu community documentation to get you started.
`How to: Software Synthesizers <https://help.ubuntu.com/community/Midi/SoftwareSynthesisHowTo>`_
@@ -163,7 +163,7 @@ Here are a couple of helpful articles from the Ubuntu community documentation to
What is AdLib?
================
AdLib devices do not use MIDI. They instead have a chip that produces sound via FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
AdLib devices do not use MIDI. They instead have a chip that produces sound through FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
- The original AdLib and SoundBlaster card had one OPL2 chip.
- The SoundBlaster Pro 1 had two OPL2 chips
@@ -171,13 +171,13 @@ AdLib devices do not use MIDI. They instead have a chip that produces sound via
The AdLib emulator setting offers MAME, DOSBox and Nuked emulation, with MAME being the least accurate and using the least CPU power, and Nuked being the most accurate and also using the most CPU power - DOSBox is somewhere in between.
There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected via the parallel port of a computer.
There is also the option to select the OPL2LPT and OPL3LPT devices, which are external hardware devices with a real OPL chip, connected through the parallel port of a computer.
AdLib does not require a SoundFont or ROMs, so for many games it may be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
AdLib does not require a SoundFont or ROMs, so for many games it might be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
Mixed AdLib/MIDI mode
------------------------
Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack may provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack might provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
.. note::
@@ -201,7 +201,7 @@ For games that use CD audio, the sounds were probably sampled at 44100Hz, so tha
ScummVM generates the samples when using AdLib, FM-Towns, PC Speaker or IBM PCjr emulated sound. 22050Hz will usually be fine for these options, although for Beneath a Steel Sky 44100Hz is recommended.
ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number may not be supported by your sound card.
ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number might not be supported by your sound card.
.. _buffer:
@@ -212,6 +212,6 @@ There is no option to control audio buffer size through the GUI, but the default
Appropriate values are normally between 512 and 8192, but the value must be one of: 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768.
Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes may lead to minor audio delays (high latency).
Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes might lead to minor audio delays (high latency).
doc/docportal/advanced_topics/understand_graphics.rst
+2 -2
View File
@@ -110,7 +110,7 @@ Stretch modes
There are five stretch modes:
- Center: centers the image in the window.
- Pixel-perfect scaling: scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x and so on), and fills the remaining empty space with black borders.
- Pixel-perfect scaling: scales the image to a multiple of the original game resolution as much as possible (for example, 2x, 3x, 4x), and fills the remaining empty space with black borders.
- Fit to window: fits the image to the window, but maintains the aspect ratio and does not stretch it to fill the window.
- Stretch: stretches the image to fill the window
- Fit to window (4:3): fits the image to the window, at a forced 4:3 aspect ratio.
@@ -120,7 +120,7 @@ To switch between stretch modes, press :kbd:`Ctrl+Alt+s`.
Render mode
-------------
For most games this setting will have no effect. For some of the older games that could be played on different systems and graphics cards, this control allows us to decide which system we want ScummVM to reproduce.
For most games this setting will have no effect. For some of the older games that could be played on different systems and graphics cards, this control lets you decide which system you want ScummVM to reproduce.
Below are some of the common render modes, to illustrate how the render mode setting works.
doc/docportal/consoles/nintendo_3ds.rst
+21 -9
View File
@@ -8,7 +8,7 @@ Install ScummVM
Prerequisites
****************
- A Nintendo 3DS with a Homebrew Launcher or custom firmware. Enabling homebrew is outside the scope of this documentation.
- A Nintendo 3DS with a Homebrew Launcher or custom firmware. How to enable homebrew is outside the scope of this documentation.
Download and install ScummVM
*********************************
@@ -28,14 +28,14 @@ CIA
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, since without this you will not have proper audio support. Documenting this process is outside the scope of this documentation.
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.
Transfer 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`.
ScummVM for the Nintendo 3DS also has cloud functionality. See :doc:`../use_scummvm/connect_cloud`.
See :doc:`../use_scummvm/add_play_games` for more information about how to add games to ScummVM.
@@ -46,9 +46,7 @@ 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.
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
@@ -73,11 +71,12 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Hover mode
************
When using the touchscreen, you are simulating 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.
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
**************
Every time you touch and release the touchscreen, you are simulating the click and release of the mouse buttons. At the moment, this is only a left mouse button click.
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
****************
@@ -114,6 +113,9 @@ Settings
For more information about Settings, see the Settings section of the documentation. Only platform-specific differences are listed here.
3DS config menu
****************
.. figure:: ../images/3ds/config.png
The 3DS config menu.
@@ -125,7 +127,7 @@ 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. Enabling this options means that if you're within a few pixels of the edge, the cursor will snap to the edge.
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.
@@ -133,6 +135,16 @@ Use Screen:
C-Pad Sensitivity
Sets the sensitivity of the Circle Pad.
Audio
******
Supported audio file formats:
- MP3
- OGG
- OGG
- Uncompressed audio
Known issues
==============
doc/docportal/consoles/nintendo_switch.rst
+17 -32
View File
@@ -9,14 +9,13 @@ 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 <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
Download and install ScummVM
*******************************
The Nintendo Switch package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
The Nintendo Switch package is available for download on the ScummVM `Downloads page <https://www.scummvm.org/downloads>`_.
Download the ``.zip`` archive to a computer, and extract the files.
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.
@@ -26,19 +25,17 @@ Transfer 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>`.
ScummVM on the Nintendo switch supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
For more information on how to add and play games, see the :doc:`../use_scummvm/add_play_games` page.
Controls
=================
Default control mapping
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.
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
@@ -87,47 +84,38 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
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.
`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 <https://docs.google.com/spreadsheets/d/1Drbo5-QuSX901MwtOytSMuqRGxeIkq2HELM806I9dj0/edit#gid=0>`_.
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 will not erroneously recognize them as a single finger, otherwise the pointer will jump around.
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. Go to **Options > Control > Touchpad mouse mode**.
- When touchpad mouse mode is off (default), the touch controls are direct. The pointer always jumps to the finger.
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
^^^^^^^^^^^^^^^^^^^
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.
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.
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.
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
=======
@@ -157,9 +145,9 @@ Supported devices:
Supported audio file formats:
- ``.mp3``
- ``.ogg``
- ``.flac``
- MP3
- OGG
- FLAC
- Uncompressed audio
Controls
@@ -167,6 +155,3 @@ Controls
See the `Touch support`_ section.
Known issues
==============
doc/docportal/consoles/playstation_3.rst
+12 -9
View File
@@ -27,19 +27,17 @@ Transfer 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>`.
To copy game files to the hard drive, use the USB drive, or use ScummVM's :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
See :doc:`../use_scummvm/add_play_games` for more information.
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.
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 mapping
Default control map
*************************
.. |square| raw:: html
@@ -81,18 +79,23 @@ Paths
Saved games
*******************
``/hdd0/game/SCUM12000/saves``
```/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:
Known issues
==============
- MP3
- OGG
- FLAC
- Uncompressed audio
doc/docportal/consoles/playstation_portable.rst
+29 -24
View File
@@ -9,17 +9,16 @@ 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 <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
- A computer to download an extract the install files.
Download and install ScummVM
*******************************
The PSP package is available for download ScummVM's `Downloads page <https://www.scummvm.org/downloads>`_.
The PSP package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
Download the zip file to a computer, and extract the files.
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. Ensure the **USB Device** option is set to **Memory Stick**. 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.
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.
@@ -35,12 +34,10 @@ For more information, see :doc:`../use_scummvm/add_play_games`.
Controls
=================
Default control mapping
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.
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
@@ -76,9 +73,9 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
|circle|,Right Mouse Button
|square|,Period
|square| + R button,Spacebar
SELECT,Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with Directional buttons).
SELECT + R button ,Show Image Viewer
START,Global main menu
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
.. csv-table::
@@ -86,11 +83,11 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Virtual Keyboard Mode,
START,Enter. Also exits virtual keyboard mode
SELECT,Exit the 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,"Select square of characters (up, down, left or right)"
|triangle| |x| |circle| |square| and L/R buttons,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 L/R buttons.
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)
.. csv-table::
@@ -98,18 +95,18 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Image Viewer,
Left/right directional buttons,Previous/next image
Up/down directional buttons ,Zoom in/out
Analog stick,Move around the image
"L/R buttons + START",Exit image viewer
Up/down directional buttons ,Zooms in/out
Analog stick,Moves around the image
"L/R buttons + START",Exits image viewer
.. csv-table::
:header-rows: 1
1st Person Game Mode ,
|square| + R button + L button,Enable 1st Person Mode
|square| + R button + L button,Enables 1st Person Mode
|square|,Modifier key (instead of R button)
L/R button,Strafe left/right
Directional buttons left/right,Turn left/right
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
@@ -121,7 +118,14 @@ For more information, see the Settings section of the documentation. Only platfo
Audio
*******
Games will generally run faster if audio files are in the ``.mp3`` file format.
Supported audio file formats:
- MP3
- OGG
- Uncompressed audio
Games run faster if audio files are in the ``.mp3`` file format.
Paths
@@ -130,7 +134,7 @@ Paths
Saved games
************
``ms0://scummvm_savegames/``
``ms0:/scummvm_savegames/``
Configuration file
********************
@@ -140,4 +144,5 @@ Configuration file
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.
- 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.
doc/docportal/consoles/ps_vita.rst
+34 -45
View File
@@ -9,12 +9,11 @@ Prerequisites
*******************
- 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.
- At least one ScummVM supported game. See the `compatibility page <https://www.scummvm.org/compatibility/>`_ on our website for a list of compatible games.
Download and install ScummVM
******************************
The PS Vita package is available for download on our website's `Downloads page <https://www.scummvm.org/downloads>`_.
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.
@@ -24,18 +23,11 @@ Transfer game files
There are a few ways to transfer game files to the PS Vita.
Using VitaShell:
- Transfer over FTP
- Transfer via USB
Use VitaShell to transfer the files by USB or FTP, or use SD2Vita to transfer the files directly to the microSD card.
If you're using SD2Vita:
- Transfer the files directly to the microSD card.
Folders containing game files can be copied anywhere on the SD card.
Folders containing game files can be copied into any folder.
ScummVM on the PS Vita supports :doc:`Cloud functionality <../use_scummvm/connect_cloud>`.
ScummVM on the PS Vita supports :doc:`cloud functionality <../use_scummvm/connect_cloud>`.
For more information on how to add and play games, see the :doc:`../use_scummvm/add_play_games` page.
@@ -43,12 +35,10 @@ For more information on how to add and play games, see the :doc:`../use_scummvm/
Controls
=================
Default control mapping
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.
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
@@ -75,8 +65,8 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
Button,Action
Left stick,Mouse
Left stick + R button,Slow Mouse
|x|,Left mouse button
|circle|,Right mouse button
|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)
@@ -94,23 +84,23 @@ See the :doc:`../use_scummvm/keyboard_shortcuts` page for common keyboard shortc
"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.
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 via settings",
"Back Touchpad Controls, enabled through 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.
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
****************************
@@ -119,9 +109,7 @@ Real bluetooth mice and keyboards work on the Vita and are supported by ScummVM.
.. 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).
Not all bluetooth keyboards or mice pair successfully with the Vita. The ScummVM team tested the Jelly Bean BT keyboard and mouse combo (ASIN:B06Y56BBYP) and with the standalone Jelly Comb Bluetooth Wireless Mouse (ASIN:B075HBDWCF).
Touch support
****************
@@ -150,25 +138,26 @@ The front touchscreen uses the direct mode by default, but this can be changed b
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
^^^^^^^^^^^^^^^^^^^
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.
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.
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.
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
============================
@@ -191,9 +180,9 @@ Audio
Supported audio file formats:
- ``.mp3``
- ``.ogg``
- ``.flac``
- MP3
- OGG
- FLAC
- Uncompressed audio
Controls
@@ -204,4 +193,4 @@ See the `Touch support`_ section.
Known Issues
===============
MT-32 emulation is not available on the PS Vita.
- MT-32 emulation is not available on the PS Vita.
doc/docportal/consoles/sega_dreamcast.rst
+21 -19
View File
@@ -35,11 +35,11 @@ Copy the downloaded ``SCUMMVM.BIN`` and ``IP.BIN`` files into the ``ScummVMDC``
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 may be listed as required Datafiles on the `Datafiles wiki page <https://wiki.scummvm.org/index.php/Datafiles>`_.
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.
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, we will add all the required Day of the Tentacle data files into a subdirectory named ``DOTT``.
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:
@@ -56,18 +56,18 @@ Our file structure now looks like this:
The next step is to create a bootable disc image from the ``ScummVMDC`` folder.
Use Bootdreams to create either a ``.dci``, ``.nrg`` or ``.mds``/``.mdf`` disc image.
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 foler**
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``.
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::
@@ -76,26 +76,26 @@ To burn the resulting image to disc, use any software capable of using those ima
.. 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.
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.
Transfer game files
=======================
Game files can be included on the same CD as the ScummVM binary file, or on a separate disc
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 will rescan once a new disc is inserted and repopulate the games list.
ScummVM for the Dreamcast supports disc swapping from the GUI. It rescans after a new disc is inserted and repopulates the games list.
Controls
=================
The mouse cursor can be controlled with the standard Dreamcast controller.
There is a virtual keyboard that can be brought up by pressing the left trigger button, that will emulate keyboard input.
The Dreamcast mouse and keyboard peripherals are also supported.
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.
.. csv-table::
:header-rows: 2
@@ -103,28 +103,30 @@ The Dreamcast mouse and keyboard peripherals are also supported.
Game Controller Mapping:,,
Button,Action,Notes
Joystick,Moves pointer,
Directional pad,Moves pointer slowly,Also controls the on-screen keyboard
Directional pad,Moves pointer slowly, Also controls the on-screen keyboard
Ⓐ,Left Click,
Ⓑ,Right Click,
Ⓨ,Spacebar,Pause
Start,F5,Load and save
Trigger L,Toggles the on-screen keyboard on/off,
Trigger L,Toggles the virtual keyboard on/off,
Ⓧ,5,For boxing in Indiana Jones and the Last Crusade
Ⓧ + Directional pad,"1, 2, 3, 4, 6, 7, 8, 9",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 for saving and loading 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 letting you know that the game has been saved.
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 native in-game menus.
Games are saved and loaded through the built-in game menus.
Configuration file
*********************
doc/docportal/get_started/android.rst
+19 -28
View File
@@ -26,32 +26,32 @@ Go to the Google Play Store to download and install ScummVM.
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 should suggest the correct ``.apk`` package, however if it does not, scroll down to select the correct 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. An internet search using the device model number should allow you to find these details.
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. Once 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 once permission is granted, returns to the install.
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, since it doesn't originate in the Google Play store. To allow unknown apps:
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 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**.
- 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**.
Transfer game files
========================================
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:`../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.
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 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 opens.
- 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.
For more information on which files ScummVM requires, and how to add and play games, see :doc:`../use_scummvm/add_play_games`.
@@ -72,46 +72,37 @@ Controls can also be manually configured in the :doc:`Keymaps tab <../settings/k
Touch screen control, Action
One finger tap, Left mouse click
Two finger tap, Right mouse click
Long hold one finger tap, Middle mouse click
One finger touch & hold, Middle mouse click
Long press system Back button, Opens Global Main Menu
Short press system Back button, "Skip, or Cancel/Quit in the Launcher"
Small keyboard icon (top right), Opens/closes Virtual keyboard
Touch controls
****************
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 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 tap
****************
^^^^^^^^^^^^^^^^^
To do a two finger tap, hold one finger down and then tap with a second finger.
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.
Virtual keyboard
*******************
^^^^^^^^^^^^^^^^^^^^^
To open the virtual keyboard, tap on the small keyboard icon at the top right of the screen, or tap on any editable text field. To hide the virtual keyboard, tap the small keyboard icon again, or tap outside the text field.
To display or hide the small keyboard icon, from the Launcher select **Options** and then the **Control** tab. Tick the **Show on-screen control** box to enable the keyboard icon.
Touchscreen modes
*******************
The touchscreen operates in two modes: Direct mode or Touchpad mode. To toggle between the two, from the Launcher select **Options** and then the **Control** tab. Tick **Touchpad mouse mode** to enable Touchpad mode.
Direct mode
^^^^^^^^^^^^^
The mouse cursor is placed directly under where your finger touches the screen.
Touchpad mode
^^^^^^^^^^^^^^^^
The mouse cursor doesn't stay underneath your finger. The cursor is moved around from its current position by the direction of your finger movement, just like a touchpad on a laptop.
Paths
=======
doc/docportal/get_started/ios.rst
+47 -35
View File
@@ -101,12 +101,12 @@ Open the ``scummvm.xcodeproj`` file from the Finder, or from the command line:
Build ScummVM
*****************
Once 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.
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
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** you should see a field labeled **Bundle Identifier**. Input a unique identifier in reverse-DNS format. This can be as simple as com.\ *yournamehere*.
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
@@ -138,7 +138,7 @@ Install ScummVM
Go to the `ScummVM downloads page <https://www.scummvm.org/downloads>`_ and download the recommended ``.deb`` or ``.ipa`` package. When the device asks how to open the file, choose Filza.
Ensure the 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.
Ensure the package is saved somewhere in the ``/var/mobile/`` directory. It defaults to ``/var/mobile/Documents/``, which is fine. Tap on the file and then tap **Install** in the upper right corner to install ScummVM.
Restart your device for the install to complete.
@@ -147,11 +147,11 @@ Transfer 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:`../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.
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 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.
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.
@@ -168,40 +168,52 @@ Controls
: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 tap 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 onscreen keyboard. When an external keyboard is connected, the pinch gesture 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.
Toggles between :ref:`direct` and :ref:`touchpad` ,Swipe two fingers from left to right.
Touch screen control, Action
One finger tap, Left mouse click
:ref:`twofinger`, Right mouse click
:ref:`twofingerdouble`,ESC
Two finger swipe (bottom to top), Toggles `Click and drag mode`_
Two finger swipe (left to right),Toggles between touch direct mode and touchpad mode.
Two finger swipe (top to bottom),Global Main Menu
Three finger swipe, Arrow keys
Pinch gesture, Enables/disables keyboard
Keyboard spacebar, Pause
Touch controls
^^^^^^^^^^^^^^^^^
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, the touch controls are direct. The pointer 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.
.. _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.
Click and drag mode
^^^^^^^^^^^^^^^^^^^^
*********************
Simulates a left mouse click when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
Simulates a left mouse click when you touch the screen. The mouse pointer drags to wherever you slide your finger, and releases where you lift your finger.
If you press down a second finger in this mode, it releases the simulated left mouse button, and presses down the simulated right mouse button. The right mouse button is released when you lift your finger again.
.. _direct:
Direct mode
^^^^^^^^^^^^^
The mouse cursor is placed directly under where your finger touches the screen.
.. _touchpad:
Touchpad mode
^^^^^^^^^^^^^^^^
The mouse cursor doesn't stay underneath your finger. The cursor is moved around from its current position by the direction of your finger movement, just like a touchpad on a laptop.
Keyboard
**********
If no external keyboard is connected, the pinch gesture shows and hides the onscreen keyboard. When an external keyboard is connected, the pinch gesture enables/disables inputs from the external keyboard.
Paths
=======
@@ -209,9 +221,9 @@ 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 via the Finder or iTunes.
``/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 via the Finder or iTunes.
``/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.
doc/docportal/get_started/mac_linux_windows.rst
+13 -15
View File
@@ -3,18 +3,16 @@
Mac, Linux or Windows
========================
All downloads are available from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_.
macOS
-------
macOS/Mac OSX
------------------
Download the recommended Disk Image. Once the download has completed, double click the file to mount the Disk Image. A window will open with the ScummVM icon. Drag this icon into your Applications folder to install ScummVM.
Download the recommended disk image file from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_. After the download has completed, double click the file to mount the disk image file. A window containing the ScummVM icon opens. Drag this icon into your Applications folder to install ScummVM.
To run ScummVM, click on the icon in the Applications folder.
.. note::
macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. Since ScummVM is not available from the App Store, follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
macOS includes technology called Gatekeeper, which checks to ensure only trusted software is run on your Mac. ScummVM is not available from the App Store, so follow the steps on this `Apple support page <https://support.apple.com/en-us/HT202491>`_ to allow ScummVM to run.
Linux
@@ -40,15 +38,15 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
Flathub
**********
Flathub is another way to quickly install apps for Linux by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
Flathub is another way to install apps for Linux, by using Flatpak. Flatpak comes standard with Fedora-based distributions, but can be installed on any Linux operating system. The `Flathub website <https://flatpak.org/setup/>`_ has excellent install instructions.
Once Flatpak is installed, enter the following on the command line to install ScummVM:
When Flatpak is installed, enter the following on the command line to install ScummVM:
.. code:: bash
flatpak install flathub org.scummvm.ScummVM
Some distributions have the option to install Flatpaks via the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
Some distributions have the option to install Flatpaks through the graphical desktop interface. To use this option, navigate to the `ScummVM Flatpak page <https://flathub.org/apps/details/org.scummvm.ScummVM>`_ and click the **INSTALL** button. A dialog opens; choose the **Open with Software Install (default)** option, and then click **OK**.
To run ScummVM, enter the following on the command line:
@@ -69,9 +67,9 @@ ScummVM is found in the software repositories of many Linux distributions.
.. caution::
The repositories may not contain the most up-to-date version of ScummVM.
The repositories might not contain the most up-to-date version of ScummVM.
If you are unsure about how to install software packages from the software repository for your distribution, you may find `this help article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
If you are unsure about how to install software packages from the software repository for your distribution, you might find `this help article <https://www.maketecheasier.com/install-software-in-various-linux-distros/>`_ useful.
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
@@ -79,13 +77,13 @@ To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through
Release binaries
*********************
At this time, binary packages are only released for Debian and Ubuntu. Find and download the ScummVM version that corresponds to your operating system and architecture. To install a ``.deb`` package, either double click on the downloaded ``.deb`` file to use the graphical installer, or, if that's not available, use the command line.
At this time, binary packages are only released for Debian and Ubuntu. On the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, find and download the ScummVM package that corresponds to your operating system and architecture. To install a DEB package, either double click on the downloaded DEB file to use the graphical installer, or, if that's not available, use the command line.
.. code:: bash
sudo apt install /path/to/downloaded/file.deb
Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded ``.deb`` package. The APT software manager will handle the installation.
Replace ``/path/to/downloaded/file.deb`` with the actual path to the downloaded DEB package. The APT software manager handles the installation.
To run ScummVM, enter ``scummvm`` on the command line, or launch ScummVM through the desktop interface by clicking **Menu > Games > ScummVM**.
@@ -98,13 +96,13 @@ There are two ways to install ScummVM onto a computer running Windows; download
Installer
************
Download the Windows installer for your operating system, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
Download the Windows installer for your operating system from the `ScummVM downloads page <https://www.scummvm.org/downloads/>`_, and double click the downloaded file. The installer guides you through the install process, and adds a shortcut to the Start Menu. There is also an option to add a shortcut to the desktop.
To run ScummVM, either navigate to desktop and double click the ScummVM shortcut, or go to **Start > All Apps > ScummVM**. For Windows XP, go to **Start > All Apps > ScummVM**.
Manual
**********
Download the Windows ``.zip`` file for your operating system (32bit or 64bit). To unzip the contents, right-click the folder and select **Extract All**.
Download the Windows zip file for your operating system (32bit or 64bit). To extract the files, right-click the folder and select **Extract All**.
To run ScummVM from the extracted folder, find the ``scummvm.exe`` file and double click it.
doc/docportal/help/contact.rst
+2 -2
View File
@@ -1,10 +1,10 @@
==============
Contact us!
Contact us
==============
There are a few ways to become a part of the ScummVM community:
Chatting on the `Discord Channel <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ | Posting on the `ScummVM Forum <https://forums.scummvm.org/>`_ | Or by `Reporting a Bug <https://bugs.scummvm.org/>`_
Chat with us on the `Discord Channel <https://discord.com/invite/5D8yTtF>`_ or the `IRC Channel <irc://irc.freenode.net/scummvm?key=scummvm>`_ | Post on the `ScummVM Forum <https://forums.scummvm.org/>`_ | Or `Report a Bug <https://bugs.scummvm.org/>`_
We look forward to meeting you!
doc/docportal/help/faq.rst
+20 -18
View File
@@ -14,13 +14,13 @@ About
Is ScummVM an emulator?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see our `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
No. ScummVM replaces the original executable files that shipped with the game. This means that your games can run on many different platforms they were never designed to run on! For an in-depth look at how ScummVM works, see the `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
Is ScummVM free?
^^^^^^^^^^^^^^^^^^^^
ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is freely available for you to do whatever you want with it. If you make modifications and redistribute your work, you must make your source code available.
The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See the `Contributing guide <#>`_ on our wiki.
The ScummVM team would be delighted if you send them your modifications, so that the changes can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page.
How do I install ScummVM onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -28,9 +28,10 @@ See :ref:`firststeps`.
How do I get game files onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The **Other platforms** section provides information about installing ScummVM on various platforms, as well as how to transfer files to your chosen device.
ScummVM now has Cloud and LAN functionality to simplify the file transfer process. For more information, see :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
For general guidance, see the :doc:`../use_scummvm/add_play_games` page. For specific information, find the page for your device on the sidebar.
ScummVM now has cloud and LAN functionality to simplify the file transfer process. For more information, see :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
On what platform(s) will ScummVM run?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -41,13 +42,14 @@ Games
Can I only play LucasArts SCUMM games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there may be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the `Supported games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ page on our wiki for a comprehensive list. There is a caveat; not all supported games are playable on all platforms. Sometimes this is because the game is simply too CPU intensive for the device, or there might be many other reasons. If a game is not available on a platform, you will not be able to add it to ScummVM.
.. _getgames:
Where do I get the games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See `Where to get the games <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ on our wiki.
See the :doc:`../use_scummvm/add_play_games` page.
.. _installgames:
@@ -61,7 +63,7 @@ If you do not have any hard copy games, there are some digital options available
How do I know if I can play my game using ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website.
I have saved games from when I played the original game - can I use these with ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -69,11 +71,11 @@ This is only supported for a select number of games. See the `wiki <https://wiki
How do I launch a game straight from the game folder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Games must be added to and started from :doc:`../use_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`. It is only necessary to add each game once; ScummVM will remember the game and it will be available to start from the Launcher.
Games must be added to and started from :doc:`../use_scummvm/the_launcher`, they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`.
What are the in-game keyboard shortcuts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. Since version 2.2.0 it is also possible to create custom shortcuts on the :doc:`../settings/keymaps` tab.
A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. Since version 2.2.0 you can create custom shortcuts on the :doc:`../settings/keymaps` tab.
Troubleshooting
===================
@@ -98,11 +100,11 @@ Games
Help! My game won't run!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on our website.
1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Platform Overview <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ page on the wiki.
2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/add_play_games` page for more information.
3. Ask on the forums or on Discord whether your game is supported on the platform you're trying to play it on. :doc:`contact`
3. Ask for advice on the ScummVM forums or on DIscord. See the :doc:`contact` page.
4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
@@ -125,7 +127,7 @@ Sometimes it's worth checking the obvious.
1. Are your speakers on? Are your headphones properly connected?
2. Try playing an audio clip from another source to see if you have sound in general.
3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM should fall back on an audio setting that works, but if it doesn't, you may need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM falls back on an audio setting that works, but if for some reason it doesn't, you might need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
Help! There's no sound on my iPhone/iPad!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -133,20 +135,20 @@ ScummVM will not play any sound if your device is in Silent Mode. If this is not
I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The original games shipped with an uncompressed ``MONSTER.SOU`` file - this is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (``.mp3``), ``MONSTER.SOG`` (``.ogg``), or ``MONSTER.SOF`` (``.flac``) format, make sure that the ScummVM you're using has support for those formats.
The original games shipped with an uncompressed ``MONSTER.SOU`` file, which is the voice file. If you have compressed this file to either a ``MONSTER.SO3`` (MP3 file), ``MONSTER.SOG`` (OGG file), or ``MONSTER.SOF`` (FLAC file) format, make sure that the ScummVM you're using has support for those formats.
The audio is really glitchy. What can I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There may be a few things at play here.
There might be a few things at play here.
- Try to increase the :ref:`audio buffer size <buffer>` in the :doc:`configuration file <../advanced_topics/configuration_file>`.
- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU may not have the processing power to keep up. In this case, you may have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU may not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
- Try to increase the :ref:`audio buffer size <buffer>` in the configuration file.
- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU might not have the processing power to keep up. In this case, you might have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, as long as your platform supports it.
- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU might not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
- If you are using the :ref:`adlib` emulator, try selecting the least CPU-intensive option; MAME.
I have a CD version of a game, how do I get the sound to work without running the game from the CD?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See using :ref:`cdaudio`.
See :ref:`cdaudio`.
Graphics
***********
doc/docportal/help/report_bugs.rst
+1 -1
View File
@@ -26,7 +26,7 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
.. panels::
:column: col-lg-12 mb-2
We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location may vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location might vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
.. tabbed:: Windows
doc/docportal/other_platforms/amigaos_4.rst
+2 -2
View File
@@ -31,7 +31,7 @@ Transfer game files
See :doc:`../use_scummvm/add_play_games` for more information.
For games on PC or Mac formatted discs, use the native 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 may be able to use this to access the 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 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`.
@@ -67,6 +67,6 @@ The CAMD driver allows the use of MIDI hardware. Select CAMD as the :ref:`Prefer
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.
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>`.
doc/docportal/other_platforms/atari.rst
+18 -9
View File
@@ -9,17 +9,19 @@ Prerequisites
****************
- A powerful Atari system or clone; minimum CPU 68060.
- FreeMiNT, TOS or MagiC.
- FreeMiNT, TOS or MagiC operating system.
Download and install ScummVM
*********************************
A binary package is provided for the m68000 CPU, one for the m68020 to m68060 range of CPUs, and one for 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.
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.
@@ -32,9 +34,7 @@ Transfer files to the Atari as you normally would, such as through a network con
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.
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
@@ -58,16 +58,25 @@ For more information, see the Settings section of the documentation. Only platfo
Graphics
************
For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. XBIOS works better than GEM, since GEM rendering seems to be slower. Note that this is not a ScummVM setting, but rather a system-wide setting.
For video rendering, define the variable ``SDL_VIDEODRIVER=XBIOS`` in your environmental variables. Either XBIOS or GEM might be set by default. XBIOS works better than GEM, because GEM rendering is slower. Note that this is not a ScummVM setting, but rather a system-wide setting.
Audio
*******
Supported audio file formats:
- MP3
- OGG
- FLAC
- Uncompressed audio
Known issues
==============
- There is no Cloud/LAN functionality.
- There is no cloud/LAN functionality.
- The native MIDI driver (STMIDI) does not work. This is due to an issue with SDL timers not functioning properly from the Atari version of SDL 1.2.
- The built-in MIDI driver (STMIDI) does not work.
- While support for ``.FLAC``, ``.OGG`` and ``.MP3`` audio formats is available in the Atari port of ScummVM, these decoding libraries are extremely CPU intensive and greatly slow down the user experience. ScummVM is best run with uncompressed audio, when available.
- 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.
doc/docportal/other_platforms/risc_os.rst
+5 -5
View File
@@ -16,14 +16,14 @@ Download and install 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, since this results in a loss of file type information. ScummVM requires this file type information to run properly.
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.
Transfer game files
=======================
Copy data files directly from the original discs on machines that have CD and/or floppy drives, or transfer the files from another system by using a USB stick.
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/add_play_games` for more information.
@@ -56,14 +56,14 @@ For more information about settings, see the Settings section of the documentati
.. _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.html>`_ application, which can be useful to developers.
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.html>`_ application. This is useful mostly for developers.
Known issues
==============
- Due to ongoing issues with executable size, releases are built without Cloud or LAN functionality.
- ScummVM for RISC OS does not have cloud or LAN functionality.
- FluidSynth is not supported.
- The releases are only compatible with RISC OS 5, and not RISC OS 3, 4, or 6.
- ScummVM is not compatible with RISC OS 3, 4 or 6.
doc/docportal/release_notes/release_notes_2.2.0.rst
+6 -4
View File
@@ -5,7 +5,9 @@ Version 2.2.0 - "Interactive Fantasy"
New games
=============
- Currently, more than 1600 games are detected and supported.
Currently, more than 1600 games are detected and supported.
- Added support for Blazing Dragons.
- Added support for Griffon Legend.
- Added support for Interactive Fiction games based on the following engines:
@@ -123,8 +125,8 @@ SCUMM
- Fixed the rendering of the flashlight in MM NES to match the original version.
- Replaced the existing NES palette to a more accurate NTSC palette based on Mesen.
- Added a new GUI option to switch to an alternative NES palette based on the NES Classic.
- Improved colors in Apple //gs Maniac Mansion.
- Fixed crash when entering garage in Apple //gs Maniac Mansion.
- Improved colors in Apple IIGS Maniac Mansion.
- Fixed crash when entering garage in Apple IIGS Maniac Mansion.
- Added support from Classic Full Throttle from Remastered release.
Supernova
@@ -135,7 +137,7 @@ Supernova
Sky
********
- Fixed syncing of music volume between native settings panel and ScummVM configuration.
- Fixed syncing of music volume between built-in settings panel and ScummVM configuration.
Sword1
********
doc/docportal/settings/audio.rst
+1 -1
View File
@@ -52,7 +52,7 @@ AdLib Emulator
.. _speechmute:
Text and Speech
For games with digitized speech, this setting allows the user to decide whether to play the game with speech only, subtitles only, or both.
For games with digitized speech, this setting lets the user decide whether to play the game with speech only, subtitles only, or both.
*speech_mute*
doc/docportal/settings/cloud.rst
+1 -1
View File
@@ -18,7 +18,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the Cl
Active storage
Choose from Dropbox, OneDrive, Google Drive, or Box.
Once a Cloud service has been selected, further options are available:
After a Cloud service has been selected, further options are available:
Sync Now
Manually syncs saved games with the cloud service. Saved games automatically sync on launch, after saving, and on game load.
doc/docportal/settings/control.rst
+1 -1
View File
@@ -31,4 +31,4 @@ Show on-screen control
Toggles the small on-screen keyboard icon on and off.
Touchpad mouse mode
Toggles between :ref:`direct` and :ref:`touchpad`.
Toggles between direct mode and touchpad mode.
doc/docportal/settings/engine.rst
+6 -6
View File
@@ -4,7 +4,7 @@ Engine
Use the Engine tab to change settings that are unique to the game being played.
From the Launcher, highlight a game on the games list, select **Edit Game**, and then select the **Engine** tab. This tab may not be available for all games.
From the Launcher, highlight a game on the games list, select **Edit Game**, and then select the **Engine** tab. This tab might not be available for all games.
To find out which engine powers your game, have a look at the ScummVM Supported Games `wiki page
<https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_.
@@ -75,7 +75,7 @@ Use an alternative palette
.. _support:
Mouse support
Enables mouse support. Allows use of the mouse for movement and in game menus.
Enables mouse support for movement and in game menus.
*mousesupport*
@@ -124,7 +124,7 @@ Shorty mode
.. _nodelay:
Frame limiter high performance mode
Avoids use of ``delayMillis()`` function. This mode may result in high CPU usage.
Avoids use of ``delayMillis()`` function. This mode might result in high CPU usage.
*nodelaymillisfl*
@@ -251,7 +251,7 @@ Enable studio audience
.. _skipsupport:
Skip support
Allows the user to skip text and cutscenes.
Lets the user skip text and cutscenes.
*skip_support*
@@ -367,7 +367,7 @@ Use original save/load screens
.. _skiphall:
Skip the Hall of Records storyboard scenes
Allows the player to skip past the Hall of Records storyboard scenes.
Lets the player skip past the Hall of Records storyboard scenes.
*skiphallofrecordsscenes*
@@ -630,7 +630,7 @@ XEEN
.. _cost:
Show item costs in standard inventory mode
Shows item costs in standard inventory mode, which allows the value of items to be compared.
Shows item costs in standard inventory mode, which lets the value of items be compared.
*ShowItemCosts*
doc/docportal/settings/game.rst
+1 -1
View File
@@ -31,7 +31,7 @@ From the Launcher, highlight a game on the games list, then select **Edit Game**
.. _lang:
**Language**
For multi-language games, this changes the language of the game. For games that have a single language hardcoded, this changes the font of the subtitles. For instance, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde to Spanish subtitles.
For multi-language games, this changes the language of the game. For games that have a single language hardcoded, this changes the font of the subtitles. For example, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde to Spanish subtitles.
*language*
doc/docportal/settings/lan.rst
+2 -2
View File
@@ -4,7 +4,7 @@ LAN
Use the LAN tab to control the web server.
ScummVM can run a local network web server which allows browser-based file management, including uploading and downloading game files.
ScummVM can run a local network web server for browser-based file management, including uploading and downloading game files.
From the Launcher, select **Options**, click the **>** scroll arrow until the LAN tab is visible, and then select the **LAN** tab.
@@ -17,7 +17,7 @@ From the Launcher, select **Options**, click the **>** scroll arrow until the LA
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
Run server
Starts the web server. Once running, this displays the URL at which the web server can be accessed.
Starts the web server. When running, this displays the URL at which the web server can be accessed.
Stop server
Stops the web server.
doc/docportal/use_scummvm/add_play_games.rst
+8 -8
View File
@@ -50,9 +50,9 @@ For games on floppies or CDs:
For games downloaded from digital distributors or from various `freeware sources <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games#Freeware_Games>`__:
- Run the installer to extract the game files, or
- If the data files are supplied as a ``.zip`` archive, extract the archive.
- If the data files are supplied as a zip file, extract the files.
For macOS or Linux users without access to a Windows machine, it is possible to get the game files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
For macOS or Linux users without access to a Windows machine, you can get the game files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer on macOS or Linux. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.
@@ -74,13 +74,13 @@ ScummVM needs access to all the data files, so it will not be able to run direct
CD audio
**********
Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in ``.wav`` or ``.aiff`` format, and then convert them to either ``.mp3``, ``.flac`` or ``.ogg`` file formats.
Some games contain one or more separate audio tracks on CD. To use these with ScummVM, extract the audio tracks from the CD in WAV or AIFF format, and then convert them to either MP3, FLAC or OGG file formats.
.. tip::
Software suggestion:
`fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between ``.mp3``, ``.ogg``, ``.flac`` and ``.wav`` formats.
`fre:ac <https://www.freac.org/>`_ is a multi-platform, open-source software, with the ability to both rip CDs and convert audio between MP3, OGG, FLAC and WAV file formats.
Place the converted audio files in the same folder that contains the other game datafiles.
@@ -94,9 +94,9 @@ All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the
Mac uses a different file system to other systems (HFS+), so to access the CD or floppy disc on a Windows or Linux system you will need additional software to view and copy the files.
For Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which allows read-only access to HFS drives. Use the installer rather than the ZIP file, to ensure it is installed correctly.
For Windows, `HFS Explorer <http://www.catacombae.org/hfsexplorer/>`_ is a basic and free option, which gives you read-only access to HFS drives. Use the installer rather than the zip file, to ensure it is installed correctly.
For Linux, hfsplus allows read-only access to HFS drives. To use hfsplus, use the command line:
For Linux, hfsplus gives you read-only access to HFS drives. To use hfsplus, use the command line:
1. Install hfsplus using the software manager. On Debian-based distributions, use ``sudo apt install hfsplus``.
2. Find the game disc by running ``sudo fdisk -l`` and finding the one with type ``Apple HFS/HFS+``. In this example, this is ``/dev/fd0``.
@@ -124,9 +124,9 @@ Add games to the Launcher
.. note::
The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the native system file browser, or its own file browser.
The **Use Native file browser** option in the :doc:`Misc <../settings/misc>` tab of the global settings controls whether ScummVM uses the system file browser, or its own file browser.
5. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything should work at the default settings. Click **Ok**.
5. The **Edit Game** dialog opens to allow configuration of various settings for the game. These can be reconfigured at any time, but for now everything is OK at the default settings. Click **Ok**.
.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
doc/docportal/use_scummvm/connect_cloud.rst
+2 -2
View File
@@ -8,7 +8,7 @@ To connect your chosen cloud storage service to ScummVM, select it from the **Ac
.. figure:: ../images/cloud_and_lan/cloud_storage.png
Click on the link shown at **1.**, and log in to your cloud storage account. Once you have logged in, a 6-digit code will be displayed.
Click on the link shown at **1.**, and sign in to your cloud storage account. After you sign in, a 6-digit code will be displayed.
.. figure:: ../images/cloud_and_lan/cloud_code.png
@@ -16,7 +16,7 @@ Copy the 6-digit code, click into the empty field next to **Paste**, and then cl
.. figure:: ../images/cloud_and_lan/cloud_connect.png
Click **3. Connect**. Once the next page loads, click **Enable storage**.
Click **3. Connect**. After the next page loads, click **Enable storage**.
.. figure:: ../images/cloud_and_lan/cloud_enable.png
doc/docportal/use_scummvm/save_load_games.rst
+2 -2
View File
@@ -63,7 +63,7 @@ To load a saved state from within a game, press :kbd:`Ctrl+F5` (:kbd:`Ctrl+fn+F5
Location of saved game files
-------------------------------
The save directory can be changed via the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_topics/configuration_file>`.
The save directory can be changed with the savepath setting in the :doc:`Paths tab <../settings/paths>`. It can also be changed in the :doc:`configuration file <../advanced_topics/configuration_file>`.
Default saved game paths are shown below.
@@ -114,7 +114,7 @@ Default saved game paths are shown below.
:column: col-lg-12 mb-2
We follow the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location may vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
We follow the XDG Base Directory Specification, so by default the saved games can be found at ``~/.local/share/scummvm/saves/``, but this location might vary depending on the value of the ``XDG_DATA_HOME`` environment variable.
``.local`` is a hidden directory. To view it use ``ls -a`` on the command line, or, if you are using a GUI file manager, press :kbd:`Ctrl + H`.
doc/docportal/use_scummvm/the_launcher.rst
+2 -2
View File
@@ -18,10 +18,10 @@ The pane on the left is the games list, which lists all the games that have been
Quick search
=============
Quick search allows you to filter the games list.
Quick search lets you filter the games list.
The quick search input is located at the top of the page next to the magnifying glass icon. The filter is applied as you type, and is not case sensitive. To clear the filter, click **X** next to the input field.
There are many ways to filter games. For instance, you can type "Monkey Island" to quickly locate all "Monkey Island" games on the list, or you can type "German" to find German games.
There are many ways to filter games. For example, you can type "Monkey Island" to locate all "Monkey Island" games on the list, or you can type "German" to find German games.
.. figure:: ../images/Launcher/quicksearch.png