
.. toctree::
      :glob:
      :caption: The basics
      :hidden:

      use_scummvm/install_computer
      use_scummvm/the_launcher
      use_scummvm/game_files
      use_scummvm/mac_game_files
      use_scummvm/add_play_games
      use_scummvm/save_load_games
      use_scummvm/keyboard_shortcuts
      use_scummvm/how_to_settings
      use_scummvm/connect_cloud
      use_scummvm/LAN
      use_scummvm/taskbar_integration

.. toctree::
      :caption: Platform guides
      :glob:
      :hidden:

      other_platforms/*


.. toctree::
      :caption: The settings
      :glob:
      :hidden:

      settings/game
      settings/backend
      settings/graphics
      settings/control
      settings/keymaps
      settings/audio
      settings/paths
      settings/misc
      settings/cloud
      settings/lan
      settings/accessibility


.. toctree::
      :caption: Advanced topics
      :glob:
      :hidden:

      advanced_topics/command_line
      advanced_topics/configuration_file
      advanced_topics/understand_audio
      advanced_topics/understand_graphics
      advanced_topics/understand_search_box

.. toctree::
      :caption: Help
      :glob:
      :hidden:

      help/report_bugs
      help/contact
      help/faq
      help/credits
      help/release



====================
Welcome to ScummVM!
====================


ScummVM allows you to play classic graphic point-and-click adventure games, text adventure games, and RPGs, as long as you already have the game data files. ScummVM replaces the executable files shipped with the games, which means you can now play your favorite games on all your favorite devices.

So how did ScummVM get its name? Many of the famous LucasArts adventure games, such as Maniac Mansion and the Monkey Island series, were created using a utility called SCUMM (Script Creation Utility for Maniac Mansion). The 'VM' in ScummVM stands for Virtual Machine.

While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games: see the full list `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. Noteworthy titles include Broken Sword, Myst and Blade Runner, although there are countless other hidden gems to explore.



.. _firststeps:

Start here!
================

We have a user manual section covering **THE BASICS**:

.. panels::
      :container: text-center mb-4

      Installation
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      :doc:`Installing ScummVM on a computer <use_scummvm/install_computer>`

      :doc:`use_scummvm/the_launcher`

      ---

      Playing games
      ^^^^^^^^^^^^^^^
      :doc:`use_scummvm/game_files`

      :doc:`use_scummvm/mac_game_files`

      :doc:`use_scummvm/add_play_games`

      :doc:`use_scummvm/save_load_games`

      ---


      Controls and settings
      ^^^^^^^^^^^^^^^^^^^^^^^
      :doc:`use_scummvm/keyboard_shortcuts`

      :doc:`use_scummvm/how_to_settings`

      ---

      Useful features
      ^^^^^^^^^^^^^^^^

      :doc:`use_scummvm/connect_cloud`

      :doc:`use_scummvm/LAN`

.. _platformspecific:

We also have guides on how to get ScummVM running on a wide range of other platforms:


.. panels::
      :container: text-center mb-4

      Handheld consoles
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      :doc:`other_platforms/nintendo_3ds`

      :doc:`other_platforms/nintendo_ds`

      :doc:`other_platforms/nintendo_switch`

      :doc:`other_platforms/playstation_portable`

      :doc:`other_platforms/playstation_vita`

      ---

      Other consoles
      ^^^^^^^^^^^^^^^^

      :doc:`other_platforms/playstation_3`

      :doc:`other_platforms/sega_dreamcast`

      ---

      Phones and tablets
      ^^^^^^^^^^^^^^^
      :doc:`other_platforms/ios`

      :doc:`other_platforms/android`

      ---

      Other operating systems
      ^^^^^^^^^^^^^^^^^^^^^^^
      :doc:`other_platforms/amigaos_4`

      :doc:`other_platforms/atari`

      :doc:`other_platforms/morphos`

      :doc:`other_platforms/risc_os`







Advanced topics
============================

For our more experienced users, ScummVM features a command line interface, as well as the ability to edit settings directly in a configuration file.

In this section, we also take a deep dive into understanding the graphics and audio settings.


.. panels::
      :container: text-center mb-4

      Advanced features
      ^^^^^^^^^^^^^^^^^^^^
      :doc:`advanced_topics/configuration_file`

      :doc:`advanced_topics/command_line`

      ---

      Understanding the settings
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

      :doc:`The audio settings <advanced_topics/understand_audio>`

      :doc:`The graphics settings <advanced_topics/understand_graphics>`



Getting help
=============

ScummVM is still under development. While we do our best to make sure that as many games as possible can be completed with no major bugs, crashes can happen!

If you are having problems with any aspect of ScummVM, take a look at our help section.

.. panels::
      :container: text-center mb-4
      :column: col-lg-12

      :doc:`help/faq`

      :doc:`How to report a bug <help/report_bugs>`

      :doc:`help/contact`

What's changed since I was last here?
======================================

Check out the :doc:`Release notes <help/release>` for both current and past releases.


The ScummVM Project
===================

ScummVM is an open-source project created, maintained and constantly improved by a team of :doc:`passionate volunteers <help/credits>` from all around the world.  If you enjoy using ScummVM and would like to support the team, you can use the PayPal Donate button below.

.. raw:: html

      <form id="donate-header" action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
            <input type="hidden" name="cmd" value="_s-xclick">
            <input type="hidden" name="hosted_button_id" value="U6E6SLL7E8MAS">
            <input type="image" src="ppdonate.png" style="width: 126px; height: 50px; border: 0 none;"  name="submit" alt="Support This Project">
      </form>
      <br>

Another way to support us is to buy your games from GOG.com using the ScummVM Affiliate link.

.. raw:: html

      <a href="https://www.gog.com/?pp=22d200f8670dbdb3e253a90eee5098477c95c23d">
            <img src="GOG_button_small.png" width="126" height="46" alt="GOG.com games">
      </a>



If you have software development or technical writing skills, we would love for you to join the ScummVM team! Check out `Developer Central <https://wiki.scummvm.org/index.php?title=Developer_Central>`_ on the ScummVM wiki for more information on contributing to ScummVM.



