Skip to content

Commit

Permalink
DOCS: fixes multiple small things
Browse files Browse the repository at this point in the history
- changes colour of unselected tabs
- clarifies language option
- changes hierarchy of headings on game files page
- renames game files page
- fixes windows path
- corrects save game path info on Path page
-  renames Other Platforms to Platform Guides
-  standardises  Understanding Audio/Graphics pages
  • Loading branch information
cadihowley authored and sev- committed Feb 25, 2021
1 parent c614f62 commit fa0743e
Show file tree
Hide file tree
Showing 14 changed files with 71 additions and 75 deletions.
2 changes: 1 addition & 1 deletion doc/docportal/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ h4 {
}

.tabbed-set>label {
color: #ffbb77 !important;
color: #fd962e !important;
}

.tabbed-content {
Expand Down
6 changes: 3 additions & 3 deletions doc/docportal/advanced_topics/configuration_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The configuration file saves to different default locations, depending on the pl

ScummVM follows 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``
If ScummVM was installed using Snap, the configuration file is found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``

.. note::

Expand Down Expand Up @@ -244,7 +244,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`herculesfont <herc>`",boolean,false,
":ref:`hpbargraphs <hp>`",boolean,true,
":ref:`hypercheat <hyper>`",boolean,false,
iconpath,string,, "Specifies the path to icons to use as overlay for the ScummVM icon in the Windows taskbar or the macOS Dock when running a game. The icon files should be named after the gameid and be an ico file on Windows, or a png file on macOS."
iconpath,string,, "Specifies the path to icons to use as overlay for the ScummVM icon in the Windows taskbar or the macOS Dock when running a game. The icon files should be named after the :ref:`gameid <gameid>`, and be an ICO file on Windows, or a PNG file on macOS."
":ref:`improved <improved>`",boolean,true,
":ref:`InvObjectsAnimated <objanimated>`",boolean,true,
":ref:`joystick_deadzone <deadzone>`",integer, 3
Expand Down Expand Up @@ -415,7 +415,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`transparentdialogboxes <transparentdialog>`",boolean,false,
":ref:`tts_enabled <ttsenabled>`",boolean,false,
":ref:`tts_narrator <ttsnarrator>`",boolean,false,
use_cdaudio,boolean,true,
use_cdaudio,boolean,true, "If true, ScummVM uses audio from the game CD."
versioninfo,string,,Shows the ScummVM version that created the configuration file.
":ref:`window_style <style>`",boolean,true,
":ref:`windows_cursors <wincursors>`",boolean,false,
Expand Down
8 changes: 4 additions & 4 deletions doc/docportal/advanced_topics/understand_audio.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
======================================================
Understand the audio settings
Understanding the audio settings
======================================================

This guide is designed to expand on the information contained on the :doc:`audio settings <../settings/audio>` page.
This guide expands on the information contained on the :doc:`audio settings <../settings/audio>` page.


How do the settings work together?
=====================================
How do the audio settings work together?
==========================================

The **Preferred device** in the global settings Audio tab, or the **Music device** in the game-specific settings Audio tab, specifies the device that ScummVM uses to output audio. This device can be an emulated sound device or a software synthesizer, or an actual hardware device such as a soundcard or a hardware MIDI synthesizer. When set to **<default>**, ScummVM will automatically choose the most appropriate option for the played game.

Expand Down
6 changes: 3 additions & 3 deletions doc/docportal/advanced_topics/understand_graphics.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
=====================================
Understand the graphics settings
Understanding the graphics settings
=====================================

This guide is designed to expand on the information contained on the :doc:`graphics settings <../settings/graphics>` page.
This guide expands on the information contained on the :doc:`graphics settings <../settings/graphics>` page.

How do the graphics settings work together?
----------------------------------------------
Expand Down Expand Up @@ -103,7 +103,7 @@ For a game with an original resolution of 320x200, aspect ratio correction resul

.. figure:: ../images/graphics/aspect_ratio/aspect_ratio.png

Aspect ratio correction applied. Notice the moon is actually round now.
Aspect ratio correction applied. The moon is actually round, as it should be!

To toggle aspect ratio on and off, press :kbd:`Ctrl+Alt+a`.

Expand Down
2 changes: 1 addition & 1 deletion doc/docportal/help/report_bugs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,6 @@ To help you report a bug, you can find error messages in the ScummVM log file. T
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^

``%APPDATA\ScummVM\scummvm.log``
``%APPDATA%\ScummVM\scummvm.log``


Binary file added doc/docportal/images/Launcher/choose_version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions doc/docportal/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use_scummvm/LAN

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

Expand Down Expand Up @@ -128,8 +128,9 @@ We have a user manual section covering **THE BASICS**:

:doc:`use_scummvm/LAN`

.. _platformspecific:

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


.. panels::
Expand Down
2 changes: 1 addition & 1 deletion doc/docportal/settings/game.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
.. _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 example, selecting German will add an umlaut to German subtitles, and selecting Spanish will add the tilde to Spanish subtitles.
For games that were released with support for multiple languages, this options changes the language of the game. For games that have a single language hardcoded, this option does not change the language of the game, it only affects the subtitles. Select the correct language to ensure that subtitles display correctly, especially for non-English games.

*language*

Expand Down
2 changes: 1 addition & 1 deletion doc/docportal/settings/paths.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
.. _savepath:

Save Path
Sets the path to the folder in which ScummVM stores saved games. If this is not set, saved games will generally be stored in the current directory, although there are exceptions to this. For more information, see the :ref:`Save and Load games <savelocation>` page.
Sets the path to the folder in which ScummVM stores saved games. For more information on the default location of saved games, see the :ref:`Save and Load games <savelocation>` page, or the guide for the platform you're using.

*savepath*

Expand Down
27 changes: 19 additions & 8 deletions doc/docportal/use_scummvm/add_play_games.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Adding and playing a game
=================================

The games
------------
Where to get the games
=============================

One of the most frequently asked questions is, "Where do I get the games?!?". If you still have your old floppy discs or CDs lying around, and have a way to read them, then you can use the game files from those original discs.

Expand All @@ -19,7 +19,7 @@ Make sure to check out the `compatibility list <https://www.scummvm.org/compatib
.. _add and play games:

Adding games to the Launcher
---------------------------------
==============================

The following steps explain how to add a game to ScummVM, and assume you have access to the data files for each game. If you're not sure how to access the game data files, see the :doc:`game_files` page.

Expand All @@ -34,7 +34,7 @@ To add multiple games at once, click the expander arrow next to **Add Game**, an

.. image:: ../images/Launcher/mass_add.png

3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Click **Choose** to select the folder.
3. Use the file browser to locate the folder containing the game data files. For the ScummVM file browser: Double click on a folder to open it, and use **Go up** to go back up one level. Highlight the folder by clicking on it, and then click **Choose**

.. image:: ../images/Launcher/choose_game_directory.png
:class: with-shadow
Expand All @@ -43,13 +43,24 @@ To add multiple games at once, click the expander arrow next to **Add Game**, an

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.

3a. If you are using **Mass Add**, select **Yes** to run the mass game detector. A dialog opens to advise which games were added to the games list.
If you are using **Mass Add**, select **Yes** to run the mass game detector. A dialog opens to advise which games were added to the games list.

.. image:: ../images/Launcher/mass_add_confirm.png

.. image:: ../images/Launcher/mass_add_success.png

4. 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 be OK at the default settings. Any settings changed here override the global settings. Click **Ok**.

Sometimes, ScummVM detects multiple versions of a single game. In this case, highlight the correct version and click **Choose** to continue.

.. figure:: ../images/Launcher/choose_version.png

.. caution::

If you are using **Mass Add**, ScummVM adds all versions of a game.

If you are adding an unknown version of a game, ScummVM is not able to add the game to the games list. An error message appears to warn you that the game has not been added.

4. 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 be OK at the default settings. Any settings changed here override the global settings. Click **Ok**.

.. image:: ../images/Launcher/game_settings.png
:class: with-shadow
Expand All @@ -58,15 +69,15 @@ To add multiple games at once, click the expander arrow next to **Add Game**, an

The **Edit Game** dialog does not open when **Mass Add** is used.

5. Games are now ready to play! To play, highlight a game in the games list and click **Start**, or double-click the game in the games list.
6. Games are now ready to play! To play, highlight a game in the games list and click **Start**, or double-click the game in the games list.

.. image:: ../images/Launcher/start_game.png
:class: with-shadow

Games can also be launched directly from the command line. For more information, see the `Command line options <../advanced_topics/command_line>`_ page.

A note about copyright
------------------------
==============================

ScummVM has a strict anti-piracy stance and the team wil not tolerate discussions around pirated games in any part of the project, including on the Forum or on Discord.

Expand Down
37 changes: 14 additions & 23 deletions doc/docportal/use_scummvm/game_files.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@

===========================
Accessing game files
Handling game files
===========================

The game files
------------------

ScummVM needs access to the data files for each game. A comprehensive list of required data files for each game is found on the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page. ScummVM can run the game data files from any directory it has access to, including external media.

.. note::
Expand All @@ -23,41 +20,35 @@ ScummVM needs access to the data files for each game. A comprehensive list of re



For games on floppies or CDs:

- If the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above.
- If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.

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>`__:
For games on floppies or CDs, if the data files are accessible, the external media can be accessed directly by ScummVM. Alternatively, copy the game files to a folder as described above. If the data files are not accessible, run the installer on the platform the game was designed for, to extract the game files.

- Run the installer to extract the data files, or
- If the data files are supplied as a zip file, extract the files.

For macOS or Linux users without access to a Windows machine, you can get the data 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 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 data files, or if the data files are supplied as a zip file, extract the files.

For macOS or Linux users without access to a Windows machine, you can get the data files from games that only have Windows installers. Use `Wine <https://www.winehq.org/>`_ to run the Windows installer. Alternatively, for GOG.com games, use `innoextract <https://constexpr.org/innoextract/>`_ to unpack game files from the installer without actually running it.


.. tip::

Use ScummVM's Cloud functionality to share game files and automatically back up and sync your saved game states. For detailed instructions see the :doc:`../use_scummvm/connect_cloud` guide. For devices on the same local network, ScummVM can run a web server to allow hassle-free transfer of files. For detailed instructions, see the :doc:`../use_scummvm/LAN` guide. This is a good option if you do not wish to connect a Cloud service.
Use ScummVM's Cloud functionality to share game files and automatically back up and sync your saved game states. For detailed instructions see the :doc:`../use_scummvm/connect_cloud` guide. For devices on the same local network, ScummVM can also run a web server to allow hassle-free transfer of files. For detailed instructions, see the :doc:`../use_scummvm/LAN` guide. This is a good option if you do not wish to connect a Cloud service.


Multi-disc games
*****************
===================

ScummVM needs access to all the data files, so it will not be able to run directly from a CD if the game has multiple discs. To add a multi-CD game, copy the required data files from the CD to a folder on your hard drive. For a comprehensive list of required files, see the `ScummVM Wiki Datafiles <https://wiki.scummvm.org/index.php?title=Datafiles>`__ page.

As a general guideline:

- Where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required.
- Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.
As a general guideline, where there are duplicate, identical files (same name, same file size) on more than one disc, only one copy of the file is required. Where there are files that have the same name but are different on each disc, rename them. For example, where there is a ``music.clu`` on two discs, rename the file on the first disc to ``music1.clu`` and the file on the second disc to ``music2.clu``.

.. _cdaudio:

CD audio
**********
============

In most cases, ScummVM can use CD audio directly from the game CD. If you don't always want to insert the game CD to use the CD audio, you can extract the audio tracks from the CD and save them locally:

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. Place the converted audio files in the same folder that contains the other game datafiles.
1. Extract the CD audio tracks in WAV or AIFF format.
2. Convert the tracks to either MP3, FLAC or OGG file formats.
3. Place the converted audio files in the same folder that contains the other game datafiles.

.. tip::

Expand All @@ -67,7 +58,7 @@ Some games contain one or more separate audio tracks on CD. To use these with Sc
.. _macgames:

Macintosh games
******************
==================

All LucasArts SCUMM games also exist in versions for the Macintosh. Most of the newer games shipped with only a single data file; ScummVM can use this file like it does any other data file. Some discs shipped with hidden files. To view hidden files in macOS, press :kbd:`Cmd+Shift+.` in a Finder window.

Expand Down
8 changes: 5 additions & 3 deletions doc/docportal/use_scummvm/install_computer.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@

=====================================
Installing ScummVM on a computer
Installing ScummVM
=====================================

This page explains how to install ScummVM on a computer. For all other platforms, see the relevant :ref:`platform guide <platformspecific>`.

.. tabbed:: Windows

There are two ways to install ScummVM on a computer running Windows; download and use the installer, or install manually.
There are two ways to install ScummVM on Windows: use the installer, or install manually.

.. dropdown:: Installing ScummVM using the installer
:open:
Expand Down Expand Up @@ -36,7 +38,7 @@ Installing ScummVM on a computer
.. tabbed:: Linux


There are multiple ways to install ScummVM on a computer running Linux: use the Snap Store, Flathub or the software repository, or install the release binary.
There are multiple ways to install ScummVM on Linux: use the Snap Store, Flathub or the software repository, or manually install the release binary.

.. dropdown:: Installing ScummVM using the Snap Store
:open:
Expand Down
33 changes: 12 additions & 21 deletions doc/docportal/use_scummvm/save_load_games.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Saving and loading a game
===============================

This guide explains how to save and load a game from the Global Main Menu, or load a game directly from the Launcher.
This page explains how to save and load a game from the Global Main Menu, or load a game directly from the Launcher.

.. note::

Expand Down Expand Up @@ -49,15 +49,6 @@ The save directory can be changed with the savepath setting in the :doc:`Paths t

Default saved game paths are shown below.

.. tabbed:: macOS

.. panels::
:column: col-lg-12 mb-2

macOS/Mac OSX
^^^^^^^^^^
``~/Documents/ScummVM Savegames/``, where ``~`` is your Home directory.

.. tabbed:: Windows

.. panels::
Expand All @@ -66,8 +57,8 @@ Default saved game paths are shown below.
Windows NT4
^^^^^^^^^^^^

``<windir>\Profiles\username\Application Data\ScummVM\Saved games\`` where ``<windir>`` refers to the Windows directory. Most commonly, this is ``C:\WINDOWS``.

``C:\WINDOWS\Profiles\username\Application Data\ScummVM\Saved games\``
---
:column: col-lg-12 mb-2

Expand All @@ -81,7 +72,15 @@ Default saved game paths are shown below.
Window Vista/7/8/10
^^^^^^^^^^^^^^^^^^^^^^
``%APPDATA%\ScummVM\Saved games``



.. tabbed:: macOS

.. panels::
:column: col-lg-12 mb-2

``~/Documents/ScummVM Savegames/``


.. tabbed:: Linux/Unix

Expand All @@ -97,14 +96,6 @@ Default saved game paths are shown below.



.. tabbed:: Other

.. panels::
:column: col-lg-12 mb-2

See the relevant Platform page for details.



Loading a game
===============
Expand Down
8 changes: 4 additions & 4 deletions doc/docportal/use_scummvm/the_launcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Launches the highlighted game.
Load
^^^^^^^

Opens the load game window, from which you can run a previously saved state without having to start the game first.
Opens the load game window, from which you can go to a saved game without having to start the game first.

See the :doc:`save_load_games` page.

Expand Down Expand Up @@ -98,17 +98,17 @@ Closes the GMM and resumes the game.
Load
^^^^^^

Opens the load game window, to load a saved game state.
Opens the load game window. From here, you can load a saved game.

Save
^^^^^^

Opens the save game window, to save a game state.
Opens the save game window. From here, you can save a game.

Options
^^^^^^^^

Opens a dialog which provides gameplay options, such as sound volume, subtitle and keymap settings.
Opens a dialog which provides some gameplay options, such as sound volume, subtitle and keymap settings.


About
Expand Down

0 comments on commit fa0743e

Please sign in to comment.