mirror of
https://github.com/libretro/scummvm.git
synced 2025-01-09 03:10:22 +00:00
259 lines
6.6 KiB
ReStructuredText
259 lines
6.6 KiB
ReStructuredText
.. toctree::
|
|
:glob:
|
|
:caption: Quickstart Guide
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
getting_started/mac_linux_windows
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:caption: Other Platforms
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
other_platforms/*
|
|
|
|
.. toctree::
|
|
:caption: Using ScummVM
|
|
:glob:
|
|
:hidden:
|
|
|
|
using_scummvm/the_launcher
|
|
using_scummvm/add_play_games
|
|
using_scummvm/save_load_games
|
|
using_scummvm/keyboard_shortcuts
|
|
using_scummvm/how_to_settings
|
|
|
|
.. toctree::
|
|
:caption: Settings
|
|
:glob:
|
|
:hidden:
|
|
|
|
settings/game
|
|
settings/engine
|
|
settings/graphics
|
|
settings/control
|
|
settings/keymaps
|
|
settings/audio
|
|
settings/paths
|
|
settings/misc
|
|
settings/cloud
|
|
settings/lan
|
|
settings/accessibility
|
|
|
|
.. toctree::
|
|
:caption: Guides
|
|
:glob:
|
|
:hidden:
|
|
|
|
guides/*
|
|
|
|
.. toctree::
|
|
:caption: Games
|
|
:glob:
|
|
:hidden:
|
|
|
|
games/copy_protection
|
|
|
|
|
|
.. toctree::
|
|
:caption: Advanced Options
|
|
:glob:
|
|
:hidden:
|
|
|
|
advanced_options/command_line
|
|
advanced_options/configuration_file
|
|
|
|
|
|
.. toctree::
|
|
:caption: Help
|
|
:glob:
|
|
:hidden:
|
|
|
|
help/report_bugs
|
|
help/contact
|
|
help/faq
|
|
|
|
.. toctree::
|
|
:caption: Release Notes
|
|
:glob:
|
|
:hidden:
|
|
|
|
release_notes/*
|
|
|
|
.. toctree::
|
|
:caption: Contribute to Documentation
|
|
:glob:
|
|
:hidden:
|
|
|
|
contribute/*
|
|
|
|
====================
|
|
Welcome to ScummVM!
|
|
====================
|
|
|
|
ScummVM is a program that allows you to run classic graphical point-and-click adventure games, provided you already have the game data files. ScummVM replaces the executable files shipped with the games, which means they can be played on systems they were never designed for!
|
|
|
|
SCUMM (Script Creation Utility for Maniac Mansion) is a utility that was used to create many of the famous LucasArts adventure games, such as Maniac Mansion and Monkey Island. It is the namesake of ScummVM, with VM meaning Virtual Machine.
|
|
|
|
While ScummVM was originally designed to run LucasArts' SCUMM games, over time support has been added for many other games.
|
|
|
|
.. _firststeps:
|
|
|
|
First steps
|
|
================
|
|
|
|
We have guides available to show you how to get ScummVM up and running:
|
|
|
|
.. panels::
|
|
:container: container-fluid text-center mb-4
|
|
|
|
|
|
Getting started
|
|
^^^^^^^^^^^^
|
|
|
|
:doc:`getting_started/mac_linux_windows`
|
|
---
|
|
|
|
Phones and Tablets
|
|
^^^^^^^^^^^^^^^^^^^
|
|
:doc:`other_platforms/ios`
|
|
|
|
:doc:`other_platforms/android`
|
|
|
|
---
|
|
|
|
Consoles
|
|
^^^^^^^^^^^^^^^^^^^
|
|
:doc:`other_platforms/ps_vita`
|
|
|
|
:doc:`other_platforms/psp`
|
|
|
|
:doc:`other_platforms/nintendo_switch`
|
|
|
|
:doc:`other_platforms/nintendo_3ds`
|
|
|
|
:doc:`other_platforms/dreamcast`
|
|
|
|
---
|
|
|
|
Other systems
|
|
^^^^^^^^^^^^^^^
|
|
:doc:`other_platforms/amigaos4`
|
|
|
|
|
|
|
|
|
|
How do I use ScummVM?
|
|
=========================
|
|
|
|
So you have ScummVM installed, but now you need to know how to add and play some games! We have lots of useful information to help you out:
|
|
|
|
.. panels::
|
|
:container: text-center mb-4
|
|
|
|
Understand the interface
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
:doc:`using_scummvm/the_launcher`
|
|
|
|
---
|
|
|
|
Play games
|
|
^^^^^^^^^^^^^^
|
|
:doc:`using_scummvm/add_play_games`
|
|
|
|
:doc:`using_scummvm/save_load_games`
|
|
|
|
:doc:`using_scummvm/keyboard_shortcuts`
|
|
|
|
---
|
|
:column: col-lg-12
|
|
|
|
Change settings
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
:doc:`using_scummvm/how_to_settings`
|
|
|
|
|
|
The games!
|
|
============
|
|
|
|
One of the most commonly asked questions we get is, "Where do I get the games??". If you still have your old floppy discs and CDs lying around (and have a way to read them!), then you can use the game files from these original discs. For a list of which files you need for each game, check out the `Datafiles page <https://wiki.scummvm.org/index.php?title=Datafiles>`__ on our wiki.
|
|
|
|
If you haven't had a floppy disc or even a CD in your possession for a while, we have a `wiki page <https://wiki.scummvm.org/index.php?title=Where_to_get_the_games>`_ dedicated to helping you find some games to play. As a quick summary, there are a few freeware games available for download on our website's `Downloads page <scummvm.org/downloads>`_, or there are digital distributors such as `GOG.com <gog.com>`_ and `Steam <https://store.steampowered.com/>`_.
|
|
|
|
Make sure you check out the `compatibility list <https://www.scummvm.org/compatibility/>`_ on our website and the `Supported Games page <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ on our wiki before you buy a game, to ensure it can run with ScummVM.
|
|
|
|
|
|
Definitive guides
|
|
=====================
|
|
|
|
In our Guides section, we do some deep dives into ScummVM features.
|
|
|
|
.. panels::
|
|
:container: text-center mb-4
|
|
|
|
Settings
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
:doc:`guides/understand_audio`
|
|
|
|
:doc:`guides/understand_graphics`
|
|
|
|
---
|
|
|
|
How to:
|
|
^^^^^^^^^^^^^^
|
|
:doc:`guides/local_webserver`
|
|
|
|
:doc:`guides/connect_cloud`
|
|
|
|
|
|
Advanced options
|
|
============================
|
|
|
|
For our more experienced users, ScummVM has a command line interface, as well as the ability to edit settings directly in a configuration file.
|
|
|
|
|
|
.. panels::
|
|
:container: text-center mb-4
|
|
:column: col-lg-12
|
|
|
|
:doc:`advanced_options/configuration_file`
|
|
|
|
:doc:`advanced_options/command_line`
|
|
|
|
|
|
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?
|
|
======================================
|
|
|
|
For a quick recap on what's been happening with the latest release, check out our Release Notes section.
|
|
|
|
|
|
The ScummVM Project
|
|
===================
|
|
ScummVM is an open-source project.
|
|
|
|
If you enjoy ScummVM, feel free to donate using the PayPal button on the `ScummVM homepage <https://www.scummvm.org>`__. This will help us buy the utilities to develop ScummVM faster and more efficiently.
|
|
|
|
If you cannot donate but you have coding or writing skills, you can help us by contributing!
|
|
|
|
To help us with our documentation, see the :doc:`contribute/tech_writers`.
|
|
|
|
To help us with our code, check out `Developer Central <https://wiki.scummvm.org/index.php?title=Developer_Central>`_ on the ScummVM wiki. |