99 lines
3.5 KiB
ReStructuredText
99 lines
3.5 KiB
ReStructuredText
.. toctree::
|
|
:glob:
|
|
:caption: Getting Started
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
getting_started/mac
|
|
getting_started/linux
|
|
getting_started/windows
|
|
getting_started/ios
|
|
getting_started/android
|
|
|
|
|
|
|
|
.. toctree::
|
|
:caption: Installing ScummVM
|
|
:glob:
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
installing_scummvm/*
|
|
|
|
.. toctree::
|
|
:caption: Using ScummVM
|
|
:glob:
|
|
:hidden:
|
|
|
|
using_scummvm/game_settings
|
|
using_scummvm/*
|
|
|
|
.. toctree::
|
|
:caption: Advanced Options
|
|
:glob:
|
|
:hidden:
|
|
|
|
advanced_options/*
|
|
|
|
====================
|
|
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.
|
|
|
|
First steps
|
|
================
|
|
We have guides available to show you how to get your games up and running with ScummVM on many different platforms:
|
|
|
|
- **Computers**: :doc:`getting_started/windows` | :doc:`getting_started/mac` | :doc:`getting_started/linux`
|
|
- **Phones and Tablets**: :doc:`getting_started/ios` | :doc:`getting_started/android`
|
|
- **Other Platforms:**
|
|
|
|
|
|
How do I...?
|
|
=============
|
|
|
|
If you have ScummVM installed, but you have questions about how to use it, our **Using ScummVM** section has lots of useful information to help you out:
|
|
|
|
- **Understanding the interface**: :doc:`using_scummvm/the_launcher`
|
|
- **Playing games**: :doc:`using_scummvm/adding_games` | :doc:`using_scummvm/save_load_games`
|
|
- **Changing settings**: :doc:`using_scummvm/global_settings` | :doc:`using_scummvm/game_settings` | :doc:`advanced_options/configuration_file`
|
|
- **In-game shortcuts**: :doc:`using_scummvm/keyboard_shortcuts`
|
|
|
|
|
|
Advanced features
|
|
============================
|
|
|
|
For our more experienced users, ScummVM has many cool advanced options.
|
|
But don't worry, even if you're a beginner, our documentation will take you through how to optimize your game playing experience.
|
|
|
|
- **Advanced settings**: :doc:`advanced_options/graphics` | :doc:`advanced_options/audio`
|
|
- **The command line interface**: :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 and we offer no warranty.
|
|
|
|
If you are having problems with any aspect of ScummVM, take a look at our help section.
|
|
|
|
- **Games**: `Compatibility <https://www.scummvm.org/compatibility/>`__
|
|
- **Frequently Asked Questions**: `FAQ <#>`__
|
|
- **Bugs**: `Known problems <#>`__ | `Reporting a Bug <#>`__
|
|
- **How to contact us**: `Contact page <#>`__
|
|
|
|
|
|
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 the skills, you can help us by contributing a patch!
|
|
|
|
- **Contributing Guidelines**: `Code <#>`__ | `Documentation <#>`__
|