libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2025-02-07 11:27:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

DOCS: adds numbering + extra FAQ questions

Browse Source
This commit is contained in:
cadihowley 2021-09-07 13:50:16 +12:00 committed by Eugene Sandulenko
parent a0ea8dc7f3
commit 6c3b69f633
1 changed files with 81 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

137
doc/docportal/help/faq.rst
View File

@ -6,99 +6,120 @@ Frequently Asked Questions
.. contents::
General
1. General
==================
About
*******
1.1 About
***********
Is ScummVM an emulator?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.1.1. Is ScummVM an emulator?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
No! ScummVM actually replaces the original executable file that shipped with the game. This means that your games can run on platforms they were never designed for! 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?
^^^^^^^^^^^^^^^^^^^^
1.1.2. Is ScummVM free?
^^^^^^^^^^^^^^^^^^^^^^^^^
ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is available for you to do whatever you want with it, but 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 you've made can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page for contributing guidelines.
How do I install ScummVM onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.1.3. Can I create my own games using ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A few engines supported by ScummVM have publicly available authoring tools. See this `wiki page <https://wiki.scummvm.org/index.php/HOWTO-Fangames>`_ for more information.
1.2 Using ScummVM
**********************
1.1.1. How do I install ScummVM onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See :ref:`firststeps`.
How do I get game files onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.2.2. How do I get game files onto my device?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For general guidance, see the :doc:`../use_scummvm/game_files` page. For platform-specific information, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
ScummVM 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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.2.3. On what platform(s) will ScummVM run?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See our `Platforms <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page for a full list. We have guides available for many of the supported platforms, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
Games
********
1.2.4. Where do I find the configuration file?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See :doc:`../advanced_topics/configuration_file`.
Can I only play LucasArts SCUMM games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.3. Playing games
********************
1.3.1. 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 full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. There is a caveat; not all supported games are playable on all platforms. Often this is because the game is simply too CPU intensive for the device, or because of some other hardware or software limitation. 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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.3.2. Where do I get the games?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
.. _installgames:
How do I install games from my floppy discs/CDs?
1.3.3. How do I install games from my floppy discs/CDs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. For a complete guide, see :doc:`../use_scummvm/game_files`.
Do I need the original game discs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.3.4. Do I need the original game discs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Ideally yes, however we know that a lot of people don't! If you do not have any hard copy games, there are some digital options available, including some games that have been released as freeware. See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
How do I know if I can play my game using ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.3.5. How do I get the Macintosh versions of games to work?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See :doc:`../use_scummvm/mac_game_files`
1.3.6. 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 the ScummVM website. You can also have a look at the full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_.
I have saved games from when I played the original game - can I use these with ScummVM?
1.3.7. I have saved games from when I played the original game - can I use these with ScummVM?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This is only supported for a select number of games. See the `wiki <https://wiki.scummvm.org/index.php/Category:Supported_Games>`_ page for the game you are playing.
How do I launch a game straight from the game folder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1.3.8. Where are my games saved?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See :doc:`../use_scummvm/save_load_games`.
1.3.9. How do I launch a game straight from the game folder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Games must be added to and started from :doc:`the ScummVM Launcher <../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 you can also create custom shortcuts on the :doc:`../settings/keymaps` tab.
1.3.10. What are the in-game keyboard shortcuts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. From version 2.2.0 you can also create custom shortcuts on the :doc:`../settings/keymaps` tab.
Troubleshooting
2. Troubleshooting
===================
ScummVM
***********
2.1. General
**************
ScummVM crashes, but the console window disappears too quickly to see the error message.
2.1.1. ScummVM crashes, but the console window disappears too quickly to see the error message.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_topics/command_line>`. By doing this, error messages remain visible even after ScummVM exits.
You can also find error messages in the ScummVM log file. See :ref:`logfile`.
I think I found a bug. What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.1.2. I think I found a bug. What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See :doc:`report_bugs`.
Games
********
2.2 Games
**********
Help! My game won't run!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.2.1. Help! My game won't run!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
@ -108,20 +129,24 @@ Help! My game won't run!
4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
I installed my game but ScummVM can't find it... What do I do?
2.2.2. I installed my game but ScummVM can't find it... What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installing the game does not necessarily provide ScummVM with the files it needs. In most cases you will need to copy the files from the disc into a folder ScummVM can access. See :doc:`../use_scummvm/game_files`.
Why are the subtitles in my non-English game messed up?
2.2.3. Why are the subtitles in my non-English game messed up?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You need to specify the correct :ref:`language <lang>` in the game-specific settings.
Audio
*******
2.2.4. My game crashes at a specific point. What do I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
First, check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website to see if the game has any known issues. If not, and the crash can be reproduced, report the crash as a bug. See :doc:`report_bugs`.
2.3 Audio
***********
.. _nosound:
Help! There's no sound!
2.3.1 Help! There's no sound!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sometimes it's worth checking the obvious.
@ -129,15 +154,15 @@ Sometimes it's worth checking the obvious.
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 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!
2.3.2 Help! There's no sound on my iPhone/iPad!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ScummVM will not play any sound if your device is in Silent Mode. If this is not the problem, see :ref:`nosound`.
I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
2.3.3 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 voice file (``MONSTER.SOU``). If you have compressed this file to an mp3 file (``MONSTER.SO3``), an Ogg Vorbis file (``MONSTER.SOG``), or a FLAC file (``MONSTER.SOF``), make sure that the ScummVM you're using has support for those formats.
The audio is really glitchy. What can I do?
2.3.4 The audio is really glitchy. What can I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There are a few things you can try:
@ -146,22 +171,22 @@ There are a few things you can try:
- 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 <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?
2.3.5. I have a CD version of a game, how do I get the sound to work without running the game from the CD?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
See :ref:`cdaudio`.
Graphics
***********
2.4 Graphics
**************
There are so many options... How do I know what to pick?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.4.1. There are so many options... How do I know what to pick?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Start by checking out our :doc:`../advanced_topics/understand_graphics` page. It has comprehensive information on how all this stuff works.
Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
2.4.2. Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Yes. Using the **OpenGL** graphics mode or the **SDL Surface** graphics mode with **Normal** scaler in conjunction with pixel-perfect stretch will result in a larger image without any smoothing. The **Normal** scaler also has options to scale by **2x**, **3x**, or **4x**. Also check that **Filter graphics** is not enabled. If you want to use aspect ratio correction, it is recommended to use the **OpenGL** graphics mode with the **Even pixels scaling** stretch mode.
The game colors are messed up, how do I fix them?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.4.3. The game colors are messed up, how do I fix them?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Ensure the correct game platform has been detected. For example, with Amiga game files, check that the :ref:`platform <platform>` is set to Amiga.