[Scummvm-git-logs] scummvm master -> f0089a7b67321fb066b635a891e5cfe323ea243f

[sev-]

This automated email contains information about 2 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
2d27f11ce0 DOCS: adds autostart page
f0089a7b67 DOCS: Fix command line parameter for autodetection


Commit: 2d27f11ce0a1a735c2ed8e7700dfaad3e93c7613
    https://github.com/scummvm/scummvm/commit/2d27f11ce0a1a735c2ed8e7700dfaad3e93c7613
Author: CadiH (cadihowley at gmail.com)
Date: 2023-03-03T21:29:21+01:00

Commit Message:
DOCS: adds autostart page

Changed paths:
  A doc/docportal/advanced_topics/autostart.rst
    doc/docportal/index.rst


diff --git a/doc/docportal/advanced_topics/autostart.rst b/doc/docportal/advanced_topics/autostart.rst
new file mode 100644
index 00000000000..b1d8435046a
--- /dev/null
+++ b/doc/docportal/advanced_topics/autostart.rst
@@ -0,0 +1,22 @@
+=========================
+Autostart
+=========================
+
+Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-run`` :doc:`command line options <../advanced_topics/command_line>`. 
+
+There are two ways to use the autostart feature:
+
+- Rename the executable file to ``scummvm-auto.xxx``, where ``xxx`` is the file type extension. 
+- Create an empty file named ``scummvm-autorun`` in the same folder as both the executable and the chosen game. Either leave the file empty, or use it to specify any further command line options. Specify one option per line. 
+
+Example of a scummvm-autorun file
+===================================
+
+.. code::
+
+    --fullscreen
+    --shader=crt/crt-lottes.glslp
+
+    
+
+
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index b33750921d2..b5687485a8a 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -52,11 +52,13 @@
       :glob:
       :hidden:
 
+      advanced_topics/autostart
       advanced_topics/command_line
       advanced_topics/configuration_file
       advanced_topics/understand_audio
       advanced_topics/understand_graphics
       advanced_topics/understand_search_box
+      
 
 .. toctree::
       :caption: Help
@@ -200,6 +202,9 @@ In this section, we also take a deep dive into understanding the graphics and au
 
       Advanced features
       ^^^^^^^^^^^^^^^^^^^^
+      
+      :doc:`advanced_topics/autostart`
+      
       :doc:`advanced_topics/configuration_file`
 
       :doc:`advanced_topics/command_line`
@@ -213,6 +218,8 @@ In this section, we also take a deep dive into understanding the graphics and au
 
       :doc:`The graphics settings <advanced_topics/understand_graphics>`
 
+      :doc:`The search box <advanced_topics/understand_search_box>`
+
 
 
 Getting help


Commit: f0089a7b67321fb066b635a891e5cfe323ea243f
    https://github.com/scummvm/scummvm/commit/f0089a7b67321fb066b635a891e5cfe323ea243f
Author: Eugene Sandulenko (sev at scummvm.org)
Date: 2023-03-03T21:29:21+01:00

Commit Message:
DOCS: Fix command line parameter for autodetection

Co-authored-by: Thierry Crozat <criezy at scummvm.org>

Changed paths:
    doc/docportal/advanced_topics/autostart.rst


diff --git a/doc/docportal/advanced_topics/autostart.rst b/doc/docportal/advanced_topics/autostart.rst
index b1d8435046a..7301bd797aa 100644
--- a/doc/docportal/advanced_topics/autostart.rst
+++ b/doc/docportal/advanced_topics/autostart.rst
@@ -2,7 +2,7 @@
 Autostart
 =========================
 
-Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-run`` :doc:`command line options <../advanced_topics/command_line>`. 
+Use the autostart feature to automatically start the game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-detect`` :doc:`command line options <../advanced_topics/command_line>`. 
 
 There are two ways to use the autostart feature: