DOCS: minor corrections/additions

This commit is contained in:
cadihowley 2021-04-25 08:19:45 +12:00 committed by Cadi
parent 562deba7de
commit e59bef2b65
5 changed files with 7 additions and 6 deletions

View File

@ -209,7 +209,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`frames_per_secondfl <fpsfl>`",boolean,false,
:ref:`frontpanel_touchpad_mode <frontpanel>`,boolean, false
":ref:`fullscreen <fullscreen>`",boolean,false,
gameid,string,,Short name of the game
gameid,string,,Short name of the game. For internal use only, do not edit.
gamepath,string,,Specifies the path to the game
":ref:`gfx_mode <gfxmode>`",string,normal (1x),"
- 1x

View File

@ -193,7 +193,7 @@ To toggle between bilinear interpolation and nearest neighbor, press :kbd:`Ctrl+
Vsync
*******
V-sync, or vertical sync, synchronizes the frame rate of the game with the monitor's refresh rate. This helps to prevent screen "tearing", where the screen displays parts of multiple frames at once, which looks like a horizontal line where the image appears to split.
V-sync, or vertical sync, synchronizes the frame rate of the game with the monitor's refresh rate, or the video capture refresh rate. This helps to prevent screen "tearing", where the screen displays parts of multiple frames at once, which looks like a horizontal line where the image appears to split.
This setting is enabled by default.

View File

@ -19,7 +19,7 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
.. _id:
**ID**
Shows the short name of the game. This ID can be used for launching the game from the command line.
Shows the short name of the game. Edit this name as required, but use only numbers, letters and hyphens. The ID can also be used for launching the game from the command line.
.. _description:

View File

@ -75,7 +75,7 @@ V-Sync in 3D games
.. _renderer:
Game 3D renderer
Changes how a 3D game is rendered.
Changes how a 3D game is rendered. This setting has no effect on 2D games.
- OpenGL: renders on hardware (uses the GPU)
- OpenGL with shaders: renders on hardware with shader support

View File

@ -20,11 +20,11 @@ Place the icons in a folder, and either change the *iconspath* in the :doc:`conf
The icon files must be ICO files for Windows, or PNG files for macOS. They must follow one of these naming conventions, where xxx is the file extension:
- :ref:`ID <id>`.xxx
- gameid.xxx
- :ref:`ID <id>`.xxx
- engineid-gameid.xxx
To find the gameid and the engineid, open the :doc:`configuration file <../advanced_topics/configuration_file>`. The gameid is the name of the game in square brackets. The game entry will be similar to this:
To find the gameid and the engineid, open the :doc:`configuration file <../advanced_topics/configuration_file>`. The game entry will be similar to this:
.. code::
@ -32,6 +32,7 @@ To find the gameid and the engineid, open the :doc:`configuration file <../advan
description=Lure of the Temptress (VGA/DOS/English)
iconspath=/Users/user/games/icons
path=/Users/user/games/lure
gameid=lure
engineid=lure
.. figure:: ../images/taskbar/game_icon.png